motorcortex-python 1.0.0rc1__tar.gz → 1.0.1__tar.gz

{motorcortex_python-1.0.0rc1/motorcortex_python.egg-info → motorcortex_python-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: motorcortex-python
-Version: 1.0.0rc1
+Version: 1.0.1
 Summary: Python bindings for Motorcortex Engine
 Home-page: https://www.motorcortex.io
 Author: Alexey Zakharov

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/__init__.py

@@ -14,6 +14,7 @@ Provides high-level APIs for communication, login, and data exchange using proto
 See documentation for usage examples.
 """
 
+from enum import IntEnum as _IntEnum
 from typing import Any
 
 from motorcortex.version import __version__
@@ -39,6 +40,39 @@ from motorcortex.exceptions import (
     McxLoginError,
     McxTimeout,
 )
+from motorcortex.motorcortex_pb2 import StatusCode as _PbStatusCode
+from motorcortex.setup_logger import logger  # not re-exported — ``__all__`` gates package surface
+
+# Build an ``IntEnum`` facade over the protobuf ``StatusCode`` enum so
+# callers can write ``motorcortex.StatusCode.OK`` without reaching into
+# the generated protobuf module. Subclassing ``int`` means comparisons
+# like ``reply.status == StatusCode.OK`` work against the raw ints that
+# come back on the wire.
+StatusCode = _IntEnum(
+    "StatusCode",
+    {v.name: v.number for v in _PbStatusCode.DESCRIPTOR.values},
+)
+StatusCode.__doc__ = (
+    "Motorcortex response status codes. Members mirror the ``StatusCode`` "
+    "enum in the wire protocol. Use ``motorcortex.StatusCode.OK`` (or the "
+    "flat re-exports such as ``motorcortex.OK``) to compare against "
+    "``reply.status``."
+)
+
+# Flat re-exports for the conventional ``motorcortex.OK`` idiom. Values
+# are members of :class:`StatusCode` and therefore also ``int``.
+OK = StatusCode.OK
+READ_ONLY_MODE = StatusCode.READ_ONLY_MODE
+FAILED = StatusCode.FAILED
+FAILED_TO_DECODE = StatusCode.FAILED_TO_DECODE
+SUB_LIST_IS_FULL = StatusCode.SUB_LIST_IS_FULL
+WRONG_PARAMETER_PATH = StatusCode.WRONG_PARAMETER_PATH
+FAILED_TO_SET_REQUESTED_FRQ = StatusCode.FAILED_TO_SET_REQUESTED_FRQ
+FAILED_TO_OPEN_FILE = StatusCode.FAILED_TO_OPEN_FILE
+GROUP_LIST_IS_FULL = StatusCode.GROUP_LIST_IS_FULL
+WRONG_PASSWORD = StatusCode.WRONG_PASSWORD
+USER_NOT_LOGGED_IN = StatusCode.USER_NOT_LOGGED_IN
+PERMISSION_DENIED = StatusCode.PERMISSION_DENIED
 
 # ``__all__`` is the 1.0 public API surface. Anything not listed here —
 # including module-level helpers defined below (``parseUrl``,
@@ -72,6 +106,20 @@ __all__ = [
     "McxConnectionError",
     "McxLoginError",
     "McxTimeout",
+    # Status codes
+    "StatusCode",
+    "OK",
+    "READ_ONLY_MODE",
+    "FAILED",
+    "FAILED_TO_DECODE",
+    "SUB_LIST_IS_FULL",
+    "WRONG_PARAMETER_PATH",
+    "FAILED_TO_SET_REQUESTED_FRQ",
+    "FAILED_TO_OPEN_FILE",
+    "GROUP_LIST_IS_FULL",
+    "WRONG_PASSWORD",
+    "USER_NOT_LOGGED_IN",
+    "PERMISSION_DENIED",
     # Tuning
     "init_nng_threads",
 ]
@@ -133,6 +181,56 @@ def makeUrl(address: str, port: int | None) -> str:
     return address
 
 
+def _reconnect_state_update(
+        req: Any, sub: Any, state: "ConnectionState", *,
+        motorcortex_types: "MessageTypes",
+        login: Any,
+        password: Any,
+        token_interval_sec: float,
+        initial_connect_done: list,
+) -> None:
+    """Default ``state_update`` body for :func:`connect` in reconnect mode.
+
+    Fires on every state transition from the ``StateCallbackHandler``
+    worker thread. Only acts on the ``CONNECTION_OK`` edge *after* the
+    initial connect has completed — i.e. on a successful **reconnect**:
+
+    1. Try to restore the previous session via ``restoreSession(token)``.
+       Silent 5-second timeout + generic exception swallow — on any
+       failure we fall through to step 2 so a torn-down session never
+       leaves the reconnect half-authenticated.
+    2. Otherwise re-login with the originally supplied credentials.
+    3. Kick the token-refresh timer and resubscribe all existing groups
+       on the Subscribe side.
+
+    Extracted from a closure inside :func:`connect` so it can be
+    unit-tested without spinning up a real server. ``initial_connect_done``
+    is passed as a 1-element list so the caller (``connect``) can flip
+    the flag after the first successful connect without rebinding.
+    """
+    if state != ConnectionState.CONNECTION_OK or not initial_connect_done[0]:
+        return
+
+    restored = False
+    if req.token:
+        try:
+            restore_reply = req.restoreSession(req.token)
+            restore_msg = restore_reply.get(timeout_ms=5000)
+            motorcortex_msg = motorcortex_types.motorcortex()
+            if restore_msg and restore_msg.status == motorcortex_msg.OK:
+                restored = True
+                logger.debug("[SESSION] Session restored using token")
+        except Exception as e:
+            logger.debug(f"[SESSION] Token restore failed: {e}")
+
+    if not restored:
+        logger.debug("[SESSION] Falling back to login")
+        req.login(login, password).get()
+
+    req._startTokenRefresh(token_interval_sec)
+    sub.resubscribe()
+
+
 def connect(
         url: str,
         motorcortex_types: "MessageTypes",
@@ -185,26 +283,14 @@ def connect(
     if reconnect and not kwargs.get("state_update"):
 
         def stateUpdate(req, sub, state):
-            if state == ConnectionState.CONNECTION_OK and initial_connect_done[0]:
-                # Try to restore session using token, fall back to login
-                restored = False
-                if req.token:
-                    try:
-                        restore_reply = req.restoreSession(req.token)
-                        restore_msg = restore_reply.get(timeout_ms=5000)
-                        motorcortex_msg = motorcortex_types.motorcortex()
-                        if restore_msg and restore_msg.status == motorcortex_msg.OK:
-                            restored = True
-                            logger.debug("[SESSION] Session restored using token")
-                    except Exception as e:
-                        logger.debug(f"[SESSION] Token restore failed: {e}")
-
-                if not restored:
-                    logger.debug("[SESSION] Falling back to login")
-                    req.login(kwargs.get("login"), kwargs.get("password")).get()
-
-                req._startTokenRefresh(token_interval_sec)
-                sub.resubscribe()
+            _reconnect_state_update(
+                req, sub, state,
+                motorcortex_types=motorcortex_types,
+                login=kwargs.get("login"),
+                password=kwargs.get("password"),
+                token_interval_sec=token_interval_sec,
+                initial_connect_done=initial_connect_done,
+            )
 
         kwargs.update(state_update=stateUpdate)
 

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/_request_builders.py

@@ -21,7 +21,7 @@ from typing import Any, Optional, TYPE_CHECKING
 
 from motorcortex.setup_logger import logger
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from motorcortex.message_types import MessageTypes
     from motorcortex.parameter_tree import ParameterTree
 

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/_request_utils.py

@@ -242,7 +242,7 @@ def _purge_stale_cache_files(path: str) -> None:
         try:
             os.unlink(match)
             logger.debug("[REQUEST] Evicted stale cache file: %s", entry)
-        except OSError:
+        except OSError:  # pragma: no cover
             pass
 
 
@@ -276,7 +276,7 @@ def save_parameter_tree_file(path: str, parameter_tree: Any) -> Any:
         with os.fdopen(fd, "w") as outfile:
             outfile.write(json.dumps(envelope))
         os.replace(tmp_path, path)
-    except Exception:
+    except Exception:  # pragma: no cover
         # Clean up the temp file if the rename never ran.
         if os.path.exists(tmp_path):
             try:

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/message_types.py

@@ -5,35 +5,20 @@
 #   All rights reserved. Copyright (c) 2016 VECTIONEER.
 #
 
-from __future__ import unicode_literals
 import motorcortex.motorcortex_pb2
 import logging
-import sys
 import os
+from importlib.machinery import SourceFileLoader
+from types import ModuleType
 
-if sys.version_info[0] >= 3:
-    from importlib.machinery import SourceFileLoader
 
-    if sys.version_info[1] < 4:
-        def importLibrary(name, path):
-            return SourceFileLoader(name, path).load_module()
-    else:
-        from types import ModuleType
+def importLibrary(name, path):
+    loader = SourceFileLoader(name, path)
+    mod = ModuleType(loader.name)
+    loader.exec_module(mod)
+    return mod
 
 
-        def importLibrary(name, path):
-            loader = SourceFileLoader(name, path)
-            mod = ModuleType(loader.name)
-            loader.exec_module(mod)
-            return mod
-else:
-    from builtins import bytes
-    from imp import load_source
-
-
-    def importLibrary(name, path):
-        return load_source(name, path)
-
 from json import load
 from inspect import ismodule
 from typing import Dict
@@ -270,7 +255,7 @@ class MessageTypes(object):
                     self._hashes_by_name[name] = hash
                     self._types_by_hash[hash] = PrimitiveTypes(name)
             logging.debug(f"Loaded types from {name}")
-        except Exception:
+        except Exception:  # pragma: no cover
             # Best-effort — not every namespace declares the enum we're
             # probing for. Swallowed by design, but scoped to Exception
             # so KeyboardInterrupt / SystemExit still propagate.
@@ -282,7 +267,7 @@ class MessageTypes(object):
             for key in enum.DESCRIPTOR.values:
                 setattr(module, key.name, key.number)
             logging.debug(f"Loaded enumerator {enum_name}")
-        except Exception:
+        except Exception:  # pragma: no cover
             # Same best-effort pattern as _loadPrimitives.
             pass
 

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/request.py

@@ -59,7 +59,7 @@ def _register_shutdown(inst: "Request") -> None:
     try:
         import threading
         threading._register_atexit(_close_at_exit, inst)  # type: ignore[attr-defined]
-    except (AttributeError, ImportError):
+    except (AttributeError, ImportError):  # pragma: no cover
         atexit.register(_close_at_exit, inst)
 
 

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/session.py

@@ -41,7 +41,7 @@ from typing import Any, Optional, Type, TYPE_CHECKING
 
 from motorcortex.exceptions import McxConnectionError
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from motorcortex.request import Request, ConnectionState
     from motorcortex.subscribe import Subscribe
     from motorcortex.message_types import MessageTypes

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/subscribe.py

@@ -20,7 +20,7 @@ from motorcortex.setup_logger import logger
 from motorcortex.nng_url import NngUrl
 from motorcortex import _connection_state, _request_utils, _subscribe_dispatch
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from motorcortex.message_types import MessageTypes
 
 
@@ -64,7 +64,7 @@ def _register_shutdown(inst: "Subscribe") -> None:
     try:
         import threading
         threading._register_atexit(_close_at_exit, inst)  # type: ignore[attr-defined]
-    except (AttributeError, ImportError):
+    except (AttributeError, ImportError):  # pragma: no cover
         atexit.register(_close_at_exit, inst)
 
 

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/motorcortex/subscription.py

@@ -272,8 +272,8 @@ class Subscription(object):
 
             Examples:
                   >>> def update(parameters):
-                  >>>   print(parameters) #list of Parameter tuples
-                  >>> ...
+                  >>>     # parameters is a list of Parameter tuples
+                  >>>     print(parameters)
                   >>> data_sub.notify(update)
 
         """

motorcortex_python-1.0.1/motorcortex/version.py

@@ -0,0 +1 @@
+__version__ = '1.0.1'

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1/motorcortex_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: motorcortex-python
-Version: 1.0.0rc1
+Version: 1.0.1
 Summary: Python bindings for Motorcortex Engine
 Home-page: https://www.motorcortex.io
 Author: Alexey Zakharov

{motorcortex_python-1.0.0rc1 → motorcortex_python-1.0.1}/pyproject.toml

@@ -27,7 +27,7 @@ omit = [
 [tool.coverage.report]
 show_missing = true
 skip_covered = false
-fail_under = 60
+fail_under = 90
 exclude_lines = [
     "pragma: no cover",
     "raise NotImplementedError",

motorcortex_python-1.0.0rc1/motorcortex/version.py

@@ -1 +0,0 @@
-__version__ = '1.0.0rc1'