Documentation cleanup.

Update Python version classifiers to drop mention of specific Python 3.x minor versions.

Author: Preston-Landers

CHANGELOG.md

@@ -1,71 +1,72 @@
 ## Change Log ##
 
 - 0.9.20: Threaded logging queue now uses asyncio and can be used after fork (PR#32).
-    The classifiers have been updated to indicate support for Python 3.8 and 3.9.
-    Better performance with large values for backupCount (number of rotated files to keep).
+    * The classifiers have been updated to indicate generic Python 3 support without needing to
+      specify all sub-versions. (However, Python 3.0 to 3.4 support is not claimed.)
+    * Better performance with large values for backupCount (number of rotated files to keep).
+    * You can set the file owner / group to 'root' (uid 0)
+    * Test script has been made more reliable.
 
-- 0.9.19: Fix Python 2 compatibility (again), thanks @buddly27
-    Fix accidental detection of 'darwin' (Mac OS) as Windows in setup.py
+- 0.9.19: Fix Python 2 compatibility (again), thanks @buddly27 Fix accidental detection of '
+  darwin' (Mac OS) as Windows in setup.py
 
 - 0.9.18: Remove ez_setup from the setup.py
 
 - 0.9.17: Contains the following fixes:
-  * Catch exceptions when unlocking the lock.
-  * Clarify documentation, esp. with use of multiprocessing
-  * In Python 2, don't request/allow portalocker 2.0 which won't work.  (Require portalocker<=1.7.1)
-  
+    * Catch exceptions when unlocking the lock.
+    * Clarify documentation, esp. with use of multiprocessing
+    * In Python 2, don't request/allow portalocker 2.0 which won't work.  (Require portalocker<
+      =1.7.1)
+
   NOTE: the next release will likely be a 1.0 release candidate.
-  
-- 0.9.16: Fix publishing issue with incorrect code included in the wheel 
-  Affects Python 2 mainly - see Issue #21
 
-- 0.9.15: Fix bug from last version on Python 2. (Issue #21) Thanks @condontrevor
-  Also, on Python 2 and 3, apply unicode_error_policy (default: ignore) to convert 
-  a log message to the output stream's encoding. I.e., by default it will filter 
-  out (remove) any characters in a log message which cannot be converted to the 
-  output logfile's encoding.
+- 0.9.16: Fix publishing issue with incorrect code included in the wheel Affects Python 2 mainly -
+  see Issue #21
+
+- 0.9.15: Fix bug from last version on Python 2. (Issue #21) Thanks @condontrevor Also, on Python 2
+  and 3, apply unicode_error_policy (default: ignore) to convert a log message to the output
+  stream's encoding. I.e., by default it will filter out (remove) any characters in a log message
+  which cannot be converted to the output logfile's encoding.
 
-- 0.9.14: Fix writing LF line endings on Windows when encoding is specified.
-  Added newline and terminator kwargs to allow customizing line ending behavior.
-  Thanks to @vashek
+- 0.9.14: Fix writing LF line endings on Windows when encoding is specified. Added newline and
+  terminator kwargs to allow customizing line ending behavior. Thanks to @vashek
 
 - 0.9.13: Fixes Crashes with ValueError: I/O operation on closed file (issue #16)
-  Also should fix issue #13 with crashes related to Windows file locking.
-  Big thanks to @terencehonles, @nsmcan, @wkoot, @dismine for doing the hard parts
+  Also should fix issue #13 with crashes related to Windows file locking. Big thanks to
+  @terencehonles, @nsmcan, @wkoot, @dismine for doing the hard parts
 
-- 0.9.12: Add umask option (thanks to @blakehilliard) 
-   This adds the ability to control the permission flags when creating log files.
+- 0.9.12: Add umask option (thanks to @blakehilliard)
+  This adds the ability to control the permission flags when creating log files.
 
 - 0.9.11: Fix issues with gzip compression option (use buffering)
 
-- 0.9.10: Fix inadvertent lock sharing when forking
-   Thanks to @eriktews for this fix
+- 0.9.10: Fix inadvertent lock sharing when forking Thanks to @eriktews for this fix
 
-- 0.9.9: Fix Python 2 compatibility broken in last release 
+- 0.9.9: Fix Python 2 compatibility broken in last release
 
 - 0.9.8: Bug fixes and permission features
-   * Fix for issue #4 - AttributeError: 'NoneType' object has no attribute 'write'
-      This error could be caused if a rollover occurred inside a logging statement
-      that was generated from within another logging statement's format() call.
-   * Fix for PyWin32 dependency specification (explicitly require PyWin32)
-   * Ability to specify owner and permissions (mode) of rollover files [Unix only]   
+    * Fix for issue #4 - AttributeError: 'NoneType' object has no attribute 'write' This error could
+      be caused if a rollover occurred inside a logging statement that was generated from within
+      another logging statement's format() call.
+    * Fix for PyWin32 dependency specification (explicitly require PyWin32)
+    * Ability to specify owner and permissions (mode) of rollover files [Unix only]
 
 - 0.9.7/0.9.6: Fix platform specifier for PyPi
 
-- 0.9.5: Add `use_gzip` option to compress rotated logs. Add an optional threaded 
-logging queue handler based on the standard library's `logging.QueueHandler`.
+- 0.9.5: Add `use_gzip` option to compress rotated logs. Add an optional threaded logging queue
+  handler based on the standard library's `logging.QueueHandler`.
 
 - 0.9.4: Fix setup.py to not include tests in distribution.
 
 - 0.9.3: Refactoring release
-   * For publishing fork on pypi as `concurrent-log-handler` under new package name.
-   * NOTE: PyWin32 is required on Windows but is not an explicit dependency because 
-           the PyWin32 package is not currently installable through pip.
-   * Fix lock behavior / race condition
+    * For publishing fork on pypi as `concurrent-log-handler` under new package name.
+    * NOTE: PyWin32 is required on Windows but is not an explicit dependency because the PyWin32
+      package is not currently installable through pip.
+    * Fix lock behavior / race condition
 
-- 0.9.2: Initial release of fork by Preston Landers based on a fork of Lowell Alleman's 
+- 0.9.2: Initial release of fork by Preston Landers based on a fork of Lowell Alleman's
   ConcurrentLogHandler 0.9.1
-   * Fixes deadlocking issue with recent versions of Python
-   * Puts `.__` prefix in front of lock file name
-   * Use `secrets` or `SystemRandom` if available.
-   * Add/fix Windows support
+    * Fixes deadlocking issue with recent versions of Python
+    * Puts `.__` prefix in front of lock file name
+    * Use `secrets` or `SystemRandom` if available.
+    * Add/fix Windows support

CONTRIBUTORS.md

@@ -25,5 +25,3 @@ https://github.com/fr-ez
 https://github.com/mariusvniekerk
 
 https://github.com/buddly27
-
-https://github.com/ZhuYuJin

README.md

@@ -56,31 +56,35 @@ Concurrent Log Handler (CLH) is designed to allow multiple processes to write to
 logfile in a concurrent manner. It is important that each process involved MUST follow
 these requirements:
 
- * Each process must create its OWN instance of the handler (`ConcurrentRotatingFileHandler`)
-
-   * This requirement does not apply to threads within a given process. Different threads
-     within a process can use the same CLH instance. Thread locking is handled automatically.
-
- * As a result of the above, you CANNOT serialize a handler instance and reuse it in another
-   process. This means you cannot, for example, pass a CLH handler instance from parent process
-   to child process using the `multiprocessing` package (or similar techniques). Each child
-   process must initialize its own CLH instance. In the case of a multiprocessing target
-   function, the child target function can call code to initialize a CLH instance. 
-   If your app uses fork() then this may not apply; child processes of a fork() should 
-   be able to inherit the object instance.
-
- * It is important that every process or thread writing to a given logfile must all use the
-   same settings, especially related to file rotation. Also do not attempt to mix different 
-   handler classes writing to the same file, e.g. do not also use a `RotatingFileHandler` on 
-   the same file.
-
- * Special attention may need to be paid when the log file being written to resides on a network
-   shared drive. Whether the multi-process advisory lock technique (via portalocker) works 
-   on a network share may depend on the details of your configuration.
-
- * A separate handler instance is needed for each individual log file. For instance, if your 
-   app writes to two different logs you will need to set up two CLH instances per process.
- 
+* You can't serialize a handler instance and reuse it in another process. This means you cannot, for
+  example, pass a CLH handler instance from parent process to child process using
+  the `multiprocessing` package in spawn mode (or similar techniques that use serialized objects).
+  Each child process must initialize its own CLH instance.
+
+* When using the `multiprocessing` module in "spawn" (non-fork) mode, each child process must create
+  its OWN instance of the handler (`ConcurrentRotatingFileHandler`). The child target function
+  should call code that initializes a new CLH instance.
+
+   * This requirement does not apply to threads within a given process. Different threads within a
+     process can use the same CLH instance. Thread locking is handled automatically.
+
+   * This also does not apply to `fork()` based child processes. Child processes of a fork() call
+     should be able to inherit the CLH object instance.
+
+   * This limitation exists because the CLH object can't be serialized, passed over a network or
+     pipe, and reconstituted at the other end.
+
+* It is important that every process or thread writing to a given logfile must all use the same
+  settings, especially related to file rotation. Also do not attempt to mix different handler
+  classes writing to the same file, e.g. do not also use a `RotatingFileHandler` on the same file.
+
+* Special attention may need to be paid when the log file being written to resides on a network
+  shared drive. Whether the multiprocess advisory lock technique (via portalocker) works on a
+  network share may depend on the details of your configuration.
+
+* A separate handler instance is needed for each individual log file. For instance, if your app
+  writes to two different logs you will need to set up two CLH instances per process.
+
 ### Simple Example
 
 Here is a simple direct usage example:

setup.py

@@ -34,14 +34,8 @@
 Operating System :: POSIX
 Operating System :: Microsoft :: Windows
 Programming Language :: Python
-Programming Language :: Python :: 2.6
 Programming Language :: Python :: 2.7
 Programming Language :: Python :: 3
-Programming Language :: Python :: 3.5
-Programming Language :: Python :: 3.6
-Programming Language :: Python :: 3.7
-Programming Language :: Python :: 3.8
-Programming Language :: Python :: 3.9
 Topic :: Software Development :: Libraries :: Python Modules
 License :: OSI Approved :: Apache Software License
 """