symphony_bdk_python 2.11.0b0__tar.gz → 2.11.2__tar.gz

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/PKG-INFO

@@ -1,8 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: symphony_bdk_python
-Version: 2.11.0b0
+Version: 2.11.2
 Summary: Symphony Bot Development Kit for Python
 License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
 Author: Symphony Platform Solutions
 Author-email: symphony@finos.org
 Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
@@ -12,9 +14,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: PyJWT (>=2.10.0,<3.0.0)
 Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
-Requires-Dist: cryptography (>=44.0.1,<45.0.0)
+Requires-Dist: cryptography (>=46.0.0,<47.0.0)
 Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
 Requires-Dist: docutils (==0.16)
 Requires-Dist: nulltype (>=2.3.1,<3.0.0)
@@ -34,7 +37,7 @@ Description-Content-Type: text/markdown
 
 # Symphony BDK for Python
 
-This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://developers.symphony.com/restapi/reference).
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
 
 ## Project Overview
 
@@ -51,9 +54,23 @@ Symphony BDK for Python provides tools for building bots and integrating with Sy
 - Install dependencies: `poetry install`
 - Build the package: `poetry build`
 - Run tests: `poetry run pytest`
-- Perform a pylint scan locally: `poetry run pylint <module_name>`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
 - Generate documentation locally: `cd docsrc && make html`
 
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
 ### Verification
 Verify the successful installation by running any of the following commands:
 ```

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/README.md

@@ -6,7 +6,7 @@
 
 # Symphony BDK for Python
 
-This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://developers.symphony.com/restapi/reference).
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
 
 ## Project Overview
 
@@ -23,9 +23,23 @@ Symphony BDK for Python provides tools for building bots and integrating with Sy
 - Install dependencies: `poetry install`
 - Build the package: `poetry build`
 - Run tests: `poetry run pytest`
-- Perform a pylint scan locally: `poetry run pylint <module_name>`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
 - Generate documentation locally: `cd docsrc && make html`
 
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
 ### Verification
 Verify the successful installation by running any of the following commands:
 ```

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "symphony_bdk_python"
-version = "2.11.0-beta"
+version = "2.11.2"
 license = "Apache-2.0"
 description = "Symphony Bot Development Kit for Python"
 readme = "README.md"
@@ -19,14 +19,13 @@ urllib3 = ">=2.5.0,<3"
 aiohttp = "^3.12.14"
 pyyaml = "^6.0"
 PyJWT = "^2.10.0"
-cryptography = "^44.0.1"
+cryptography = "^46.0.0"
 tenacity = "^8.0.1"
 defusedxml = "^0.7.1"
 docutils = "0.16"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.3"
-pylint = "^2.6.0"
 pytest-cov = "^5.0.0"
 pytest-asyncio = "^0.24.0"
 Sphinx = "^4.4.0"
@@ -38,6 +37,8 @@ safety = "^2.3.5"
 setuptools = "^79.0.0"
 liccheck = "^0.9.2"
 coverage = {version = "^6.0b1", extras = ["toml"]}
+ruff = "^0.12.8"
+pre-commit = "^4.3.0"
 
 [tool.poetry.requires-plugins]
 poetry-plugin-export = ">=1.8"
@@ -49,6 +50,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.pytest.ini_options]
 addopts = "--junitxml=test-results/junit.xml --cov --cov-report=html"
 testpaths = ["tests"]
+markers = ["e2e: marks tests as end-to-end tests"]
 norecursedirs = ["*.egg", ".*", "build", "dist", "venv", "legacy"]
 junit_logging = "all"
 
@@ -67,5 +69,26 @@ authorized_licenses = [
     "MIT",
     "Apache Software",
     "Apache-2.0",
-    "Python Software Foundation"
+    "Python Software Foundation",
+    "Apache-2.0 AND MIT",
+    "PSF-2.0"
 ]
+
+
+
+[tool.ruff]
+include = ["pyproject.toml", "symphony/**/*.py", "examples/**/*.py"]
+exclude = [
+    "symphony/bdk/gen",
+]
+
+target-version = "py39"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/__init__.py

@@ -4,6 +4,7 @@ There is an outstanding issue with aiohttp and Python 3.8+ on Windows. This affe
 proxy on Windows with Python 3.8+. As known workaround, the following code is meant to avoid this issue by detecting the
 operating system and setting WindowsSelectorEventLoopPolicy as event loop policy.
 """
+
 import asyncio
 import os
 

symphony_bdk_python-2.11.2/symphony/bdk/core/activity/__init__.py

@@ -0,0 +1 @@
+"""Package containing all modules related to the Activity API"""

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/api.py

@@ -1,10 +1,10 @@
 from abc import ABC, abstractmethod
-from typing import TypeVar, Generic
+from typing import Generic, TypeVar
 
 from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
 
-C = TypeVar('C')  # Context type
-E = TypeVar('E')  # Event type
+C = TypeVar("C")  # Context type
+E = TypeVar("E")  # Event type
 
 
 class ActivityContext(Generic[E]):
@@ -60,7 +60,7 @@ class AbstractActivity(ABC, Generic[C]):
         """
 
     def before_matcher(self, context: C):
-        """ This callback can be used to prepare :py:class:`ActivityContext` before actually processing the `matches`
+        """This callback can be used to prepare :py:class:`ActivityContext` before actually processing the `matches`
         method.
 
         :param context: an instance of :py:class:`ActivityContext`

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/command.py

@@ -14,11 +14,15 @@ logger = logging.getLogger(__name__)
 
 
 class CommandContext(ActivityContext[V4MessageSent]):
-    """Default implementation of the :py:class:`ActivityContext` handled by the :py:class:`CommandActivity`.
-    """
-
-    def __init__(self, initiator: V4Initiator, source_event: V4MessageSent, bot_display_name: str,
-                 bot_user_id: int = None):
+    """Default implementation of the :py:class:`ActivityContext` handled by the :py:class:`CommandActivity`."""
+
+    def __init__(
+        self,
+        initiator: V4Initiator,
+        source_event: V4MessageSent,
+        bot_display_name: str,
+        bot_user_id: int = None,
+    ):
         self._message_id = source_event.message.message_id
         self._stream_id = source_event.message.stream.stream_id
         self._bot_display_name = bot_display_name
@@ -56,8 +60,7 @@ class CommandContext(ActivityContext[V4MessageSent]):
 
 
 class CommandActivity(AbstractActivity[CommandContext]):
-    """A command activity corresponds to any message sent in a chat where the bot is part of.
-    """
+    """A command activity corresponds to any message sent in a chat where the bot is part of."""
 
     def __init__(self):
         self._bot_user_id = None
@@ -103,15 +106,20 @@ class SlashCommandActivity(CommandActivity):
 
         if self._requires_mention_bot:
             # The user id will be loaded in runtime in a lazy way
-            self._command_pattern.prepend_token(MatchingUserIdMentionToken(lambda: self.bot_user_id))
+            self._command_pattern.prepend_token(
+                MatchingUserIdMentionToken(lambda: self.bot_user_id)
+            )
 
     @property
     def name(self) -> str:
         return self._name
 
     def build_command_description(self) -> str:
-        return self._description + " (mention required)" if self._requires_mention_bot \
+        return (
+            self._description + " (mention required)"
+            if self._requires_mention_bot
             else self._description + " (mention not required)"
+        )
 
     def matches(self, context: CommandContext) -> bool:
         match_result = self._command_pattern.get_match_result(context.source_event.message)

symphony_bdk_python-2.11.2/symphony/bdk/core/activity/exception.py

@@ -0,0 +1,5 @@
+"""Module containing all activities related exception."""
+
+
+class FatalActivityExecutionException(Exception):
+    """A Fatal error occurred during an activity execution flow"""

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/help_command.py

@@ -18,5 +18,6 @@ class HelpCommand(SlashCommandActivity):
         help_message = ""
         for act in activity_list:
             help_message += "<li>" + act.name + " - " + act.build_command_description() + "</li>"
-        await self._bdk.messages().send_message(context.stream_id,
-                                                "<messageML><ul>" + help_message + "</ul></messageML>")
+        await self._bdk.messages().send_message(
+            context.stream_id, "<messageML><ul>" + help_message + "</ul></messageML>"
+        )

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/arguments.py

@@ -1,4 +1,4 @@
-from symphony.bdk.core.activity.parsing.message_entities import Mention, Hashtag, Cashtag
+from symphony.bdk.core.activity.parsing.message_entities import Cashtag, Hashtag, Mention
 
 
 class Arguments:

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/command_token.py

@@ -1,5 +1,4 @@
-"""This module gathers all token classes that we can use for {@link SlashCommandPattern}
-"""
+"""This module gathers all token classes that we can use for {@link SlashCommandPattern}"""
 
 import re
 from abc import ABC, abstractmethod
@@ -151,5 +150,7 @@ class MatchingUserIdMentionToken(AbstractCommandToken):
         return isinstance(token, Mention) and token.user_id == self._matching_user_id_supplier()
 
     def __eq__(self, o: object) -> bool:
-        return isinstance(o, MatchingUserIdMentionToken) and \
-               self._matching_user_id_supplier() == o._matching_user_id_supplier()
+        return (
+            isinstance(o, MatchingUserIdMentionToken)
+            and self._matching_user_id_supplier() == o._matching_user_id_supplier()
+        )

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/input_tokenizer.py

@@ -23,7 +23,7 @@ class InputTokenizer:
         :param message: message to be tokenized.
         """
         self._document = fromstring(message.message)
-        json_data = message.data if hasattr(message, 'data') and message.data else "{}"
+        json_data = message.data if hasattr(message, "data") and message.data else "{}"
         self._data_node = json.loads(json_data)
         self._buffer = ""
         self._tokens = []
@@ -43,7 +43,7 @@ class InputTokenizer:
         if self._is_entity_node(root):
             self._parse_buffer()
             entity_id = root.attrib[InputTokenizer.data_entity_id]
-            entity_type = self._data_node[entity_id]['type']
+            entity_type = self._data_node[entity_id]["type"]
             if self._is_entity_type_supported(entity_type):
                 self._parse_entity_node(entity_id, root)
             else:
@@ -91,14 +91,22 @@ class InputTokenizer:
         :param root: root of the xml document
         :return: Whether the node is a known entity.
         """
-        if root.tag == "span" and "class" in root.attrib and root.attrib["class"] == "entity" \
-                and InputTokenizer.data_entity_id in root.attrib:
+        if (
+            root.tag == "span"
+            and "class" in root.attrib
+            and root.attrib["class"] == "entity"
+            and InputTokenizer.data_entity_id in root.attrib
+        ):
             return root.attrib[InputTokenizer.data_entity_id] in self._data_node
         return False
 
     @staticmethod
     def _is_entity_type_supported(entity_type):
-        return entity_type in ["org.symphonyoss.taxonomy", "org.symphonyoss.fin.security", "com.symphony.user.mention"]
+        return entity_type in [
+            "org.symphonyoss.taxonomy",
+            "org.symphonyoss.fin.security",
+            "com.symphony.user.mention",
+        ]
 
     @property
     def tokens(self):

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/match_result.py

@@ -24,6 +24,8 @@ class MatchResult:
         return self._arguments
 
     def __eq__(self, other):
-        return isinstance(other, MatchResult) \
-               and self._is_matching == other._is_matching \
-               and self._arguments == other._arguments
+        return (
+            isinstance(other, MatchResult)
+            and self._is_matching == other._is_matching
+            and self._arguments == other._arguments
+        )

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/message_entities.py

@@ -1,5 +1,4 @@
-"""This module gathers all entities that we can find in a message.
-"""
+"""This module gathers all entities that we can find in a message."""
 
 
 class Cashtag:
@@ -67,7 +66,9 @@ class Mention:
         return self._user_id
 
     def __eq__(self, o: object) -> bool:
-        return isinstance(o, Mention) \
-               and self._text == o._text \
-               and self._user_display_name == o._user_display_name \
-               and self._user_id == o._user_id
+        return (
+            isinstance(o, Mention)
+            and self._text == o._text
+            and self._user_display_name == o._user_display_name
+            and self._user_id == o._user_id
+        )

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/parsing/slash_command_pattern.py

@@ -1,7 +1,13 @@
 import re
 
-from symphony.bdk.core.activity.parsing.command_token import StaticCommandToken, StringArgumentCommandToken, \
-    HashArgumentCommandToken, CashArgumentCommandToken, MentionArgumentCommandToken, ArgumentCommandToken
+from symphony.bdk.core.activity.parsing.command_token import (
+    ArgumentCommandToken,
+    CashArgumentCommandToken,
+    HashArgumentCommandToken,
+    MentionArgumentCommandToken,
+    StaticCommandToken,
+    StringArgumentCommandToken,
+)
 from symphony.bdk.core.activity.parsing.input_tokenizer import InputTokenizer
 from symphony.bdk.core.activity.parsing.match_result import MatchResult
 from symphony.bdk.gen.agent_model.v4_message import V4Message
@@ -23,10 +29,15 @@ class SlashCommandPattern:
     whitespace_pattern = re.compile(r"\s+")
 
     def __init__(self, pattern: str):
-        self._tokens = [self.create_token(pattern) for pattern in
-                        re.split(SlashCommandPattern.whitespace_pattern, pattern) if pattern]
-
-        filtered_tokens_arg_names = list(filter(lambda a: a is not None, map(self.get_arg_name, self._tokens)))
+        self._tokens = [
+            self.create_token(pattern)
+            for pattern in re.split(SlashCommandPattern.whitespace_pattern, pattern)
+            if pattern
+        ]
+
+        filtered_tokens_arg_names = list(
+            filter(lambda a: a is not None, map(self.get_arg_name, self._tokens))
+        )
         if not len(set(filtered_tokens_arg_names)) == len(filtered_tokens_arg_names):
             raise ValueError("Argument names must be unique")
 
@@ -67,7 +78,11 @@ class SlashCommandPattern:
         """
         input_tokenizer = InputTokenizer(message)
         input_tokens = input_tokenizer.tokens
-        return MatchResult(True, self.get_arguments(input_tokens)) if self.matches(input_tokens) else MatchResult(False)
+        return (
+            MatchResult(True, self.get_arguments(input_tokens))
+            if self.matches(input_tokens)
+            else MatchResult(False)
+        )
 
     def matches(self, input_tokens):
         """

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/activity/registry.py

@@ -1,16 +1,18 @@
 import logging
 
-from symphony.bdk.gen.agent_model.v4_user_joined_room import V4UserJoinedRoom
-
 from symphony.bdk.core.activity.api import AbstractActivity
 from symphony.bdk.core.activity.command import CommandActivity, CommandContext, SlashCommandActivity
-from symphony.bdk.core.activity.form import FormReplyContext, FormReplyActivity
-from symphony.bdk.core.activity.user_joined_room import UserJoinedRoomContext, UserJoinedRoomActivity
+from symphony.bdk.core.activity.form import FormReplyActivity, FormReplyContext
+from symphony.bdk.core.activity.user_joined_room import (
+    UserJoinedRoomActivity,
+    UserJoinedRoomContext,
+)
 from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
 from symphony.bdk.core.service.session.session_service import SessionService
 from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
 from symphony.bdk.gen.agent_model.v4_message_sent import V4MessageSent
 from symphony.bdk.gen.agent_model.v4_symphony_elements_action import V4SymphonyElementsAction
+from symphony.bdk.gen.agent_model.v4_user_joined_room import V4UserJoinedRoom
 
 logger = logging.getLogger(__name__)
 
@@ -22,6 +24,7 @@ def _initialize_display_name(func):
     :param func: the function to be decorated
     :return: the decorated function
     """
+
     async def decorator(*args, **kwargs):
         registry = args[0]
         await registry.fetch_bot_info()
@@ -59,7 +62,9 @@ class ActivityRegistry(RealTimeEventListener):
         for act in self._activity_list:
             if act == activity:
                 self._activity_list.remove(act)
-                logger.debug("Activity '%s' has been removed/unsubscribed in order to be replaced", act)
+                logger.debug(
+                    "Activity '%s' has been removed/unsubscribed in order to be replaced", act
+                )
 
     def slash(self, command: str, mention_bot: bool = True, description: str = ""):
         """Decorator around a listener callback coroutine which takes a
@@ -72,8 +77,11 @@ class ActivityRegistry(RealTimeEventListener):
         :param description: command description
         :return: None
         """
+
         def decorator(func):
-            logger.debug("Registering slash command with command=%s, mention_bot=%s", command, mention_bot)
+            logger.debug(
+                "Registering slash command with command=%s, mention_bot=%s", command, mention_bot
+            )
             self.register(SlashCommandActivity(command, mention_bot, func, description))
             return func
 
@@ -89,7 +97,9 @@ class ActivityRegistry(RealTimeEventListener):
                     await act.on_activity(context)
 
     @_initialize_display_name
-    async def on_symphony_elements_action(self, initiator: V4Initiator, event: V4SymphonyElementsAction):
+    async def on_symphony_elements_action(
+        self, initiator: V4Initiator, event: V4SymphonyElementsAction
+    ):
         context = FormReplyContext(initiator, event)
         for act in self._activity_list:
             if isinstance(act, FormReplyActivity):

symphony_bdk_python-2.11.2/symphony/bdk/core/auth/__init__.py

@@ -0,0 +1 @@
+"""Package containing all modules related to authentication"""

{symphony_bdk_python-2.11.0b0 → symphony_bdk_python-2.11.2}/symphony/bdk/core/auth/auth_session.py

@@ -1,13 +1,11 @@
-"""Module containing session handle classes.
+"""Module containing session handle classes."""
 
-"""
-from datetime import datetime, timezone
 import logging
+from datetime import datetime, timezone
 
 from symphony.bdk.core.auth.exception import AuthInitializationError
 from symphony.bdk.core.auth.jwt_helper import extract_token_claims
 
-
 logger = logging.getLogger(__name__)
 
 EXPIRATION_SAFETY_BUFFER_SECONDS = 5
@@ -32,8 +30,7 @@ class AuthSession:
         self._expire_at = -1
 
     async def refresh(self):
-        """Trigger re-authentication to refresh the tokens.
-        """
+        """Trigger re-authentication to refresh the tokens."""
         logger.debug("Authenticate")
         self._session_token = await self._authenticator.retrieve_session_token()
         if await self.skd_enabled:
@@ -103,14 +100,12 @@ class AuthSession:
 
     @property
     async def skd_enabled(self):
-
         token_data = extract_token_claims(await self.session_token)
         if not token_data.get(SKD_FLAG_NAME, False):
             return False
         return await self._authenticator.agent_version_service.is_skd_supported()
 
 
-
 class OboAuthSession(AuthSession):
     """RSA OBO Authentication session handle to get the OBO session token from.
     It uses an :class:`symphony.bdk.core.auth.obo_authenticator.OboAuthenticator` to actually retrieve the tokens when
@@ -127,21 +122,26 @@ class OboAuthSession(AuthSession):
         """
         super().__init__(authenticator)
         if user_id is not None and username is not None:
-            raise AuthInitializationError("Username and user id for OBO authentication should not be defined at "
-                                          "a same time.")
+            raise AuthInitializationError(
+                "Username and user id for OBO authentication should not be defined at a same time."
+            )
         if user_id is None and username is None:
-            raise AuthInitializationError("At least username or user id should be defined for "
-                                          "OBO authentication.")
+            raise AuthInitializationError(
+                "At least username or user id should be defined for OBO authentication."
+            )
         self.user_id = user_id
         self.username = username
 
     async def refresh(self):
-        """Trigger re-authentication to refresh the OBO session token.
-        """
+        """Trigger re-authentication to refresh the OBO session token."""
         if self.user_id is not None:
-            self._session_token = await self._authenticator.retrieve_obo_session_token_by_user_id(self.user_id)
+            self._session_token = await self._authenticator.retrieve_obo_session_token_by_user_id(
+                self.user_id
+            )
         if self.username is not None:
-            self._session_token = await self._authenticator.retrieve_obo_session_token_by_username(self.username)
+            self._session_token = await self._authenticator.retrieve_obo_session_token_by_username(
+                self.username
+            )
 
     @property
     async def session_token(self):