Merge pull request #27 from yarikoptic/enh-codespell

Add codespell support (config, workflow to detect/not fix) and make it fix few typos

Author: deajan

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,.codespellrc
+check-hidden = true
+# ignore-regex = 
+# ignore-words-list =

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

CHANGELOG.md

@@ -30,7 +30,7 @@
 
 ## Features
 
-- command_runner now has a `command_runner_threaded()` function which allows to run in background, but stil provide live stdout/stderr stream output via queues/callbacks
+- command_runner now has a `command_runner_threaded()` function which allows to run in background, but still provide live stdout/stderr stream output via queues/callbacks
 - Refactor poller mode to allow multiple stdout / stderr stream redirectors
     - Passing a queue.Queue() instance to stdout/stderr arguments will fill queue with live stream output
 	- Passing a function to stdout/stderr arguments will callback said function with live stream output
@@ -115,7 +115,7 @@
     - All tests are done for both capture methods
     - Timeout tests are more accurate
     - Added missing encoding tests
-    - 2500 rounds of file reading and comparaison are added to detect rare queue read misses
+    - 2500 rounds of file reading and comparison are added to detect rare queue read misses
 
 # v0.7.0 (yanked - do not use; see v1.2.0 critical fixes) - The windows GUI
 

README.md

@@ -43,7 +43,7 @@ It works as wrapper for subprocess.popen and subprocess.communicate that solves:
    - Can show command output on the fly without waiting the end of execution (with `live_output=True` argument)
    - Can give command output on the fly to application by using queues or callback functions
    - Catch all possible exceptions and log them properly with encoding fixes
-   - Be compatible, and always return the same result regarless of platform
+   - Be compatible, and always return the same result regardless of platform
 
 command_runner also promises to properly kill commands when timeouts are reached, including spawned subprocesses of such commands.
 This specific behavior is achieved via psutil module, which is an optional dependency.
@@ -69,7 +69,7 @@ exit_code, output = command_runner('ping 127.0.0.1', timeout=10)
 
 ### Special exit codes
 
-In order to keep the promise to always provide an exit_code, spcial exit codes have been added for the case where none is given.
+In order to keep the promise to always provide an exit_code, special exit codes have been added for the case where none is given.
 Those exit codes are:
 
 - -250 : command_runner called with incompatible arguments
@@ -208,7 +208,7 @@ command_runner can redirect the command's stdout and/or stderr streams to differ
 Unless an output redirector is given for `stderr` argument, stderr will be redirected to `stdout` stream.
 Note that both queues and callback function redirectors require `poller` method and will fail if method is not set.
 
-Output redirector descrptions:  
+Output redirector descriptions:  
 
 - subprocess pipes
 
@@ -240,7 +240,7 @@ exit_code, output = command_runner('dir', stdout='/tmp/stdout.log', stderr='/tmp
   - Queue(s) will be filled up by command_runner.
   - In order to keep your program "live", we'll use the threaded version of command_runner which is basically the same except it returns a future result instead of a tuple.
   - Note: With all the best will, there's no good way to achieve this under Python 2.7 without using more queues, so the threaded version is only compatible with Python 3.3+.
-  - For Python 2.7, you must create your thread and queue reader yourself (see footnote for a Python 2.7 comaptible example).
+  - For Python 2.7, you must create your thread and queue reader yourself (see footnote for a Python 2.7 compatible example).
   - Threaded command_runner plus queue example:
 
 ```python

command_runner/__init__.py

@@ -320,7 +320,7 @@ def to_encoding(
     # type: (...) -> str
     """
     Convert bytes output to string and handles conversion errors
-    Varation of ofunctions.string_handling.safe_string_convert
+    Variation of ofunctions.string_handling.safe_string_convert
     """
 
     if not encoding:
@@ -352,7 +352,7 @@ def kill_childs_mod(
     """
     Inline version of ofunctions.kill_childs that has no hard dependency on psutil
 
-    Kills all childs of pid (current pid can be obtained with os.getpid())
+    Kills all children of pid (current pid can be obtained with os.getpid())
     If no pid given current pid is taken
     Good idea when using multiprocessing, is to call with atexit.register(ofunctions.kill_childs, os.getpid(),)
 
@@ -625,7 +625,7 @@ def _read_pipe(
 
         # We also need to check that stream has readline, in case we're writing to files instead of PIPE
 
-        # Another magnificient python 2.7 fix
+        # Another magnificent python 2.7 fix
         # So we need to convert sentinel_char which would be unicode because of unicode_litterals
         # to str which is the output format from stream.readline()
 
@@ -687,7 +687,7 @@ def __check_timeout(
             # type: (...) -> None
             """
             Simple subfunction to check whether timeout is reached
-            Since we check this alot, we put it into a function
+            Since we check this a lot, we put it into a function
             """
             if timeout and (datetime.now() - begin_time).total_seconds() > timeout:
                 kill_childs_mod(process.pid, itself=True, soft_kill=False)
@@ -820,7 +820,7 @@ def _timeout_check_thread(
                 break
             if process.poll() is not None:
                 break
-            # We definitly need some sleep time here or else we will overload CPU
+            # We definitely need some sleep time here or else we will overload CPU
             sleep(check_interval)
 
     def _monitor_process(

command_runner/elevate.py

@@ -146,7 +146,7 @@ def _check_environment():
     # Regardless of the runner (CPython, Nuitka or frozen CPython), sys.argv[0] is the relative path to script,
     # sys.argv[1] are the arguments
     # The only exception being CPython on Windows where sys.argv[0] contains absolute path to script
-    # Regarless of OS, sys.executable will contain full path to python binary for CPython and Nuitka,
+    # Regardless of OS, sys.executable will contain full path to python binary for CPython and Nuitka,
     # and full path to frozen executable on frozen CPython
 
     # Recapitulative table create with
@@ -231,7 +231,7 @@ def elevate(callable_function, *args, **kwargs):
                 callable_function(*args, **kwargs)
             else:
                 command = ["sudo", runner] + arguments
-                # Optionnaly might also pass a stdout PIPE to command_runner so we get live output
+                # Optionally might also pass a stdout PIPE to command_runner so we get live output
                 exit_code, output = command_runner(command, shell=False, timeout=None)
 
                 logger.info("Child output: {}".format(output))

tests/test_command_runner.py

@@ -265,7 +265,7 @@ def test_unix_only_split_command():
     if os.name == 'posix':
         for method in methods:
             exit_code, _ = command_runner(' '.join(PING_CMD), method=method)
-            assert exit_code == 0, 'Non splitted command should not trigger an error with method {}'.format(method)
+            assert exit_code == 0, 'Non split command should not trigger an error with method {}'.format(method)
 
 
 def test_create_no_window():
@@ -296,7 +296,7 @@ def test_read_file():
         max_rounds = 100 if is_pypy() else 1000
         print("\nSetting up test_read_file for {} rounds".format(max_rounds))
         for round in range(0, max_rounds):
-            print('Comparaison round {} with method {}'.format(round, method))
+            print('Comparison round {} with method {}'.format(round, method))
             exit_code, output = command_runner(PRINT_FILE_CMD, shell=True, method=method)
             if os.name == 'nt':
                 output = output.replace('\r\n', '\n')