symphony_bdk_python 2.7.0__tar.gz

symphony_bdk_python-2.7.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Symphony LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

symphony_bdk_python-2.7.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.1
+Name: symphony_bdk_python
+Version: 2.7.0
+Summary: Symphony Bot Development Kit for Python
+Home-page: https://github.com/finos/symphony-bdk-python
+License: Apache-2.0
+Author: Symphony Platform Solutions
+Author-email: symphony@finos.org
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: PyJWT (>=2.3.0,<3.0.0)
+Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
+Requires-Dist: cryptography (>=41.0.3,<42.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)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: tenacity (>=8.0.1,<9.0.0)
+Requires-Dist: urllib3 (>=1.26.9,<2.0.0)
+Project-URL: Documentation, https://symphony-bdk-python.finos.org/
+Project-URL: Repository, https://github.com/finos/symphony-bdk-python
+Description-Content-Type: text/markdown
+
+[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# 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).
+
+## Installation and getting started
+The [reference documentation](https://symphony-bdk-python.finos.org/) includes detailed
+installation instructions as well as a comprehensive
+[getting started](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+guide.
+
+## Build from source
+
+The Symphony BDK uses and requires Python 3.8 or higher. Be sure you have it installed before going further.
+
+We use [poetry](https://python-poetry.org/) in order to manage dependencies, build, run tests and publish.
+To install poetry, follow instructions [here](https://python-poetry.org/docs/#installation).
+
+On the first time, run `poetry install`. Then run `poetry build` to build the sdist and wheel packages.
+To run the tests, use `poetry run pytest`.
+
+It is possible to run pylint scan locally (on a specific file or package) executing the following command:
+`poetry run pylint <module_name>`.
+
+To generate locally the Sphinx documentation, run: `cd docsrc && make html`.
+
+## Roadmap
+
+Our next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6) one.
+It will only consist in delivering the next improvements and bug fixes of the BDK.
+
+
+## Contributing
+In order to get in touch with the project team, please open a [GitHub Issue](https://github.com/finos/symphony-bdk-python/issues).
+Alternatively, you can email/subscribe to [symphony@finos.org](https://groups.google.com/a/finos.org/g/symphony).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit your changes (`git commit -am 'Add some fooBar'`)
+5. Push to the branch (`git push origin feature/fooBar`)
+6. Create a new Pull Request
+
+_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active,
+executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active
+Corporate Contribution License Agreement (CCLA) executed with FINOS.
+Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool.
+Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
+
+*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
+
+### Update generated code
+While contributing to the project, you might need to update the generated code.
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. In order to customise the templates, a fork has been created in [https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0).  
+Here are the steps to follow:
+- Checkout the latest branch of the fork (currently [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0))
+- Update the fork source code, review and merge it
+- Generate a jar file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+  - Using maven: `mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true`. _You can also use IntelliJ's build button to build the project and generate the jar_
+- Copy the jar in Python BDK repository `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`
+- Execute the generation script `./generate.sh` and commit and push you new code along with the new jar file.
+## License
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

symphony_bdk_python-2.7.0/README.md

@@ -0,0 +1,72 @@
+[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9-blue)](https://www.python.org/downloads/release/python-3)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# 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).
+
+## Installation and getting started
+The [reference documentation](https://symphony-bdk-python.finos.org/) includes detailed
+installation instructions as well as a comprehensive
+[getting started](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+guide.
+
+## Build from source
+
+The Symphony BDK uses and requires Python 3.8 or higher. Be sure you have it installed before going further.
+
+We use [poetry](https://python-poetry.org/) in order to manage dependencies, build, run tests and publish.
+To install poetry, follow instructions [here](https://python-poetry.org/docs/#installation).
+
+On the first time, run `poetry install`. Then run `poetry build` to build the sdist and wheel packages.
+To run the tests, use `poetry run pytest`.
+
+It is possible to run pylint scan locally (on a specific file or package) executing the following command:
+`poetry run pylint <module_name>`.
+
+To generate locally the Sphinx documentation, run: `cd docsrc && make html`.
+
+## Roadmap
+
+Our next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6) one.
+It will only consist in delivering the next improvements and bug fixes of the BDK.
+
+
+## Contributing
+In order to get in touch with the project team, please open a [GitHub Issue](https://github.com/finos/symphony-bdk-python/issues).
+Alternatively, you can email/subscribe to [symphony@finos.org](https://groups.google.com/a/finos.org/g/symphony).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit your changes (`git commit -am 'Add some fooBar'`)
+5. Push to the branch (`git push origin feature/fooBar`)
+6. Create a new Pull Request
+
+_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active,
+executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active
+Corporate Contribution License Agreement (CCLA) executed with FINOS.
+Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool.
+Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
+
+*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
+
+### Update generated code
+While contributing to the project, you might need to update the generated code.
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. In order to customise the templates, a fork has been created in [https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0).  
+Here are the steps to follow:
+- Checkout the latest branch of the fork (currently [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0))
+- Update the fork source code, review and merge it
+- Generate a jar file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+  - Using maven: `mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true`. _You can also use IntelliJ's build button to build the project and generate the jar_
+- Copy the jar in Python BDK repository `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`
+- Execute the generation script `./generate.sh` and commit and push you new code along with the new jar file.
+## License
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

symphony_bdk_python-2.7.0/pyproject.toml

@@ -0,0 +1,65 @@
+[tool.poetry]
+name = "symphony_bdk_python"
+version = "2.7.0"
+license = "Apache-2.0"
+description = "Symphony Bot Development Kit for Python"
+readme = "README.md"
+authors = ["Symphony Platform Solutions <symphony@finos.org>"]
+repository = "https://github.com/finos/symphony-bdk-python"
+documentation = "https://symphony-bdk-python.finos.org/"
+packages = [
+    { include = "symphony" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+nulltype = "^2.3.1"
+python-dateutil = "^2.8.2"
+urllib3 = "^1.26.9"
+aiohttp = "^3.8.1"
+pyyaml = "^6.0"
+PyJWT = "^2.3.0"
+cryptography = "^41.0.3"
+tenacity = "^8.0.1"
+defusedxml = "^0.7.1"
+docutils = "0.16"
+
+[tool.poetry.dev-dependencies]
+pytest = "^7.1.1"
+pylint = "^2.6.0"
+pytest-cov = "^3.0.0"
+pytest-asyncio = "^0.18.2"
+Sphinx = "^4.4.0"
+recommonmark = "^0.7.1"
+furo = "^2022.3.4"
+hazelcast-python-client = "^5.0.1"
+safety = "^2.2.0"
+liccheck = "^0.6.2"
+coverage = {version = "^6.0b1", extras = ["toml"]}
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = "--junitxml=test-results/junit.xml --cov --cov-report=html"
+testpaths = ["tests"]
+norecursedirs = ["*.egg", ".*", "build", "dist", "venv", "legacy"]
+junit_logging = "all"
+
+[tool.coverage.run]
+branch = true
+source = ["symphony"]
+omit = ["symphony/bdk/gen/*"]
+
+[tool.coverage.report]
+fail_under = 90.0
+
+[tool.liccheck]
+authorized_licenses = [
+    "BSD",
+    "GNU Library or Lesser General Public License (LGPL)",
+    "MIT",
+    "Apache Software",
+    "Python Software Foundation"
+]

symphony_bdk_python-2.7.0/symphony/bdk/core/__init__.py

@@ -0,0 +1,11 @@
+"""Symphony BDK core package
+
+There is an outstanding issue with aiohttp and Python 3.8+ on Windows. This affects our client when using a
+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
+
+if os.name == "nt":
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

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

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

symphony_bdk_python-2.7.0/symphony/bdk/core/activity/api.py

@@ -0,0 +1,67 @@
+from abc import ABC, abstractmethod
+from typing import TypeVar, Generic
+
+from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
+
+C = TypeVar('C')  # Context type
+E = TypeVar('E')  # Event type
+
+
+class ActivityContext(Generic[E]):
+    """
+    Base class for any activity context holder.
+    """
+
+    def __init__(self, initiator: V4Initiator, source_event: E):
+        """
+
+        :param initiator: The activity initiator  (i.e. the Symphony user that triggered an event in the chat)
+        :param source_event: The activity source real-time event.
+        """
+        self._initiator = initiator
+        self._source_event = source_event
+
+    @property
+    def initiator(self):
+        """
+
+        :return: The activity initiator  (i.e. the Symphony user that triggered an event in the chat)
+        """
+        return self._initiator
+
+    @property
+    def source_event(self):
+        """
+
+        :return: The activity source real-time event.
+        """
+        return self._source_event
+
+
+class AbstractActivity(ABC, Generic[C]):
+    """
+    Base abstract class for activities provided by the BDK. Provides a generic flow to process an incoming chat event.
+    """
+
+    @abstractmethod
+    def matches(self, context: C) -> bool:
+        """Matches the :py:class:`ActivityContext` to decide whether an :py:class:`AbstractActivity` can be executed
+        or not.
+
+        :param context: an instance of :py:class:`ActivityContext`
+        :return: True if activity has to be triggered, False otherwise.
+        """
+
+    @abstractmethod
+    async def on_activity(self, context: C):
+        """Contains the activity business logic. Executed only if the `matches` method returned a true value.
+
+        :param context: an instance of :py:class:`ActivityContext`
+        """
+
+    def before_matcher(self, context: C):
+        """ 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.7.0/symphony/bdk/core/activity/command.py

@@ -0,0 +1,130 @@
+import logging
+
+from symphony.bdk.core.activity.api import AbstractActivity, ActivityContext
+from symphony.bdk.core.activity.exception import FatalActivityExecutionException
+from symphony.bdk.core.activity.parsing.arguments import Arguments
+from symphony.bdk.core.activity.parsing.command_token import MatchingUserIdMentionToken
+from symphony.bdk.core.activity.parsing.slash_command_pattern import SlashCommandPattern
+from symphony.bdk.core.service.exception import MessageParserError
+from symphony.bdk.core.service.message.message_parser import get_text_content_from_message
+from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator
+from symphony.bdk.gen.agent_model.v4_message_sent import V4MessageSent
+
+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):
+        self._message_id = source_event.message.message_id
+        self._stream_id = source_event.message.stream.stream_id
+        self._bot_display_name = bot_display_name
+        self._bot_user_id = bot_user_id
+        self._arguments = None
+        try:
+            self._text_content = get_text_content_from_message(source_event.message)
+        except MessageParserError as exc:
+            raise FatalActivityExecutionException("Unable to parse presentationML") from exc
+        super().__init__(initiator, source_event)
+
+    @property
+    def message_id(self):
+        return self._message_id
+
+    @property
+    def stream_id(self):
+        return self._stream_id
+
+    @property
+    def text_content(self) -> str:
+        return self._text_content
+
+    @property
+    def bot_display_name(self) -> str:
+        return self._bot_display_name
+
+    @property
+    def bot_user_id(self) -> int:
+        return self._bot_user_id
+
+    @property
+    def arguments(self) -> Arguments:
+        return self._arguments
+
+
+class CommandActivity(AbstractActivity[CommandContext]):
+    """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
+
+    @property
+    def bot_user_id(self):
+        return self._bot_user_id
+
+    @bot_user_id.setter
+    def bot_user_id(self, bot_user_id):
+        self._bot_user_id = bot_user_id
+
+    def matches(self, context: CommandContext) -> bool:
+        pass
+
+    async def on_activity(self, context: CommandContext):
+        pass
+
+
+class SlashCommandActivity(CommandActivity):
+    """A slash command is a particular CommandActivity with three parameters:
+      - the command name
+      - if we should mention the bot
+      - the callback function
+
+    The Slash command is triggered if we receive a MESSAGESENT event with message text:
+      - "@{bot_display name} {name}" if ``requires_mention_bot`` is True
+      - "{name}" otherwise
+    """
+
+    def __init__(self, name, requires_mention_bot, callback, description=""):
+        """
+        :param name: the command name
+        :param requires_mention_bot: if the command requires the bot mention to trigger the slash command
+        :param callback: the coroutine to be executed if message text matches
+        """
+        super().__init__()
+        self._name = name
+        self._command_pattern = SlashCommandPattern(name)
+        self._requires_mention_bot = requires_mention_bot
+        self._callback = callback
+        self._description = description
+
+        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))
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    def build_command_description(self) -> str:
+        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)
+
+        if match_result.is_matching and match_result.arguments:
+            context._arguments = match_result.arguments
+
+        return match_result.is_matching
+
+    async def on_activity(self, context: CommandContext):
+        await self._callback(context)
+
+    def __eq__(self, o: object) -> bool:
+        if isinstance(o, SlashCommandActivity):
+            return self._name == o._name and self._requires_mention_bot == o._requires_mention_bot
+        return False

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

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