Merge pull request #167 from kianmeng/fix-typos-add-codespell-hook

Fix typos and add `codespell` hook to pre-commit

Author: nicoddemus

.pre-commit-config.yaml

@@ -1,5 +1,9 @@
 exclude: doc/en/example/py2py3/test_py2.py
 repos:
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+    -   id: codespell
 -   repo: https://github.com/psf/black
     rev: 22.12.0
     hooks:

CHANGELOG.rst

@@ -103,7 +103,7 @@
   with previous versions and future versions
   additionally stored serialized objects containing complex objects will
   have a incompatible opcode when read with execnet < 1.4.0
-  and wont be loadable with execnet 1.4.0 either
+  and won't be loadable with execnet 1.4.0 either
 
   its strongly suggested to avoid using the Serializer of execnet 1.4.0
   this affects devpi and the external pytest-cache plugin
@@ -157,7 +157,7 @@
 
 - gateway.remote_exec() will now execute in multiple
   threads on the other side by default.  The previous
-  neccessity of running "gateway.remote_init_threads()"
+  necessity of running "gateway.remote_init_threads()"
   to allow for such concurrency is gone.  The latter
   method is now a no-op and will be removed in future
   versions of execnet.
@@ -228,7 +228,7 @@
 - fix issue #2 - properly reconfigure the channels string coercion for rsync,
   so it can send from python2 to python3
 
-- fix issue #9 - propperly terminate the worker threadpools in safe_terminate
+- fix issue #9 - properly terminate the worker threadpools in safe_terminate
 - fix issue #8 - no longer kill remote pids locally on jython ssh gateways
 
 - refactor socketserver, so it can be directly remote_exec'd for starting a socket gateway on a remote
@@ -257,7 +257,7 @@
 1.0.8
 --------------------------------
 
-- new ``gateway.remote_exec(func, **kwargs)`` style fo executing
+- new ``gateway.remote_exec(func, **kwargs)`` style for executing
   a pure function with parameters.  The function on the remote
   side also needs to accept a ``channel`` which allows it to
   communicate back and forth.  Thanks to Ronny Pfannschmidt
@@ -336,7 +336,7 @@
 
 - automatically close a channel when a remote callback raises
   an exception, makes communication more robust because until
-  now failing callbacks rendered the receiverthread unuseable
+  now failing callbacks rendered the receiverthread unusable
   leaving the remote side in-accessible.
 
 - internally split socket gateways, speeds up popen-gateways

ISSUES.txt

@@ -44,7 +44,7 @@ The client constructs a Channel() object which triggers
 these two connections, presenting a nice send/receive
 abstractions.
 
-The code executing in the http-execserver controled
+The code executing in the http-execserver controlled
 subprocess is a PopenGateway.  It does not know that it
 is connected via the http client/server machinery.
 
@@ -76,7 +76,7 @@ tags: 1.1 feature newdist
 A building block for establishing a permanent hierarchy
 of processes is a Gateway that operates on a Channel object.
 This way a gateway can be instantiated through another
-intermediating gateway which bi-directionallry forwads
+intermediating gateway which bi-directionallry forwards
 Messages through a existing channel.
 
 A code example could look like this:
@@ -89,7 +89,7 @@ A code example could look like this:
     # on the remote place such that the same ssh connection is re-used
     # for multiple ssh=codespeak.net connections, makes for small latency.
 
-some first simple implemenation might look like this::
+some first simple implementation might look like this::
 
     gw = group.makegateway("socketservice//port=8888")
     # we can rely that the subprocess gw can import execnet

README.rst

@@ -23,7 +23,7 @@ Important
 
 execnet_ provides carefully tested means to ad-hoc interact with Python
 interpreters across version, platform and network barriers.  It provides
-a minimal and fast API targetting the following uses:
+a minimal and fast API targeting the following uses:
 
 * distribute tasks to local or remote processes
 * write and deploy hybrid multi-process applications

doc/basics.rst

@@ -130,7 +130,7 @@ and manage the final termination procedure:
 
 .. automethod:: Group.terminate(timeout=None)
 
-This method is implicitely called for each gateway group at
+This method is implicitly called for each gateway group at
 process-exit, using a small timeout.  This is fine
 for interactive sessions or random scripts which
 you rather like to error out than hang.  If you start many

doc/index.rst

@@ -15,7 +15,7 @@ all major computing platforms today.
 **execnet** provides a `share-nothing model`_ with `channel-send/receive`_
 communication for distributing execution across many Python interpreters
 across version, platform and network barriers.  It has
-a minimal and fast API targetting the following uses:
+a minimal and fast API targeting the following uses:
 
 * distribute tasks to (many) local or remote CPUs
 * write and deploy hybrid multi-process applications

execnet/gateway.py

@@ -18,7 +18,7 @@
 
 
 class Gateway(gateway_base.BaseGateway):
-    """Gateway to a local or remote Python Intepreter."""
+    """Gateway to a local or remote Python Interpreter."""
 
     def __init__(self, io, spec):
         super().__init__(io=io, id=spec.id, _startcount=1)
@@ -188,8 +188,8 @@ def _find_non_builtin_globals(source, codeobj):
 def _source_of_function(function):
     if function.__name__ == "<lambda>":
         raise ValueError("can't evaluate lambda functions'")
-    # XXX: we dont check before remote instanciation
-    #      if arguments are used propperly
+    # XXX: we dont check before remote instantiation
+    #      if arguments are used properly
     try:
         sig = inspect.getfullargspec(function)
     except AttributeError:

execnet/gateway_base.py

@@ -403,7 +403,7 @@ def from_io(io):
                 raise EOFError("empty read")
         except EOFError:
             e = sys.exc_info()[1]
-            raise EOFError("couldnt load message header, " + e.args[0])
+            raise EOFError("couldn't load message header, " + e.args[0])
         msgtype, channel, payload = struct.unpack("!bii", header)
         return Message(msgtype, channel, io.read(payload))
 
@@ -634,13 +634,13 @@ def makefile(self, mode="w", proxyclose=False):
             return ChannelFileWrite(channel=self, proxyclose=proxyclose)
         elif mode == "r":
             return ChannelFileRead(channel=self, proxyclose=proxyclose)
-        raise ValueError(f"mode {mode!r} not availabe")
+        raise ValueError(f"mode {mode!r} not available")
 
     def close(self, error=None):
         """close down this channel with an optional error message.
         Note that closing of a channel tied to remote_exec happens
         automatically at the end of execution and cannot
-        be done explicitely.
+        be done explicitly.
         """
         if self._executing:
             raise OSError("cannot explicitly close channel within remote_exec")
@@ -760,7 +760,7 @@ def new(self, id=None):
         """create a new Channel with 'id' (or create new id if None)."""
         with self._writelock:
             if self.finished:
-                raise OSError(f"connexion already closed: {self.gateway}")
+                raise OSError(f"connection already closed: {self.gateway}")
             if id is None:
                 id = self.count
                 self.count += 2
@@ -1130,7 +1130,7 @@ def load(self, versioned=False):
                     loader = self.num2func[opcode]
                 except KeyError:
                     raise LoadError(
-                        "unkown opcode %r - " "wire protocol corruption?" % (opcode,)
+                        "unknown opcode %r - " "wire protocol corruption?" % (opcode,)
                     )
                 loader(self)
         except _Stop:
@@ -1331,7 +1331,7 @@ def __init__(self, write=None):
     def save(self, obj, versioned=False):
         # calling here is not re-entrant but multiple instances
         # may write to the same stream because of the common platform
-        # atomic-write guaruantee (concurrent writes each happen atomicly)
+        # atomic-write guarantee (concurrent writes each happen atomically)
         if versioned:
             self._write(DUMPFORMAT_VERSION)
         self._save(obj)

execnet/gateway_bootstrap.py

@@ -103,7 +103,7 @@ def bootstrap(io, spec):
     elif spec.socket:
         bootstrap_socket(io, spec)
     else:
-        raise ValueError("unknown gateway type, cant bootstrap")
+        raise ValueError("unknown gateway type, can't bootstrap")
     gw = Gateway(io, spec)
     fix_pid_for_jython_popen(gw)
     return gw

execnet/gateway_io.py

@@ -212,7 +212,7 @@ def forward_to_sub(data):
 
     proxy_channelX.setcallback(forward_to_sub)
 
-    def controll(data):
+    def control(data):
         if data == RIO_WAIT:
             control_chan.send(sub_io.wait())
         elif data == RIO_KILL:
@@ -222,7 +222,7 @@ def controll(data):
         elif data == RIO_CLOSE_WRITE:
             control_chan.send(sub_io.close_write())
 
-    control_chan.setcallback(controll)
+    control_chan.setcallback(control)
 
     # write data to the master coming from the sub
     forward_to_master_file = proxy_channelX.makefile("w")