vortexpy 4.3.5__tar.gz → 6.0.0__tar.gz

vortexpy-6.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2016-2026 Flying Ion Pty Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

{vortexpy-4.3.5 → vortexpy-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortexpy
-Version: 4.3.5
+Version: 6.0.0
 Summary: Flying Ion's observable, routable, data serialisation and transport code.
 Author-email: Flying Ion Pty Ltd <contact@flyingion.com>
 License: MIT
@@ -32,17 +32,20 @@ Requires-Dist: txhttputil>=1.2.0
 Flying Ion's observable, routable, data serialisation and transport code.
 
 See [README_PERMISSIONS.md](README_PERMISSIONS.md) for the two-level permission
-system (endpoint guards + access control context) introduced in v5.0.
-
-**Tuple and Payload tutorials:** [docs/README.md](docs/README.md) (simple → full features, encode/decode, threaded decode).
+system (endpoint guards + access control context) introduced in v6.0.
 
 Why PY at the end? To be consistent with VortexJS, which is the Browser side package.
 See https://gitlab.com/flyingion/vortexjs
 
 Requirements:
-* Python 3.5
-* Twisted 16+
-* SQLAlchemy 1, 1.1
+* Python 3.12 (development target)
+* Twisted (autobahn / txwebsocket)
+* SQLAlchemy >= 2.0
+
+See `pyproject.toml` for the authoritative dependency list.
+
+See [README_MIGRATION.md](README_MIGRATION.md) for breaking changes and
+migration guides (4.4.0, 6.0.0).
 
 The "vortex" is designed to transport "Payloads" from a web browser (VortexJS) to a
 twisted web server (VortexPY). There is also a python client for python client to python server

{vortexpy-4.3.5 → vortexpy-6.0.0}/README.md

@@ -3,17 +3,20 @@
 Flying Ion's observable, routable, data serialisation and transport code.
 
 See [README_PERMISSIONS.md](README_PERMISSIONS.md) for the two-level permission
-system (endpoint guards + access control context) introduced in v5.0.
-
-**Tuple and Payload tutorials:** [docs/README.md](docs/README.md) (simple → full features, encode/decode, threaded decode).
+system (endpoint guards + access control context) introduced in v6.0.
 
 Why PY at the end? To be consistent with VortexJS, which is the Browser side package.
 See https://gitlab.com/flyingion/vortexjs
 
 Requirements:
-* Python 3.5
-* Twisted 16+
-* SQLAlchemy 1, 1.1
+* Python 3.12 (development target)
+* Twisted (autobahn / txwebsocket)
+* SQLAlchemy >= 2.0
+
+See `pyproject.toml` for the authoritative dependency list.
+
+See [README_MIGRATION.md](README_MIGRATION.md) for breaking changes and
+migration guides (4.4.0, 6.0.0).
 
 The "vortex" is designed to transport "Payloads" from a web browser (VortexJS) to a
 twisted web server (VortexPY). There is also a python client for python client to python server

{vortexpy-4.3.5 → vortexpy-6.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortexpy"
-version = "4.3.5"
+version = "6.0.0"
 license = {text = "MIT"}
 authors = [{name = "Flying Ion Pty Ltd", email = "contact@flyingion.com"}]
 description = "Flying Ion's observable, routable, data serialisation and transport code."
@@ -53,13 +53,3 @@ namespaces = false
 
 [project.entry-points."mypy.plugins"]
 vortex_defer = "vortex.mypy_plugin:plugin"
-
-[tool.pytest.ini_options]
-testpaths = ["vortex"]
-python_files = ["*_test.py"]
-python_functions = ["test*"]
-norecursedirs = ["_trial_temp", "example", "old_fork"]
-markers = [
-    "trial: legacy Twisted Trial *Test.py modules (not collected; run with trial CLI)",
-    "slow: large payload or timing benchmarks",
-]

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/Jsonable.py

@@ -107,11 +107,9 @@ class Jsonable(object):
         try:
             valueType = V_NULL if value is None else toRapuiType(value)
         except KeyError as e:
-            unsupportedType = e.args[0] if e.args else value.__class__
             raise KeyError(
-                "%r field name is %r, type is %r"
-                % (unsupportedType, name, value.__class__)
-            ) from e
+                "%s field name is %s, type is %s", e, name, value.__class__
+            )
 
         # Payloads and Tuples
         if self.__isRawJsonableField(name):

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadEndpoint.py

@@ -22,32 +22,18 @@ from vortex.VortexAccessControlContextABC import (
     NO_AUTH_ACCESS_CONTROL_CONTEXT,
     VortexAccessControlContextABC,
 )
-from vortex.VortexEndpointPermission import (
-    EndpointPermissionsType as PermissionsType,
-)
+from vortex.VortexEndpointPermission import EndpointPermissionsType as PermissionsType
 from vortex.VortexSession import (
     _callableLabel,
     checkAccessControlContextSignature,
+    checkEndpointPermissionsSignature,
     checkNoHttpSessionInSignature,
+    checkNoVortexSessionInSignature,
 )
 
 logger = logging.getLogger(__name__)
 
 
-# TODO: typings needs to support keyword args before tbis will work.
-# PayloadEndpointProcessCallable = Callable[
-#     [
-#         ...
-#         # PayloadEnvelope,  # payloadEnvelope
-#         # str,  # vortexUuid
-#         # str,  # vortexName
-#         # Any,  # vortexSession
-#         # SendVortexMsgResponseCallable  # sendResponse
-#     ],
-#     Optional[Deferred]  # Return
-# ]
-
-
 class PayloadEndpoint:
     """
     The payload endpoint is responsible for matching payloads filters against
@@ -71,7 +57,6 @@ class PayloadEndpoint:
         acceptOnlyFromVortex: Optional[Union[str, tuple]] = None,
         ignoreFromVortex: Optional[Union[str, tuple]] = None,
         requiredPermissions: Optional[PermissionsType] = None,
-        logProcessException: bool = True,
     ) -> None:
         """
         :param filt: The filter to match against payloads
@@ -83,13 +68,8 @@ class PayloadEndpoint:
             the caller's session must hold.  Pass an empty frozenset to
             explicitly declare "no permissions required".  Omitting the
             parameter (``None``) emits a deprecation warning.
-        :param logProcessException: When True, handler exceptions log at ERROR.
-            When False, the same events log at DEBUG with neutral wording.
         """
-        self._requiredPermissions: Optional[PermissionsType] = (
-            requiredPermissions
-        )
-        self._logProcessException = logProcessException
+        self._requiredPermissions: Optional[PermissionsType] = requiredPermissions
 
         if requiredPermissions is None:
             logger.warning(self._NO_PERMISSIONS_WARNING, filt)
@@ -97,13 +77,18 @@ class PayloadEndpoint:
         callableDesc = (
             f"PayloadEndpoint filt={filt} callback={_callableLabel(callable_)}"
         )
-        self._callableAcceptsAccessControlContext = (
-            checkAccessControlContextSignature(
+        self._callableAcceptsAccessControlContext = checkAccessControlContextSignature(
+            callable_,
+            callableDescription=callableDesc,
+        )
+        self._callableAcceptsEndpointPermissions = (
+            checkEndpointPermissionsSignature(
                 callable_,
                 callableDescription=callableDesc,
             )
         )
         checkNoHttpSessionInSignature(callable_, callableDesc)
+        checkNoVortexSessionInSignature(callable_, callableDesc)
 
         self._acceptOnlyFromVortex = acceptOnlyFromVortex
         if isinstance(self._acceptOnlyFromVortex, str):
@@ -178,10 +163,7 @@ class PayloadEndpoint:
             return False
 
         # Filter for the backend vortexes.
-        if (
-            self._acceptOnlyFromVortex
-            and vortexName not in self._acceptOnlyFromVortex
-        ):
+        if self._acceptOnlyFromVortex and vortexName not in self._acceptOnlyFromVortex:
             return False
 
         def removeUnhashable(filt):
@@ -225,14 +207,13 @@ class PayloadEndpoint:
         if not self.check(payloadEnvelope, vortexName):
             return
 
-        if self.PERMITTER and not self.PERMITTER.check(
-            payloadEnvelope, vortexSession
-        ):
+        if self.PERMITTER and not self.PERMITTER.check(payloadEnvelope, vortexSession):
             logger.debug("Permission failed for %s", payloadEnvelope.filt)
             return
 
         # Level 1: Endpoint permission check
         auth = VortexFactory.getAuthenticator()
+        endpointPermissions = None
         if self._requiredPermissions:
             if not auth:
                 logger.error(
@@ -259,16 +240,26 @@ class PayloadEndpoint:
                 )
                 return
 
+        # Level 1 injection: when the callable declares endpointPermissions,
+        # compute the caller's permissions once here at the boundary so
+        # handlers never see the session or the authenticator.
+        if (
+            self._callableAcceptsEndpointPermissions
+            and endpointPermissions is None
+            and auth
+            and vortexSession
+        ):
+            endpointPermissions = yield maybeDeferred(
+                auth.getEndpointPermissions, vortexSession
+            )
+
         # Level 2: Get access control context, but only if the callback uses it.
         # Default to the sentinel so handlers always receive a non-None value
         # with a clear error on attribute access when auth is unavailable.
         accessControlContext = NO_AUTH_ACCESS_CONTROL_CONTEXT
         if self._callableAcceptsAccessControlContext and auth and vortexSession:
             raw_ctx = yield maybeDeferred(
-                auth.getAccessControlContext,
-                vortexSession,
-                vortexName,
-                vortexUuid,
+                auth.getAccessControlContext, vortexSession, vortexName, vortexUuid
             )
             if not isinstance(raw_ctx, VortexAccessControlContextABC):
                 logger.error(
@@ -283,15 +274,16 @@ class PayloadEndpoint:
 
         callable_ = self._wref()
         if callable_:
-            kwargs = dict(
+            kwargs: Dict[str, object] = dict(
                 payloadEnvelope=payloadEnvelope,
                 vortexUuid=vortexUuid,
                 vortexName=vortexName,
                 sendResponse=sendResponse,
-                vortexSession=vortexSession,
             )
             if self._callableAcceptsAccessControlContext:
                 kwargs["accessControlContext"] = accessControlContext
+            if self._callableAcceptsEndpointPermissions:
+                kwargs["endpointPermissions"] = endpointPermissions
             return (yield maybeDeferred(callable_, **kwargs))
         else:
             PayloadIO().remove(self)

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadEndpointTest.py

@@ -54,7 +54,6 @@ class PayloadEndpointPyTest(unittest.TestCase):
             payloadEnvelope=PayloadEnvelope(filt=payload.filt),
             vortexUuid="test",
             vortexName="test",
-            vortexSession=None,
             sendResponse=lambda x: x,
         )
 
@@ -143,7 +142,9 @@ class PayloadEndpointPyTest(unittest.TestCase):
 
         def subScope():
             inst = PayloadEndpointPyTestAssignPayload(self)
-            PayloadEndpoint(filt, inst.process, requiredPermissions=frozenset())
+            PayloadEndpoint(
+                filt, inst.process, requiredPermissions=frozenset()
+            )
 
         self._processEnvelope(payload)
         yield self._flushReactor()

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadEnvelope.py

@@ -57,9 +57,9 @@ class PayloadEnvelope(Jsonable):
     ) -> None:
         Jsonable.__init__(self)
         """Constructor"""
-        assert not (data and encodedPayload), (
-            "You can not pass encodedData and encodedPayload"
-        )
+        assert not (
+            data and encodedPayload
+        ), "You can not pass encodedData and encodedPayload"
 
         self.filt: Dict = {} if filt is None else filt
         self.data: Union[Any, str, None] = data if data else encodedPayload
@@ -75,18 +75,18 @@ class PayloadEnvelope(Jsonable):
     @property
     def encodedPayload(self) -> Optional[str]:
         # self.data could be from VortexJS/Typescript where we allow `str` data
-        assert self.data is None or isinstance(self.data, str), (
-            "Encoded payload is not None or a string"
-        )
+        assert self.data is None or isinstance(
+            self.data, str
+        ), "Encoded payload is not None or a string"
         return self.data
 
     @encodedPayload.setter
     def encodedPayload(self, val: Optional[str]):
         # This value should only be set from users of VortexPy and
         # Payload.toEncodedPayload so we only allow str or None
-        assert val is None or isinstance(val, str), (
-            "Encoded payload is not None or a string"
-        )
+        assert val is None or isinstance(
+            val, str
+        ), "Encoded payload is not None or a string"
         self.data = val
 
     def isEmpty(self):

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadIO.py

@@ -8,6 +8,7 @@
 
 import logging
 from datetime import datetime
+from typing import Optional
 
 import pytz
 from twisted.internet import reactor
@@ -59,8 +60,8 @@ class PayloadIO(object):
         payloadEnvelope: PayloadEnvelope,
         vortexUuid: str,
         vortexName: str,
-        vortexSession,
-        sendResponse: SendVortexMsgResponseCallable,
+        vortexSession=None,
+        sendResponse: Optional[SendVortexMsgResponseCallable] = None,
     ):
         from vortex.VortexFactory import VortexFactory
 
@@ -95,8 +96,8 @@ class PayloadIO(object):
         payloadEnvelope: PayloadEnvelope,
         vortexUuid: str,
         vortexName: str,
-        vortexSession,
-        sendResponse: SendVortexMsgResponseCallable,
+        vortexSession=None,
+        sendResponse: Optional[SendVortexMsgResponseCallable] = None,
     ):
         startDate = datetime.now(pytz.utc)
 
@@ -106,6 +107,10 @@ class PayloadIO(object):
             common function
             """
             try:
+                assert sendResponse is not None, (
+                    "PayloadIO._processLater: sendResponse must be set"
+                    " to respond to an exception"
+                )
                 sendResponse(
                     PayloadEnvelope(
                         filt=payloadEnvelope.filt,
@@ -115,15 +120,8 @@ class PayloadIO(object):
             except Exception as e:
                 logger.exception(e)
 
-            if endpoint._logProcessException:
-                vortexLogFailure(failure, logger)
-                logger.error(payloadEnvelope.filt)
-            else:
-                logger.debug(
-                    "Payload handler response for filt=%s: %s",
-                    payloadEnvelope.filt,
-                    failure.getErrorMessage(),
-                )
+            vortexLogFailure(failure, logger)
+            logger.error(payloadEnvelope.filt)
 
         def callback(value, blocking=False):
             # A blocking call taking more than 100ms is BAD

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadPriority.py

@@ -7,4 +7,5 @@
 # Support : contact@flyingion.com
 
 RPC_PRIORITY = 10
+HEARTBEAT_PRIORITY = 20
 DEFAULT_PRIORITY = 100

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/PayloadResponse.py

@@ -67,7 +67,7 @@ class PayloadResponse(Deferred):
         destVortexUuid: Optional[str] = None,
         timeout: Optional[float] = None,
         resultCheck=True,
-        logTimeoutException=True,
+        logTimeoutError=True,
     ) -> None:
         """Constructor
 
@@ -81,8 +81,6 @@ class PayloadResponse(Deferred):
         :param timeout The timeout to wait for a response
         :param resultCheck Should the response payload.result be checked, if it fails
                     it errback will be called.
-        :param logTimeoutException: When True, payload timeouts log at ERROR.
-                    When False, timeouts log at DEBUG with neutral wording.
         """
         Deferred.__init__(self)
 
@@ -90,7 +88,7 @@ class PayloadResponse(Deferred):
             timeout = self.TIMEOUT
 
         self._resultCheck = resultCheck
-        self._logTimeoutException = logTimeoutException
+        self._logTimeoutError = logTimeoutError
 
         # uuid4 can have collisions
         self._messageId = str(uuid4()) + str(PayloadResponse.__SEQ)
@@ -144,10 +142,8 @@ class PayloadResponse(Deferred):
             self._endpoint.shutdown()
             self._endpoint = None
 
-        if self._logTimeoutException:
+        if self._logTimeoutError:
             logger.error("Timed out for payload %s", self._filt)
-        else:
-            logger.debug("Payload response timed out for %s", self._filt)
         self._status = self.TIMED_OUT
         return failure
 
@@ -157,7 +153,6 @@ class PayloadResponse(Deferred):
         vortexUuid: str,
         vortexName: str,
         sendResponse=None,
-        vortexSession=None,
     ):
         if self._endpoint:
             self._endpoint.shutdown()

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/SerialiseUtil.py

@@ -7,11 +7,10 @@
 # Support : contact@flyingion.com
 
 import decimal
-import enum
 import logging
 from base64 import b64encode, b64decode
 from collections import defaultdict
-from datetime import UTC, datetime, date
+from datetime import datetime, date
 
 import pytz
 from sqlalchemy.orm.collections import InstrumentedList
@@ -124,35 +123,6 @@ def deserialiseWkb(wkbB64Data: str) -> WKBElement:
     return from_shape(shapely.wkb.loads(b64decode(wkbB64Data)))
 
 
-def requireAwareDatetime(value: datetime) -> datetime:
-    """Require a timezone-aware datetime for BSON serialisation."""
-    if value.tzinfo is None:
-        raise TypeError(
-            "datetime must be timezone-aware for BSON serialisation,"
-            f" got naive {value!r}"
-        )
-    return value
-
-
-def datetimeToBson(value: datetime) -> int:
-    """Serialise a datetime to UTC epoch milliseconds for BSON storage."""
-    aware = requireAwareDatetime(value)
-    return int(aware.timestamp() * 1000)
-
-
-def datetimeFromBson(value: object) -> datetime:
-    """Deserialise a BSON datetime field from UTC epoch milliseconds."""
-    if isinstance(value, datetime):
-        return requireAwareDatetime(value)
-    if isinstance(value, int) and not isinstance(value, bool):
-        return datetime.fromtimestamp(value / 1000, tz=UTC)
-    if isinstance(value, float):
-        return datetime.fromtimestamp(value / 1000, tz=UTC)
-    raise TypeError(
-        f"Expected BSON datetime or epoch milliseconds, got {type(value).__name__}"
-    )
-
-
 TYPE_MAP_RAPUI_TO_PY = {
     T_FLOAT: float,
     T_STR: str,
@@ -249,12 +219,13 @@ def fromStr(val: str, typeName: str):
             )
 
         if len(val) <= len("2017-06-06 09:40:37.097068"):
-            raise ValueError(
-                f"datetime string must include timezone information, got {val!r}"
+            logger.warning(
+                "Parsing date time with no timezone: %s Setting TZ to UTC",
+                val,
             )
+            return datetime.strptime(val, ISO8601_NOTZ).replace(tzinfo=pytz.UTC)
 
-        parsed = datetime.strptime(val, ISO8601)
-        return requireAwareDatetime(parsed)
+        return datetime.strptime(val, ISO8601)
 
     if typeName == T_BOOL:
         return val == V_TRUE
@@ -296,13 +267,6 @@ def toRapuiType(value):
     if isinstance(value, PayloadEnvelope):
         return T_RAPUI_PAYLOAD_ENVELOPE
 
-    if isinstance(value, enum.Enum):
-        if isinstance(value, str):
-            return T_STR
-        if isinstance(value, int):
-            return T_INT
-        raise KeyError(value.__class__)
-
     valueClass = value.__class__
 
     return TYPE_MAP_PY_TO_RAPUI[valueClass]

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/Tuple.py

@@ -281,6 +281,12 @@ class TupleField:
     class _Map:
         pass
 
+    def __new__(cls, *args: Any, **kwargs: Any) -> Any:
+        # Tuple classes declare fields as `field: str = TupleField()`.
+        # The Any return keeps those declarations type-correct without
+        # per-field type-ignore comments. Runtime behaviour is unchanged.
+        return super().__new__(cls)
+
     def __init__(
         self,
         defaultValue=None,
@@ -354,12 +360,13 @@ class IntTupleFieldValidator(TupleFieldValidatorABC):
     def validate(self, fieldName: str, value):
         if self._low is not None and value < self._low:
             raise ValueError(
-                f"Field {fieldName}, Value {value} is less than {self._low}"
+                f"Field {fieldName}," f" Value {value} is less than {self._low}"
             )
 
         if self._high is not None and self._high < value:
             raise ValueError(
-                f"Field {fieldName}, Value {value} is greater than {self._high}"
+                f"Field {fieldName},"
+                f" Value {value} is greater than {self._high}"
             )
 
 
@@ -383,13 +390,6 @@ class _TupleToPlainJsonMixin:
             self, includeNones, includeFalse
         )
 
-    def tupleToBsonJsonDict(self, includeNones=True, includeFalse=True):
-        from vortex.TupleBson import TupleBsonConverter
-
-        return TupleBsonConverter.tupleToBsonJsonDict(
-            self, includeNones, includeFalse
-        )
-
     def __tupleToJsonDict(
         self, includeNones=True, includeFalse=True, useShortNames=True
     ):
@@ -513,31 +513,6 @@ class _TupleToPlainJsonMixin:
             jsonDict, TupleClass
         )
 
-    @staticmethod
-    def bsonJsonDictToTupleWithValidation(
-        jsonDict: dict, TupleClass: Type["Tuple"]
-    ) -> "Tuple":
-        """BSON document dict to Tuple with validation.
-
-        This method uses the typings on the fields in a tuple to validate the
-        types of data.
-        """
-        from vortex.TupleBson import TupleBsonConverter
-
-        return TupleBsonConverter.bsonJsonDictToTupleWithValidation(
-            jsonDict, TupleClass
-        )
-
-    @staticmethod
-    def bsonJsonDictToTupleWithValidationResult(
-        jsonDict: dict, TupleClass: Type["Tuple"]
-    ) -> "TupleValidationResult":
-        from vortex.TupleBson import TupleBsonConverter
-
-        return TupleBsonConverter.bsonJsonDictToTupleWithValidationResult(
-            jsonDict, TupleClass
-        )
-
 
 class Tuple(Jsonable, _TupleToPlainJsonMixin, _TupleToSqlaJsonMixin):
     """Tuple

{vortexpy-4.3.5 → vortexpy-6.0.0}/vortex/TuplePolymorphicTupleTypeFieldArgTest.py

@@ -98,8 +98,5 @@ class PolymorphicTupleTypeFieldArgTest(unittest.TestCase):
             any(err.field_path == "concreteType" for err in result.errors)
         )
         self.assertTrue(
-            any(
-                err.message.startswith("At concreteType:")
-                for err in result.errors
-            )
+            any(err.message.startswith("At concreteType:") for err in result.errors)
         )