Git rid of some, but not all, PyCharm inspection disables.

Other general cleanup.

Author: Preston-Landers

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+    "MD013": false,
+    "MD046": false
+}

.vscode/settings.json

@@ -19,17 +19,25 @@
         "concat",
         "CREAT",
         "datetime",
+        "gunicorn",
+        "gzipped",
         "Journyx",
+        "kwarg",
+        "kwargs",
         "levelname",
+        "logfile",
+        "logfile's",
         "logfiles",
         "maxsplit",
         "multiprocess",
         "portalocker",
+        "POSIX",
         "pychecker",
         "pycodestyle",
         "pydoc",
         "Pyflakes",
         "Pylint",
+        "pypi",
         "pywin",
         "queuify",
         "stresstest",

CHANGELOG.md

@@ -3,12 +3,13 @@
 - 0.9.23:
   - Begin requiring Python 3.6 or higher.
   - Implements a `ConcurrentTimedRotatingFileHandler` class which provides both time and/or size
-    based rotation. See the [README.md](./README.md#time-based-rotation-settings) for details. 
+    based rotation. See the [README.md](./README.md#time-based-rotation-settings) for details.
+  - Fix #56 - don't fail when setting `owner` on Windows, though it will have no effect.
 
 - 0.9.22:
   - Fix Python 2.7 compatibility (yet again)
-  - Important note: this is the FINAL release which will support Python 2.7. 
-    Future versions will support Python 3.6+ only. 
+  - Important note: this is the FINAL release which will support Python 2.7.
+    Future versions will support Python 3.6+ only.
 
 - 0.9.21:
   - Added new optional parameter "lock_file_directory"
@@ -17,7 +18,7 @@
     - Useful when the log files reside in a cloud synced folder like Dropbox, Google Drive,
         OneDrive, etc. Sometimes these do not work correctly with the lock files.
   - Fix not replacing the last file (greatest backup number) when rotating. Thanks tzongw.
-    - <https://github.com/Preston-Landers/concurrent-log-handler/pull/52> 
+    - <https://github.com/Preston-Landers/concurrent-log-handler/pull/52>
   - Add support for "namer" function to customize the naming of rotated files. Thanks @dashedman.
   - Enhanced test suite using tox and pytest.
 

README.md

@@ -8,15 +8,13 @@ if desired. Both Windows and POSIX systems are supported. An optional threaded
 queue logging handler is provided to perform logging in the background.
 
 This is a fork of Lowell Alleman's ConcurrentLogHandler 0.9.1 which fixes
-a hanging/deadlocking problem. See this:
-
-https://bugs.launchpad.net/python-concurrent-log-handler/+bug/1265150
+a hanging/deadlocking problem. [See this](https://bugs.launchpad.net/python-concurrent-log-handler/+bug/1265150).
 
 Summary of other changes:
 
 * New: requires Python 3.6 or higher.
-    * If you require support for Python 2.7, use version
-      [0.9.22](https://github.com/Preston-Landers/concurrent-log-handler/releases/tag/0.9.22).
+  * If you require support for Python 2.7, use version
+    [0.9.22](https://github.com/Preston-Landers/concurrent-log-handler/releases/tag/0.9.22).
 * Renamed package to `concurrent_log_handler` (abbreviated CLH in this file.)
 * Provide `use_gzip` option to compress rotated logs
 * Support for Windows
@@ -46,7 +44,7 @@ However, this is not the only way to achieve shared logging from multiple proces
 centralize logging by using cloud logging services like Azure Log Monitor, Logstash, etc. Or you can
 implement your own remote logging server as shown here:
 
-https://docs.python.org/3/howto/logging-cookbook.html#sending-and-receiving-logging-events-across-a-network
+[Logging cookbook: network](https://docs.python.org/3/howto/logging-cookbook.html#sending-and-receiving-logging-events-across-a-network)
 
 Concurrent-Log-Handler includes a QueueHandler and QueueListener implementation that can be used to
 perform logging in the background asynchronously, so the thread or process making the log statement doesn't have
@@ -80,31 +78,27 @@ If installing from source, use the following command:
 
 If you plan to modify the code, you should follow this procedure:
 
-- Clone the repository
-- Create a virtual environment (`venv`) and activate it.
-- Install the package in editable mode with the [dev] option:
-
-  `pip install -e .[dev]`
-
-- Run the tests:
+* Clone the repository
+* Create a virtual environment (`venv`) and activate it.
+* Install the package in editable mode with the [dev] option: `pip install -e .[dev]`
 
-  `tox` or run `pytest` directly.
+* Run the tests:  `tox` or run `pytest` directly.
 
   Or manually run a single pass of the stress test with specific options:
 
-```
-  python tests/stresstest.py --help
-  python tests/stresstest.py --gzip --num-processes 12 --log-calls=5000
+```shell
+python tests/stresstest.py --help
+python tests/stresstest.py --gzip --num-processes 12 --log-calls=5000
 ```
 
-- To build a Python "wheel" for distribution, use the following:
+* To build a Python "wheel" for distribution, use the following:
 
 ```shell
-  python setup.py clean --all build sdist bdist_wheel
-  # Copy the .whl file from under the "dist" folder
-  # or upload with twine:
-  pip install twine
-  twine upload dist/concurrent-log-handler-0.9.23.tar.gz dist/concurrent_log_handler-0.9.23-py3-none-any.whl
+python setup.py clean --all build sdist bdist_wheel
+# Copy the .whl file from under the "dist" folder
+# or upload with twine:
+pip install twine
+twine upload dist/concurrent-log-handler-0.9.23.tar.gz dist/concurrent_log_handler-0.9.23-py3-none-any.whl
 ```
 
 ### Important Requirements
@@ -122,14 +116,14 @@ these requirements:
   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 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 such as gunicorn --preload.
-      Child processes of a fork() call should be able to inherit the CLH object instance.
+  * This also does not apply to `fork()` based child processes such as gunicorn --preload.
+    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.
+  * 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
@@ -180,7 +174,7 @@ multiple hosts works due to the use of file locking on the log file. Note that w
 logging feature, currently there is no way for the caller to know when the logging statement
 completed (no "Promise" or "Future" object is returned).
 
-https://docs.python.org/3/library/logging.handlers.html#queuehandler
+[QueueHandler](https://docs.python.org/3/library/logging.handlers.html#queuehandler)
 
 ### Configuration
 
@@ -202,7 +196,7 @@ Please note that Python 3.7 and higher accepts keyword arguments (kwargs) in a l
 config file, but earlier versions of Python only accept positional args.
 
 Note: you must have an `import concurrent_log_handler` before you call fileConfig(). For
-more information see http://docs.python.org/lib/logging-config-fileformat.html
+more information see Python docs on [log file formats](http://docs.python.org/lib/logging-config-fileformat.html)
 
 ### Limitations
 
@@ -237,8 +231,8 @@ order for this to work, each process writing to the log must have access to the
 lock file location, even if they are running on different hosts.
 
 You can set the `namer` attribute of the handler to customize the naming of the rotated files,
-in line with the `BaseRotatingHandler` class. See the Python docs for more details:
-https://docs.python.org/3.11/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.namer
+in line with the `BaseRotatingHandler` class. See the Python docs for 
+[more details](https://docs.python.org/3.11/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.namer).
 
 ### Line Endings
 

src/concurrent_log_handler/__init__.py

@@ -63,7 +63,6 @@
 from contextlib import contextmanager
 from logging.handlers import BaseRotatingHandler, TimedRotatingFileHandler
 
-# noinspection PyPackageRequirements
 from portalocker import LOCK_EX, lock, unlock
 
 from concurrent_log_handler.__version__ import __author__, __version__  # noqa: F401
@@ -77,7 +76,6 @@
 # Random numbers for rotation temp file names, using secrets module if available (Python 3.6).
 # Otherwise use `random.SystemRandom` if available, then fall back on `random.Random`.
 try:
-    # noinspection PyPackageRequirements,PyCompatibility
     from secrets import randbits
 except ImportError:
     import random
@@ -233,9 +231,7 @@ def __init__(  # noqa: PLR0913
         self.terminator = terminator or "\n"
 
         if owner and has_chown and pwd and grp:
-            # noinspection PyUnresolvedReferences
             self._set_uid = pwd.getpwnam(self.owner[0]).pw_uid
-            # noinspection PyUnresolvedReferences
             self._set_gid = grp.getgrnam(self.owner[1]).gr_gid
 
         self.lockFilename = self.getLockFilename(lock_file_directory)
@@ -323,7 +319,6 @@ def do_open(self, mode=None):
             mode = self.mode
 
         with self._alter_umask():
-            # noinspection PyArgumentList
             stream = open(
                 self.baseFilename,
                 mode=mode,
@@ -381,7 +376,6 @@ def emit(self, record):
         This also does the formatting *before* locks are obtained, in case the format itself does
         logging calls from within. Rollover also occurs while the lock is held.
         """
-        # noinspection PyBroadException
         try:
             msg = self.format(record)
             try:
@@ -440,7 +434,6 @@ def _do_lock(self):
         self._open_lockfile()
         if self.stream_lock:
             for _i in range(self.maxLockAttempts):
-                # noinspection PyBroadException
                 try:
                     lock(self.stream_lock, LOCK_EX)
                     self.is_locked = True
@@ -554,7 +547,6 @@ def do_rename(source_fn, dest_fn):
         self.num_rollovers += 1
         self._console_log("Rotation completed (on size)")
 
-    # noinspection PyUnusedLocal
     def shouldRollover(self, record):
         """
         Determine if rollover should occur.
@@ -605,7 +597,6 @@ def _do_chown_and_chmod(self, filename):
             os.chmod(filename, self.chmod)
 
 
-# noinspection PyProtectedMember
 class ConcurrentTimedRotatingFileHandler(TimedRotatingFileHandler):
     """A time-based rotating log handler that supports concurrent access across
     multiple processes or hosts (using logs on a shared network drive).
@@ -698,7 +689,6 @@ def emit(self, record):
         This also does the formatting *before* locks are obtained, in case the format itself does
         logging calls from within. Rollover also occurs while the lock is held.
         """
-        # noinspection PyBroadException
         try:
             msg = self.format(record)
             try:
@@ -834,7 +824,7 @@ def doRollover(self):  # noqa: C901, PLR0912
         counter = 0
         while os.path.exists(dfn + gzip_ext):
             counter += 1
-            ending = f".{counter-1}{gzip_ext}"
+            ending = f".{counter - 1}{gzip_ext}"
             if dfn.endswith(ending):
                 dfn = dfn[: -len(ending)]
             dfn = f"{dfn}.{counter}"

src/concurrent_log_handler/queue.py

@@ -112,7 +112,6 @@ def setup_logging_queues():
 
 def stop_queue_listeners(*listeners):
     for listener in listeners:
-        # noinspection PyBroadException
         try:  # noqa: SIM105
             listener.stop()
             # if sys.stderr:
@@ -133,7 +132,6 @@ def get_all_logger_names(include_root=False):
 
     Warning: this is sensitive to internal structures in the standard logging module.
     """
-    # noinspection PyUnresolvedReferences
     rv = list(logging.Logger.manager.loggerDict.keys())
     if include_root:
         rv.insert(0, "")

src/example.py

@@ -54,9 +54,7 @@ def my_logging_setup(log_name="example.log", use_async=False):
     """
 
     # Import this to install logging.handlers.ConcurrentRotatingFileHandler
-    # The noinspection thing is so PyCharm doesn't think we're using this for no reason
-    # noinspection PyUnresolvedReferences
-    import concurrent_log_handler   # noqa: F401, I001
+    import concurrent_log_handler  # noqa: F401
 
     logging_config = {
         "version": 1,

tests/other/stresstest.py

@@ -352,7 +352,6 @@ def checkExitCodes(self):
         return True
 
 
-# noinspection PyUnresolvedReferences
 def unified_diff(a, b, out=sys.stdout, out2=None):
     import difflib
 
@@ -366,7 +365,7 @@ def unified_diff(a, b, out=sys.stdout, out2=None):
         #     line = line.encode(ENCODING)
         if PY2:
             if not isinstance(line, unicode):
-                line = unicode(line, ENCODING)
+                line = unicode(line, ENCODING)  # noqa: PLW2901
             line_out = line.encode(out.encoding, "ignore").decode(out.encoding)
             out.write(line_out)
         else:
@@ -375,7 +374,7 @@ def unified_diff(a, b, out=sys.stdout, out2=None):
             dfile.write(line)
 
 
-def main_runner(args):
+def main_runner(args):  # noqa: PLR0915
     parser.add_option(
         "--processes",
         metavar="NUM",

tests/stresstest.py

@@ -106,9 +106,11 @@ def emit(self, record):
         # Introduce a random chance (e.g., 5%) to skip or duplicate a log message
         random_choice = random.randint(1, 100)
 
-        if 1 <= random_choice <= 5:  # 5% chance to skip a log message  # noqa: PLR2004
+        # 5% chance to skip a log message
+        if 1 <= random_choice <= 5:  # noqa: PLR2004
             return
-        if 6 <= random_choice <= 10:  # 5% chance to duplicate a log message  # noqa: PLR2004
+        # 5% chance to duplicate a log message
+        if 6 <= random_choice <= 10:  # noqa: PLR2004
             super().emit(record)
             super().emit(record)
         else:

tests/test_stresstest.py

@@ -103,7 +103,6 @@
         ),
     ),
     # TODO: it would be good to have some test cases that verify that backupCount is not exceeded.
-
     # Testing time intervals other than seconds is difficult because the tests would
     # take hours unless we find a way to mock things.
 }