intersect-sdk-common 0.9.4__tar.gz → 0.9.6__tar.gz

{intersect_sdk_common-0.9.4 → intersect_sdk_common-0.9.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: intersect-sdk-common
-Version: 0.9.4
+Version: 0.9.6
 Summary: Python SDK to interact with INTERSECT
 Keywords: intersect
 Author: Lance Drane, Marshall McDonnell, Seth Hitefield, Andrew Ayres, Gregory Cage, Jesse McGaha, Robert Smith, Gavin Wiggins, Michael Brim, Rick Archibald, Addi Malviya Thakur

intersect_sdk_common-0.9.6/pyproject.toml

@@ -0,0 +1,188 @@
+[project]
+name = "intersect-sdk-common"
+description = "Python SDK to interact with INTERSECT"
+authors = [
+  { name = "Lance Drane", email = "dranelt@ornl.gov" },
+  { name = "Marshall McDonnell", email = "mcdonnellmt@ornl.gov" },
+  { name = "Seth Hitefield", email = "hitefieldsd@ornl.gov" },
+  { name = "Andrew Ayres", email = "ayresaf@ornl.gov" },
+  { name = "Gregory Cage", email = "cagege@ornl.gov" },
+  { name = "Jesse McGaha", email = "mcgahajr@ornl.gov" },
+  { name = "Robert Smith", email = "smithrw@ornl.gov" },
+  { name = "Gavin Wiggins", email = "wigginsg@ornl.gov" },
+  { name = "Michael Brim", email = "brimmj@ornl.gov" },
+  { name = "Rick Archibald", email = "archibaldrk@ornl.gov" },
+  { name = "Addi Malviya Thakur", email = "malviyaa@ornl.gov" },
+]
+readme = "README.md"
+license = { text = "BSD-3-Clause" }
+requires-python = ">=3.10,<4.0"
+keywords = ["intersect"]
+version = "0.9.6"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+  "pydantic>=2.7.0",
+  "paho-mqtt>=2.1.0,<3.0.0",
+  "pika>=1.3.2,<2.0.0",
+  "minio>=7.2.3",
+]
+
+[dependency-groups]
+dev = [
+  "pre-commit>=3.3.1",
+  "ruff==0.12.7",
+  "mypy>=1.10.0",
+  "codespell>=2.3.0",
+  "pytest>=7.3.2",
+  "pytest-cov>=4.1.0",
+  "httpretty>=1.1.4",
+]
+
+[build-system]
+requires = ["uv_build>=0.10.2,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 100
+format = { quote-style = 'single' }
+
+[tool.ruff.lint]
+isort = { known-first-party = ['src'] }
+pydocstyle = { convention = 'google' }
+flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'double' }
+mccabe = { max-complexity = 20 }
+pylint = { max-args = 10, max-branches = 20, max-returns = 15, max-statements = 75 }
+# pyflakes and the relevant pycodestyle rules are already configured
+extend-select = [
+  'C90',   # mccabe complexity
+  'I',     # isort
+  'N',     # pep8-naming
+  'D',     # pydocstyle
+  'UP',    # pyupgrade
+  'YTT',   # flake8-2020
+  'ANN',   # flake8-annotations
+  'ASYNC', # flake8-async
+  'S',     # flake8-bandit
+  'BLE',   # flake8-blind-except
+  'B',     # flake8-bugbear
+  'A',     # flake8-builtins
+  'COM',   # flake8-commas
+  'C4',    # flake8-comprehensions
+  'DTZ',   # flake8-datetimez
+  'T10',   # flake8-debugger
+  'EM',    # flake8-error-message
+  'FA',    # flake8-future-annotations
+  'ISC',   # flake8-implicit-string-concat
+  'ICN',   # flake8-import-conventions
+  'G',     # flake8-logging-format
+  'INP',   # flake8-no-pep420
+  'PIE',   # flake8-PIE
+  'T20',   # flake8-T20
+  'PYI',   # flake8-pyi
+  'PT',    # flake8-pytest-style
+  'Q',     # flake8-quotes
+  'RSE',   # flake8-raise
+  'RET',   # flake8-return
+  'SLF',   # flake8-self
+  'SLOT',  # flake8-slots
+  'SIM',   # flake8-simplify
+  'TC',    # flake8-type-checking
+  'ARG',   # flake8-unused-arguments
+  'PTH',   # flake8-use-pathlib
+  'PGH',   # pygrep-hooks
+  'PL',    # pylint
+  'TRY',   # tryceratops
+  'FLY',   # flynt
+  'RUF',   # RUFF additional rules
+  'INT',   # flake8-gettext
+]
+# If you're seeking to disable a rule, first consider whether the rule is overbearing, or if it should only be turned off for your usecase.
+ignore = [
+  'COM812',  # formatter, handled by Ruff format
+  'ISC001',  # formatter, handled by Ruff format
+  'SIM105',  # "with contextlib.suppress():" is slower than try-except-pass
+  'ANN401',  # allow explicit "Any" typing, use with care
+  'PLR2004', # allow "magic numbers"
+]
+
+[tool.ruff.lint.flake8-type-checking]
+runtime-evaluated-base-classes = ["pydantic.BaseModel"]
+runtime-evaluated-decorators = [
+  "pydantic.dataclasses.dataclass",
+  "pydantic.validate_call",
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+'__init__.py' = [
+  'F401',  # __init__.py commonly has unused imports
+  'TC004', # do lazy imports when importing from the base module
+]
+'docs/*' = [
+  'D',      # the documentation folder does not need documentation
+  'INP001', # docs are not a namespace package
+]
+'tests/*' = [
+  'S101',   # allow assert statements in tests
+  'S106',   # don't care about credentials in tests
+  'S311',   # don't care about cryptographic security in tests
+  'SLF001', # allow private member access in tests
+  'ANN',    # tests in general don't need types, unless they are runtime types.
+  'ARG',    # allow unused parameters in tests
+  'D',      # ignore documentation in tests
+  'RUF012', # permit "mutable" class attributes to not be annotated with typing.ClassVar (these shouldn't be mutated anyways...)
+]
+
+# see https://mypy.readthedocs.io/en/stable/config_file.html for a complete reference
+[tool.mypy]
+strict = true
+ignore_missing_imports = true       # don't require typing for library stubs if they don't exist
+disallow_untyped_decorators = false # this is needed for library decorator compatibility, i.e. "retrying"
+plugins = ["pydantic.mypy"]
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+warn_untyped_fields = true
+
+[tool.pytest.ini_options]
+log_cli = true
+addopts = "-ra"
+
+[tool.coverage.report]
+omit = [
+  '*__init__*', # __init__ files should just re-export other classes and functions
+]
+exclude_also = [
+  'pragma: no-cover',              # standard
+  'if (typing\\.)?TYPE_CHECKING:', # type checking blocks are not executed in coverage, but we don't care
+  '@(abc\\.)?abstractmethod',      # don't try to cover abstract methods
+  "class .*\\bProtocol\\):",       # don't cover protocol classes (similar to abstract classes)
+  'raise NotImplementedError',     # it's not implemented so shouldn't be covered
+  'except.* ImportError',          # these are usually used to throw a "friendlier" error and are not really worth testing
+]
+
+
+#[project.scripts]
+#test-all = "pytest tests/ --cov=src/intersect_sdk_common/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
+#test-all-debug = "pytest tests/ --cov=src/intersect_sdk_common/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml -s"
+#test-unit = "pytest tests/unit --cov=src/intersect_sdk_common/"
+#test-e2e = "pytest tests/e2e --cov=src/intersect_sdk_common/"
+#lint-docs = "sphinx-build -W --keep-going docs docs/_build"
+#lint-format = "ruff format"
+#lint-ruff = "ruff check --fix"
+#lint-mypy = "mypy src/intersect_sdk_common/"
+#lint-spelling = "codespell -w docs examples src tests *.md -S docs/_build"
+
+[tool.codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = '.git*,*.lock,.venv,.*cache/*,./docs/_build/*'
+check-hidden = true
+# ignore-regex = ''
+# ignore-words-list = ''

{intersect_sdk_common-0.9.4 → intersect_sdk_common-0.9.6}/src/intersect_sdk_common/__init__.py

@@ -21,8 +21,17 @@ if TYPE_CHECKING:
     from .control_plane.definitions import MessageCallback
     from .core_definitions import IntersectDataHandler, IntersectMimeType
     from .data_plane.data_plane_manager import DataPlaneManager
-    from .exceptions import IntersectApplicationError, IntersectError, IntersectSetupError
-    from .version import __version__, intersect_sdk_version_info, intersect_sdk_version_string
+    from .exceptions import (
+        IntersectApplicationError,
+        IntersectError,
+        IntersectSetupError,
+    )
+    from .utils.version_resolver import resolve_user_version
+    from .version import (
+        __version__,
+        intersect_sdk_version_info,
+        intersect_sdk_version_string,
+    )
 
 __all__ = (
     'ControlPlaneConfig',
@@ -41,6 +50,7 @@ __all__ = (
     '__version__',
     'intersect_sdk_version_info',
     'intersect_sdk_version_string',
+    'resolve_user_version',
 )
 
 # PEP 562 stuff: do lazy imports for people who just want to import from the top-level module
@@ -62,6 +72,7 @@ __lazy_imports = {
     '__version__': '.version',
     'intersect_sdk_version_info': '.version',
     'intersect_sdk_version_string': '.version',
+    'resolve_user_version': '.utils.version_resolver',
 }
 
 

{intersect_sdk_common-0.9.4 → intersect_sdk_common-0.9.6}/src/intersect_sdk_common/control_plane/control_plane_manager.py

@@ -10,14 +10,17 @@ from .brokers.broker_client import BrokerClient
 from .definitions import MessageCallback
 from .topic_handler import TopicHandler
 
-_CHANNEL_REGEX = re.compile(r'^[a-zA-Z0-9*/-]+[a-zA-Z0-9*#/-]$')
+_CHANNEL_REGEX = re.compile(r'^[a-zA-Z0-9_*/-]+[a-zA-Z0-9_*#/-]$')
 """Allow for these patterns:
 
 - alphanumeric characters
 - hyphens
+- underscores
 - `/` (topic separator; note that this is '.' on the broker)
 - `*` (wildcard for exactly one word)
 - `#` (wildcard for any number of words, but can ONLY appear at the end of the topic string, see section 4.7.1.2 at https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718107)
+
+This should be permissive relative to other patterns. You must cover system/service/hierarchy regexes, capability regexes, and event name regexes.
 """
 
 
@@ -75,7 +78,11 @@ class ControlPlaneManager:
         self._wildcards: dict[str, TopicHandler] = {}
 
     def add_subscription_channel(
-        self, channel: str, callbacks: set[MessageCallback], persist: bool, queue_name: str
+        self,
+        channel: str,
+        callbacks: set[MessageCallback],
+        persist: bool,
+        queue_name: str,
     ) -> None:
         """Start listening for messages on a channel on all configured brokers.
 
@@ -167,7 +174,9 @@ class ControlPlaneManager:
                 return wildcard, topic_handler
         return None
 
-    def get_all_subscription_channels(self) -> itertools.chain[tuple[str, TopicHandler]]:
+    def get_all_subscription_channels(
+        self,
+    ) -> itertools.chain[tuple[str, TopicHandler]]:
         """Get all subscription channels, including wildcard channels.
 
         This function is safe to call from the broker clients, as it does not mutate state.

{intersect_sdk_common-0.9.4 → intersect_sdk_common-0.9.6}/src/intersect_sdk_common/control_plane/topic_handler.py

@@ -23,7 +23,10 @@ class TopicHandler:
     """If this is a wildcard topic, the regex pattern to match incoming topics against (if no wildcards, this will be None)."""
 
     def __init__(
-        self, topic_persist: bool, queue_name: str, regex_pattern: str | None = None
+        self,
+        topic_persist: bool,
+        queue_name: str,
+        regex_pattern: str | None = None,
     ) -> None:
         """Initialize a TopicHandler instance.
 
@@ -37,14 +40,15 @@ class TopicHandler:
         self.queue_name = queue_name
 
         if regex_pattern:
+            # the generated regex must be permissive and allow any non-special characters _CHANNEL_REGEX (ControlPlaneManager) allows
             regex_builder = ['^']
             for char in regex_pattern:
                 if char == '*':
                     # match a single word (do not include the separator)
-                    regex_builder.append('[a-zA-Z0-9-]+')
+                    regex_builder.append('[a-zA-Z0-9_-]+')
                 elif char == '#':
                     # match any sequence of 0 or more words (make sure to allow for the separator)
-                    regex_builder.append('[a-zA-Z0-9/-]*')
+                    regex_builder.append('[a-zA-Z0-9/_-]*')
                 elif char == '/':
                     # in-memory topics use '/' as the separator, it is the protocol handler's responsibility to convert topics to use '/' as the separator
                     regex_builder.append('/')

intersect_sdk_common-0.9.6/src/intersect_sdk_common/utils/version_resolver.py

@@ -0,0 +1,70 @@
+"""Handles version resolution via semantic versioning logic."""
+
+from .. import (
+    IntersectDataHandler,
+    intersect_sdk_version_info,
+    intersect_sdk_version_string,
+)
+from ..logger import logger
+
+
+def _resolve_user_version(
+    their_version: str,
+    their_source: str,
+    their_data_handler: IntersectDataHandler,
+    our_version: str,
+    our_version_info: tuple[int, int, int],
+) -> bool:
+    """Function which handles version resolution information.
+
+    Separated into private function for testing purposes
+    """
+    their_version_info = [int(x) for x in their_version.split('.')]
+
+    # logging rules: log "error" if it's definitely our fault, "warning" if it _might_ be our fault
+    if len(their_version_info) < 3:
+        logger.warning(f'Invalid version {their_version} received')
+        return False
+
+    if their_version_info[0] != our_version_info[0]:
+        logger.warning(
+            f'Problem with source {their_source}: Major version incompatibility between our SDK version {our_version} and their SDK version {their_version}'
+        )
+        return False
+    if our_version_info[0] == 0 and our_version_info[1] != their_version_info[1]:
+        logger.warning(
+            f'Problem with source {their_source}: Pre-release minor version incompatibility between our SDK version {our_version} and their SDK version {their_version}'
+        )
+        return False
+    if their_data_handler.value not in [e.value for e in IntersectDataHandler]:
+        logger.error(
+            f'Problem with source {their_source}: This adapter cannot handle data handler with code "{their_data_handler}", please upgrade to the latest intersect-sdk version.'
+        )
+        return False
+    # NOTE: consider implementing a content-type check here as well
+
+    return True
+
+
+def resolve_user_version(
+    their_version: str,
+    their_source: str,
+    their_data_handler: IntersectDataHandler,
+) -> bool:
+    """This function handles all version compatibilities between our SDK version and an incoming message's SDK version.
+
+    Params
+      their_version - version information from headers
+      their_source - source information from headers
+      their_data_handler - data handler information from headers
+
+    Returns:
+      True if version resolution successful, false otherwise
+    """
+    return _resolve_user_version(
+        their_version,
+        their_source,
+        their_data_handler,
+        our_version=intersect_sdk_version_string,
+        our_version_info=intersect_sdk_version_info,
+    )

intersect_sdk_common-0.9.4/pyproject.toml

@@ -1,185 +0,0 @@
-[project]
-name = "intersect-sdk-common"
-description = "Python SDK to interact with INTERSECT"
-authors = [
-    { name = "Lance Drane", email = "dranelt@ornl.gov" },
-    { name = "Marshall McDonnell", email = "mcdonnellmt@ornl.gov" },
-    { name = "Seth Hitefield", email = "hitefieldsd@ornl.gov" },
-    { name = "Andrew Ayres", email = "ayresaf@ornl.gov" },
-    { name = "Gregory Cage", email = "cagege@ornl.gov" },
-    { name = "Jesse McGaha", email = "mcgahajr@ornl.gov" },
-    { name = "Robert Smith", email = "smithrw@ornl.gov" },
-    { name = "Gavin Wiggins", email = "wigginsg@ornl.gov" },
-    { name = "Michael Brim", email = "brimmj@ornl.gov" },
-    { name = "Rick Archibald", email = "archibaldrk@ornl.gov" },
-    { name = "Addi Malviya Thakur", email = "malviyaa@ornl.gov" },
-]
-readme = "README.md"
-license = { text = "BSD-3-Clause" }
-requires-python = ">=3.10,<4.0"
-keywords = ["intersect"]
-version = "0.9.4"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-]
-dependencies = [
-    "pydantic>=2.7.0",
-    "paho-mqtt>=2.1.0,<3.0.0",
-    "pika>=1.3.2,<2.0.0",
-    "minio>=7.2.3",
-]
-
-[dependency-groups]
-dev = [
-    "pre-commit>=3.3.1",
-    "ruff==0.12.7",
-    "mypy>=1.10.0",
-    "codespell>=2.3.0",
-    "pytest>=7.3.2",
-    "pytest-cov>=4.1.0",
-    "httpretty>=1.1.4",
-]
-
-[build-system]
-requires = ["uv_build>=0.10.2,<0.11.0"]
-build-backend = "uv_build"
-
-[tool.ruff]
-line-length = 100
-format = { quote-style = 'single' }
-
-[tool.ruff.lint]
-isort = { known-first-party = ['src'] }
-pydocstyle = { convention = 'google' }
-flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'double' }
-mccabe = { max-complexity = 20 }
-pylint = { max-args = 10, max-branches = 20, max-returns = 15, max-statements = 75 }
-# pyflakes and the relevant pycodestyle rules are already configured
-extend-select = [
-    'C90',   # mccabe complexity
-    'I',     # isort
-    'N',     # pep8-naming
-    'D',     # pydocstyle
-    'UP',    # pyupgrade
-    'YTT',   # flake8-2020
-    'ANN',   # flake8-annotations
-    'ASYNC', # flake8-async
-    'S',     # flake8-bandit
-    'BLE',   # flake8-blind-except
-    'B',     # flake8-bugbear
-    'A',     # flake8-builtins
-    'COM',   # flake8-commas
-    'C4',    # flake8-comprehensions
-    'DTZ',   # flake8-datetimez
-    'T10',   # flake8-debugger
-    'EM',    # flake8-error-message
-    'FA',    # flake8-future-annotations
-    'ISC',   # flake8-implicit-string-concat
-    'ICN',   # flake8-import-conventions
-    'G',     # flake8-logging-format
-    'INP',   # flake8-no-pep420
-    'PIE',   # flake8-PIE
-    'T20',   # flake8-T20
-    'PYI',   # flake8-pyi
-    'PT',    # flake8-pytest-style
-    'Q',     # flake8-quotes
-    'RSE',   # flake8-raise
-    'RET',   # flake8-return
-    'SLF',   # flake8-self
-    'SLOT',  # flake8-slots
-    'SIM',   # flake8-simplify
-    'TC',   # flake8-type-checking
-    'ARG',   # flake8-unused-arguments
-    'PTH',   # flake8-use-pathlib
-    'PGH',   # pygrep-hooks
-    'PL',    # pylint
-    'TRY',   # tryceratops
-    'FLY',   # flynt
-    'RUF',   # RUFF additional rules
-    'INT',   # flake8-gettext
-]
-# If you're seeking to disable a rule, first consider whether the rule is overbearing, or if it should only be turned off for your usecase.
-ignore = [
-    'COM812',  # formatter, handled by Ruff format
-    'ISC001',  # formatter, handled by Ruff format
-    'SIM105',  # "with contextlib.suppress():" is slower than try-except-pass
-    'ANN401',  # allow explicit "Any" typing, use with care
-    'PLR2004', # allow "magic numbers"
-]
-
-[tool.ruff.lint.flake8-type-checking]
-runtime-evaluated-base-classes = ["pydantic.BaseModel"]
-runtime-evaluated-decorators = ["pydantic.dataclasses.dataclass","pydantic.validate_call"]
-
-[tool.ruff.lint.extend-per-file-ignores]
-'__init__.py' = [
-    'F401', # __init__.py commonly has unused imports
-    'TC004', # do lazy imports when importing from the base module
-]
-'docs/*' = [
-    'D',      # the documentation folder does not need documentation
-    'INP001', # docs are not a namespace package
-]
-'tests/*' = [
-    'S101',   # allow assert statements in tests
-    'S106',   # don't care about credentials in tests
-    'S311',   # don't care about cryptographic security in tests
-    'SLF001', # allow private member access in tests
-    'ANN',    # tests in general don't need types, unless they are runtime types.
-    'ARG',    # allow unused parameters in tests
-    'D',      # ignore documentation in tests
-    'RUF012', # permit "mutable" class attributes to not be annotated with typing.ClassVar (these shouldn't be mutated anyways...)
- ]
-
-# see https://mypy.readthedocs.io/en/stable/config_file.html for a complete reference
-[tool.mypy]
-strict = true
-ignore_missing_imports = true       # don't require typing for library stubs if they don't exist
-disallow_untyped_decorators = false # this is needed for library decorator compatibility, i.e. "retrying"
-plugins = ["pydantic.mypy"]
-
-[tool.pydantic-mypy]
-init_forbid_extra = true
-init_typed = true
-warn_required_dynamic_aliases = true
-warn_untyped_fields = true
-
-[tool.pytest.ini_options]
-log_cli = true
-addopts = "-ra"
-
-[tool.coverage.report]
-omit = [
-    '*__init__*', # __init__ files should just re-export other classes and functions
-]
-exclude_also = [
-  'pragma: no-cover',              # standard
-  'if (typing\\.)?TYPE_CHECKING:', # type checking blocks are not executed in coverage, but we don't care
-  '@(abc\\.)?abstractmethod',      # don't try to cover abstract methods
-  "class .*\\bProtocol\\):",       # don't cover protocol classes (similar to abstract classes)
-  'raise NotImplementedError',     # it's not implemented so shouldn't be covered
-  'except.* ImportError',          # these are usually used to throw a "friendlier" error and are not really worth testing
-]
-
-
-#[project.scripts]
-#test-all = "pytest tests/ --cov=src/intersect_sdk_common/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
-#test-all-debug = "pytest tests/ --cov=src/intersect_sdk_common/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml -s"
-#test-unit = "pytest tests/unit --cov=src/intersect_sdk_common/"
-#test-e2e = "pytest tests/e2e --cov=src/intersect_sdk_common/"
-#lint-docs = "sphinx-build -W --keep-going docs docs/_build"
-#lint-format = "ruff format"
-#lint-ruff = "ruff check --fix"
-#lint-mypy = "mypy src/intersect_sdk_common/"
-#lint-spelling = "codespell -w docs examples src tests *.md -S docs/_build"
-
-[tool.codespell]
-# Ref: https://github.com/codespell-project/codespell#using-a-config-file
-skip = '.git*,*.lock,.venv,.*cache/*,./docs/_build/*'
-check-hidden = true
-# ignore-regex = ''
-# ignore-words-list = ''