Merge pull request #148 from pycompression/nosubclass

Invoke PipedCompressionProgram directly rather than through subclassing
pycompression · Feb 16, 2024 · d98ee23 · d98ee23
2 parents 50262b6 + 1be7ad6
commit d98ee23
Show file tree

Hide file tree

Showing 3 changed files with 207 additions and 373 deletions.
diff --git a/README.rst b/README.rst
@@ -186,8 +186,16 @@ Changelog
 
 in-development
 ~~~~~~~~~~~~~~~~~~~
-* #146: PipedCompressionReader/Writer are now binary-only. For text reading
-  they are wrapped in an ``io.TextIOWrapper`` in the ``xopen()`` function.
+* #146, #147, #148: Various refactors for better code size and readability:
+
+    * PipedCompressionReader/Writer are now combined _PipedCompressionProgram
+      class.
+    * _PipedCompressionProgram is binary-only. For text reading and writing
+      it is wrapped in an ``io.TextIOWrapper`` in the ``xopen()`` function.
+    * Classes that derive from PipedCompressionReader/Writer have been removed.
+* #148: xopen's classes, variables and functions pertaining to piped reading
+  and writing are all made private by prefixing them with an underscore.
+  These are not part of the API and may change between releases.
 
 v1.9.0 (2024-01-31)
 ~~~~~~~~~~~~~~~~~~~