Fix lots of typos

Author: Dorian Birraux

docs/docpages/intro.rst

@@ -246,7 +246,7 @@ Session management
 
 It is highly recommended to initialize a session once and for all to mitigate the initialization cost.
 
-Delegate the handling of the lifecycle of a session using a `with` block::
+Delegate the handling of the life-cycle of a session using a `with` block::
 
     >>> with WolframLanguageSession('/path/to/kernel-executable') as wl_session:
     ...     wl_session.StringReverse('abc')
@@ -268,7 +268,7 @@ Manually terminate the session::
     >>> session.terminate()
 
 .. note::
-    nonterminated sessions usually result in orphan kernel processes, which ultimately lead to the inability to spawn any usable instance at all. Typically, this ends up with a WolframKernelException raised after a failure to communicate with the kernel.
+    non-terminated sessions usually result in orphan kernel processes, which ultimately lead to the inability to spawn any usable instance at all. Typically, this ends up with a WolframKernelException raised after a failure to communicate with the kernel.
 
 .. note :: 
     for in-depth explanations and use cases of local evaluation, refer to :ref:`the advanced usage section<adv-local-evaluation>`.
@@ -486,7 +486,7 @@ Create a :class:`~wolframclient.evaluation.WolframAPICall` targeting the API::
 
     >>> api_call = WolframAPICall(session, api)
 
-Alternativelly, it is possible to create a :class:`~wolframclient.evaluation.WolframAPICall` directly from a session::
+Alternatively, it is possible to create a :class:`~wolframclient.evaluation.WolframAPICall` directly from a session::
 
     >>> api_call =  session.wolfram_api_call(api)
 
@@ -554,7 +554,7 @@ The :wl:`WXF` format is also supported. It is a binary format, thus not always h
     >>> export(wl.Select(wl.PrimeQ, [1,2,3]), target_format='wxf')
     b'8:f\x02s\x06Selects\x06PrimeQf\x03s\x04ListC\x01C\x02C\x03'
 
-If the `sream` parameter is set to a string path, the serialized output is directly written to the file.
+If the `stream` parameter is set to a string path, the serialized output is directly written to the file.
 
 First, represent a Wolfram Language :wl:`ListPlot` of the first 25 :wl:`Prime` numbers::
 

run.py

@@ -5,7 +5,8 @@
 if __name__ == '__main__':
 
     #this will perform an auto install of missing modules using PIP
-    #this won't be used in production, but it's handy when we are ginving this paclet to other developers
+    #this should not be used in production, but it's handy when we are giving this paclet to other developers
+    #as it provides convenient access to unit tests, profiler, and benchmarking.
 
     from wolframclient.cli.dispatch import execute_from_command_line
 

wolframclient/evaluation/cloud/asyncoauth.py

@@ -201,9 +201,9 @@ async def authenticate(self):
 
 
 class _AsyncBytesIO(object):
-    def __init__(self, initalbytes=None):
-        if initalbytes:
-            self.buffer = six.BytesIO(initalbytes)
+    def __init__(self, initial_bytes=None):
+        if initial_bytes:
+            self.buffer = six.BytesIO(initial_bytes)
         else:
             self.buffer = six.BytesIO()
 

wolframclient/evaluation/cloud/base.py

@@ -70,7 +70,7 @@ def signed_request(self, uri, headers={}, data=None, method='POST'):
         raise NotImplementedError
 
     def authorized(self):
-        """Return a reasonnably accurate state of the authentication status."""
+        """Return a reasonably accurate state of the authentication status."""
         return self._client is not None and bool(
             self._client.client_secret) and bool(
                 self._client.resource_owner_key) and bool(

wolframclient/evaluation/cloud/server.py

@@ -10,12 +10,9 @@
 class WolframServer(object):
     ''' Represents the cloud server.
 
-    Contains the authentication endpoints informations, the API endpoint aka. the
+    Contains the authentication endpoints information, the API endpoint aka. the
     cloud base (`$CloudBase` in the Wolfram Language), and eventually the xauth
     consumer key and secret.
-
-    For conveniency this class exposes static methods to build instances from
-    a `Configuration` or from a file path.
     '''
 
     def __init__(self,

wolframclient/evaluation/kernel/kernelsession.py

@@ -284,7 +284,7 @@ def _stop(self, gracefully=True):
                             % self.get_parameter('TERMINATE_READ_TIMEOUT'))
                         error = True
                 # Kill process if not already terminated.
-                # Wait for it to cleanly stop if the Quit command was succesfully sent,
+                # Wait for it to cleanly stop if the Quit command was successfully sent,
                 # otherwise the kernel is likely in a bad state so we kill it immediately.
             if self._stdin == PIPE:
                 try:

wolframclient/evaluation/pool.py

@@ -173,7 +173,7 @@ async def _async_start_kernel(self, kernel):
                     e2)
 
         if kernel_started:
-            # shedule the infinite evaluation loop
+            # schedule the infinite evaluation loop
             task = asyncio.create_task(self._kernel_loop(kernel))
             if logger.isEnabledFor(logging.INFO):
                 logger.info('New kernel started in pool: %s.', kernel)
@@ -210,8 +210,6 @@ async def start(self):
 
     async def stop(self):
         self.stopped = True
-        #  todo cancel with self.event_abort.set() ???
-
         # make sure all init tasks are finished.
         if len(self._pending_init_tasks) > 0:
             for task in self._pending_init_tasks:
@@ -275,7 +273,7 @@ async def _evaluate_all(self, iterable):
         return await asyncio.gather(*tasks)
 
     def __repr__(self):
-        return 'WolframEvaluatorPool<%i/%i started evaluators, cummulating %i evaluations>' % (
+        return 'WolframEvaluatorPool<%i/%i started evaluators, cumulating %i evaluations>' % (
             len(self._started_tasks), self.requestedsize, self.eval_count)
 
     def __len__(self):

wolframclient/evaluation/result.py

@@ -67,7 +67,7 @@ class WolframKernelEvaluationResult(WolframResultBase):
 
     The final Python expression is lazily computed when accessing the
     field `result`. The WXF bytes holding the evaluation result are
-    stored in `wxf` and thus can be parsed with a consumized parser if
+    stored in `wxf` and thus can be parsed with a customized parser if
     necessary.
     """
 
@@ -101,8 +101,8 @@ class WolframEvaluationJSONResponse(WolframResultBase):
     """Result object associated with cloud kernel evaluation.
 
     The response body associated to this type of result must be json encoded.
-    Other fields provide additionnal information. The HTTP response object is
-    stored as `http_response` and when HTTP error occured it is stored in `request_error`.
+    Other fields provide additional information. The HTTP response object is
+    stored as `http_response` and when HTTP error occurred it is stored in `request_error`.
     """
 
     def __init__(self, response):
@@ -191,8 +191,8 @@ class WolframEvaluationJSONResponseAsync(WolframEvaluationJSONResponse):
     """Result object associated with cloud kernel evaluation.
 
     The response body associated to this type of result must be json encoded.
-    Other fields provide additionnal information. The HTTP response object is
-    stored as `http_response` and when HTTP error occured it is stored in `request_error`.
+    Other fields provide additional information. The HTTP response object is
+    stored as `http_response` and when HTTP error occurred it is stored in `request_error`.
     """
 
     async def _build(self):
@@ -248,7 +248,7 @@ def __repr__(self):
             return '{}<request error {}>'.format(self.__class__.__name__,
                                                  self.http_response.status())
         else:
-            return '{}<sucessful request, body not read>'.format(
+            return '{}<successful request, body not read>'.format(
                 self.__class__.__name__)
 
 
@@ -315,19 +315,6 @@ async def get(self):
     async def _build(self):
         raise NotImplementedError
 
-    # async generators do not exist in 3.5
-    # async def iter_error(self):
-    #     """Generator of tuples made from the field name and the associated error message"""
-    #     if not self._built:
-    #         await self._build()
-    #     for err in self._iter_error():
-    #         yield err
-    # async def iter_full_error_report(self):
-    #     """Generator of tuples made from the field name and the associated entire error report."""
-    #     if not self._built:
-    #         await self._build()
-    #     for err in self._iter_full_error_report():
-    #         yield err
     async def iter_error(self):
         raise NotImplementedError
 

wolframclient/language/decorators.py

@@ -25,7 +25,7 @@ def safe_wl_execute(function,
     except Exception as e:
 
         #the user might provide an exception class, that might be broken.
-        #in this case we are running another try / except to return errors that are happneing during class serialization
+        #in this case we are running another try / except to return errors that are happening during class serialization
 
         if isinstance(e, WolframLanguageException):
             try:

wolframclient/language/expression.py

@@ -99,8 +99,8 @@ def __repr__(self):
 class WLSymbolFactory(WLSymbol):
     """Provide a convenient way to build objects representing arbitrary Wolfram Language expressions through the use of attributes.
 
-    This class is conveniently instanciated at startup as: :class:`~wolframclient.language.wl`, :class:`~wolframclient.language.Global` 
-    and :class:`~wolframclient.language.System`. It should be instanciated only to represent many symbols belonging to the same specific
+    This class is conveniently instantiated at startup as: :class:`~wolframclient.language.wl`, :class:`~wolframclient.language.Global` 
+    and :class:`~wolframclient.language.System`. It should be instantiated only to represent many symbols belonging to the same specific
     context.
 
     Example::

wolframclient/serializers/encoders/pil.py

@@ -21,7 +21,7 @@
     the image is converted to its format, if specified, or ultimatelly to PNG. This may fail,
     in which case an exception is raised and there is nothing more we can do.
 
-    In theory we could represent any image, but due to :func:`~PIL.Image.convert()` behaviour 
+    In theory we could represent any image, but due to :func:`~PIL.Image.convert()` behavior 
     we can't. This function is not converting, but naively casts to a given type without rescaling.
     e.g. int32 values above 255 converted to bytes become 255. We can't cast properly from 'I' mode
     since some format are using 'I' for say 'I;16' (int16) and the rawmode is not always accessible.

wolframclient/serializers/serializable.py

@@ -36,7 +36,7 @@ def to_wl(self):
     def to_wl(self):
         """ Return the serialized form of a given python class.
         
-        The returned value must be a combinasion of serializable types.
+        The returned value must be a combination of serializable types.
         """
         raise NotImplementedError(
             'class %s must implement a to_wl method' % self.__class__.__name__)

wolframclient/serializers/wxfencoder/streaming.py

@@ -62,7 +62,7 @@ def read(self, size=-1):
 class ZipCompressedReader(object):
     """A buffer implementation reading zip compressed data from a source buffer and returning uncompressed data.
 
-    This class is instanciated from a reader, any object implementing a :meth:`~io.BufferedIOBase.read` method.
+    This class is instantiated from a reader, any object implementing a :meth:`~io.BufferedIOBase.read` method.
     """
     CHUNK_SIZE = 8192
 

wolframclient/serializers/wxfencoder/wxfexpr.py

@@ -52,10 +52,10 @@ def _serialize_to_wxf(self, stream, context):
 
 
 class WXFExprInteger(WXFExpr):
-    ''' Integers have various length, from one byte up to eigth and are signed
+    ''' Integers have various length, from one byte up to eight and are signed
     values. Values above 2^63-1 are represented with `WXFExprBigInteger`.
     Internally WXF uses the two's complement representation of integer values.
-    The endianness is system independant and is always little-endian.
+    The endianness is system independent and is always little-endian.
     '''
     __slots__ = 'value', 'int_size'
 
@@ -256,7 +256,7 @@ class WXFExprAssociation(WXFExpr):
     def __init__(self, length):
         if not isinstance(length, six.integer_types) or length < 0:
             raise TypeError(
-                'WXFExprAssociation must be instanciated with a length.')
+                'WXFExprAssociation must be instantiated with a length.')
         super(WXFExprAssociation, self).__init__(WXF_CONSTANTS.Association)
         self.length = length
 

wolframclient/serializers/wxfencoder/wxfexprprovider.py

@@ -11,7 +11,7 @@ class WXFExprProvider(object):
     Expression provider pull instances of WXFExpr from instances of `WXFEncoder`.
 
     `WXFExprProvider` can be initialized with an encoder. If none is provided the
-    default class `DefaultWXFEncoder` is used to instanciate one. It is possible
+    default class `DefaultWXFEncoder` is used to instantiate one. It is possible
     to add extra encoder using `add_encoder`. The order in which encoders are called
     is the one in which they were added. Note that for performance reasons, it is
     recommended to have the default encoder be first, as such one should not initialize

wolframclient/utils/dispatch.py

@@ -13,7 +13,7 @@
 class Dispatch(object):
     """ A method dispatcher class allowing for multiple implementations of a function. Each implementation is associated to a specific input type.
     
-    Imprementations are registered with the annotation :meth:`~wolframclient.utils.dispatch.Dispatch.dispatch`.
+    Implementations are registered with the annotation :meth:`~wolframclient.utils.dispatch.Dispatch.dispatch`.
 
     The Dispatch class is callable, it behaves as a function that uses the implementation corresponding to the input parameter.
 
@@ -47,7 +47,7 @@ def my_default_func(...)
             @dispatcher.dispatch((bytes, bytearray))
             def my_func(...)
 
-        Implementation must be unique. Registering the same combinaison of types will raise an error, 
+        Implementation must be unique. Registering the same combination of types will raise an error, 
         except if `force` is set to :data:`True`, in which case the mapping is updated.
         """