added readable() and writable() NPopen methods

Author: tikuma-lsuhsc

.github/workflows/test_n_pub.yml

@@ -15,13 +15,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.8, 3.9, "3.10", "3.11", "3.12"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
         os: [ubuntu-latest, macos-latest, windows-latest]
         exclude:
-          - os: macos-latest
-            python-version: 3.8
-          - os: windows-latest
-            python-version: 3.8
           - os: macos-latest
             python-version: 3.9
           - os: windows-latest
@@ -34,6 +30,10 @@ jobs:
             python-version: 3.11
           - os: windows-latest
             python-version: 3.11
+          - os: macos-latest
+            python-version: 3.12
+          - os: windows-latest
+            python-version: 3.12
 
     steps:
       - run: echo ${{github.ref}}

CHANGELOG.md

@@ -6,9 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-02-04
+
+### Added
+
+- Added `NPopen.readable()` and `NPopen.writable()` methods
+
 ## [0.1.1] - 2024-03-27
 
 ### Changed
+
 - Dropped support for py3.7
 - Removed unnecessary dependency `"typing_extensions;python_version<'3.8'"`
 

pyproject.toml

@@ -14,14 +14,14 @@ license = { text = "GPL-2.0 License" }
 classifiers = [
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 dynamic = ["version"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = ["pywin32;platform_system=='Windows'"]
 
 [project.urls]

readme.md

@@ -28,6 +28,9 @@ with NPopen('r+') as pipe: # bidirectional (duplex) binary pipe
     # - for an inbound pipe, specify the read access mode 'rb' or 'rt' 
     # - for an outbound pipe, specify the write access mode 'wb or 'wt'
 
+    pipe.readable() # returns True if yields a readable stream
+    pipe.writable() # returns True if yields a writable stream
+
     # 2. Get the pipe path via pipe.path or str(pipe) to start the client program
     sp.run(['my_client', pipe.path])
 

src/namedpipe/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 
 from os import name as _os_name
 

src/namedpipe/_posix.py

@@ -113,3 +113,12 @@ def __enter__(self):
 
     def __exit__(self, *_):
         self.close()
+
+    def readable(self)->bool:
+        """True if pipe's stream is readable"""        
+        return any(c in self._open_args['mode'] for c in 'r+')
+    
+    def writable(self)->bool:
+        """True if pipe's stream is writable"""        
+        return any(c in self._open_args['mode'] for c in 'wxa+')
+    

src/namedpipe/_win32.py

@@ -164,7 +164,15 @@ def __enter__(self):
     def __exit__(self, *_):
         self.close()
 
-
+    def readable(self)->bool:
+        """True if pipe's stream is readable"""        
+        return self._rd
+        
+    def writable(self)->bool:
+        """True if pipe's stream is writable"""        
+        return self._wr
+        
+    
 class Win32RawIO(io.RawIOBase):
     """Raw I/O stream layer over open Windows pipe handle.
 

tests/test_read.py

@@ -24,6 +24,8 @@ def run_ffmpeg(pipe):
 
 def test_read_all():
     with NPopen("r") as pipe:
+        assert pipe.readable()
+        assert not pipe.writable()
         proc, nbytes = run_ffmpeg(pipe)
         f = pipe.wait()
         while f.read(nbytes):