component-local 0.0.1b3800__tar.gz

component_local-0.0.1b3800/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: component-local
+Version: 0.0.1b3800
+Summary: PyPI component-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/component-main-local-python-restapi-serverless-com
+Author: Circles
+Author-email: info@circlez.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-sdk-remote
+Requires-Dist: logger-local
+Requires-Dist: database-mysql-local
+Requires-Dist: smart-datastore-local
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+PyPI component-local Python Package owned by Circlez.ai
+JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-3800
+GHA: https://github.com/circles-zone/component-main-local-python-restapi-serverless-com/actions

component_local-0.0.1b3800/README.md

@@ -0,0 +1,46 @@
+# General
+
+component-local is a Python package which returns the `component_id` of a component, from the JSON file of the component or from `component.component_table`.<br>
+
+Unlike the README.md in the root directory, this is a README.md of this specific repo/package<br>
+
+# Usage
+
+```python
+from component_local.src.component_local import ComponentLocal
+
+component_local = ComponentLocal()
+
+# 1st priority: the componentId in the JSON file (see component.json.example), 2nd priority: component.component_table
+component_id = component_local.get_component_id("event", json_path="component.json")
+
+# Only from component.component_table, returns None if there is no such component
+component_id = component_local.get_component_id_by_name("event")
+
+# Only from the JSON file, returns None if the component or its componentId are not in the file
+component_id = ComponentLocal.get_component_id_from_json("event", "component.json")
+```
+
+# TODO
+
+- Add tests which use the real component.component_table with is_test_data (they need the RDS environment variables)<br>
+- Wrap the lookup with a script so it can also be used from TypeScript and PowerShell<br>
+- Add serverless.com, as planned in the repo description<br>
+
+# Versions
+
+[pub] 0.0.1b3800 Fix the template placeholders and add ComponentLocal.get_component_id (BU-3800)<br>
+
+# Installing instructions
+
+It's advised to use venv<br>
+If you have Windows, it's also advised to use Windows Subsystem for Linux<br>
+
+## Install dependencies
+
+Run pip install -r requirements.txt from the bash terminal<br>
+Run pip install -r requirements-dev.txt from the bash terminal to run the tests<br>
+
+## Environment variables
+
+Copy .env.play1.example to .env and fill in the values (.env is in .gitignore)<br>

component_local-0.0.1b3800/component_local/src/component_local.py

@@ -0,0 +1,54 @@
+import json
+from pathlib import Path
+from typing import Optional, Union
+
+from database_mysql_local.generic_crud import GenericCRUD
+from logger_local.MetaLogger import MetaLogger
+
+from .constants_src_component_local import ConstantsSrcComponent
+
+
+# TODO When reading components.json5, We should get the componentId from component_table using a function wrapped with a script in component-main-local-python-package (so we can also use it in TypeScript and Powershell)  # noqa E501
+class ComponentLocal(GenericCRUD, metaclass=MetaLogger,
+                     object=ConstantsSrcComponent.COMPONENT_LOCAL_PYTHON_CODE_LOGGER_OBJECT):  # noqa E501
+    def __init__(self, is_test_data: bool = False) -> None:
+        GenericCRUD.__init__(
+            self,
+            default_schema_name=ConstantsSrcComponent.COMPONENT_SCHEMA_NAME,
+            default_table_name=ConstantsSrcComponent.COMPONENT_TABLE_NAME,
+            default_view_table_name=ConstantsSrcComponent.COMPONENT_VIEW_NAME,
+            default_column_name=ConstantsSrcComponent.COMPONENT_COLUMN_NAME,
+            is_test_data=is_test_data)
+
+    def get_component_id(self, component_name: str,
+                         json_path: Union[str, Path, None] = None) -> Optional[int]:
+        """Returns the component_id of component_name.
+        1st priority: the componentId in the JSON file (if json_path was given and it has the component).
+        2nd priority: the component_id from component.component_table."""
+        if json_path is not None:
+            component_id = self.get_component_id_from_json(component_name=component_name, json_path=json_path)
+            if component_id is not None:
+                return component_id
+        return self.get_component_id_by_name(component_name=component_name)
+
+    def get_component_id_by_name(self, component_name: str) -> Optional[int]:
+        """Returns the component_id with this name in component.component_table, None if there is no such component.
+        If more than one component has this name, the one with the lowest component_id is returned."""
+        if not component_name:
+            raise ValueError("component_name is required")
+        component_id = self.select_one_value_by_column_and_value(
+            select_clause_value=ConstantsSrcComponent.COMPONENT_COLUMN_NAME,
+            column_name="name", column_value=component_name,
+            order_by=ConstantsSrcComponent.COMPONENT_COLUMN_NAME)
+        return component_id
+
+    @staticmethod
+    def get_component_id_from_json(component_name: str, json_path: Union[str, Path]) -> Optional[int]:
+        """Returns the componentId of component_name from a JSON file in the format of component.json.example,
+        None if the component or its componentId are not in the file."""
+        with open(json_path, encoding="utf-8") as json_file:
+            components = json.load(json_file)
+        component = components.get(component_name)
+        if not isinstance(component, dict):
+            return None
+        return component.get("componentId")

component_local-0.0.1b3800/component_local/src/constants_src_component_local.py

@@ -0,0 +1,26 @@
+from typing import Any
+from logger_local.LoggerComponentEnum import LoggerComponentEnum
+
+
+class ConstantsSrcComponent:
+    """This is a class of all the constants of Component"""
+
+    COMPONENT_LOCAL_PYTHON_DEVELOPER_EMAIL_ADDRESS: str = 'shirlee.g@circ.zone'
+
+    # The CODE component_id of component-local in component.component_table
+    COMPONENT_LOCAL_PYTHON_CODE_COMPONENT_ID: int = 306
+
+    COMPONENT_LOCAL_PYTHON_COMPONENT_NAME = 'Component local Python package'
+    COMPONENT_LOCAL_PYTHON_CODE_LOGGER_OBJECT: dict[str, Any] = {
+        'component_id': COMPONENT_LOCAL_PYTHON_CODE_COMPONENT_ID,
+        'component_name': COMPONENT_LOCAL_PYTHON_COMPONENT_NAME,
+        'component_category': LoggerComponentEnum.ComponentCategory.Code.value,
+        'developer_email_address': COMPONENT_LOCAL_PYTHON_DEVELOPER_EMAIL_ADDRESS  # noqa E501
+    }
+
+    UNKNOWN_COMPONENT_ID = 0
+
+    COMPONENT_SCHEMA_NAME = 'component'
+    COMPONENT_TABLE_NAME = 'component_table'
+    COMPONENT_VIEW_NAME = 'component_view'
+    COMPONENT_COLUMN_NAME = 'component_id'

component_local-0.0.1b3800/component_local/tests/component_local_test.py

@@ -0,0 +1,107 @@
+# So we can run debugger without launch.json in VSCode
+from dotenv import load_dotenv
+load_dotenv()  # Load environment variables before any imports that need them
+
+import json
+import sys
+from unittest.mock import MagicMock
+
+import pytest
+
+from logger_local.LoggerLocal import Logger
+
+from ..src.component_local import ComponentLocal
+from ..src.constants_src_component_local import ConstantsSrcComponent
+from .constants_tests_component_local import ComponentTestsConstants
+
+logger = Logger.create_logger(object=ComponentTestsConstants.COMPONENT_LOCAL_PYTHON_TEST_LOGGER_OBJECT)  # noqa E501
+
+# Local test values, not real component ids (the real ones are in component.component_table)
+EVENT_COMPONENT_ID = 247
+UNKNOWN_COMPONENT_NAME = "no-such-component"
+
+
+@pytest.fixture(name="component_local")
+def component_local_fixture() -> ComponentLocal:
+    # Skips __init__ so these tests don't need a database connection
+    component_local = ComponentLocal.__new__(ComponentLocal)
+    component_local.select_one_value_by_column_and_value = MagicMock(return_value=EVENT_COMPONENT_ID)
+    return component_local
+
+
+@pytest.fixture(name="json_path")
+def json_path_fixture(tmp_path):
+    path = tmp_path / "component.json"
+    path.write_text(json.dumps({
+        "event": {"componentId": EVENT_COMPONENT_ID, "environmentName": "local"},
+        "group": {"environmentName": "local", "port": 3001}}), encoding="utf-8")
+    return path
+
+
+def test_component_table_constants():
+    logger.start("test component table constants")
+    assert ConstantsSrcComponent.COMPONENT_SCHEMA_NAME == 'component'
+    assert ConstantsSrcComponent.COMPONENT_TABLE_NAME == 'component_table'
+    assert ConstantsSrcComponent.COMPONENT_COLUMN_NAME == 'component_id'
+    logger.end("test successful")
+
+
+def test_get_component_id_from_json(json_path):
+    logger.start("test get_component_id_from_json")
+    assert ComponentLocal.get_component_id_from_json("event", json_path) == EVENT_COMPONENT_ID
+    logger.end("test successful")
+
+
+def test_get_component_id_from_json_without_component_id(json_path):
+    logger.start("test get_component_id_from_json without componentId")
+    assert ComponentLocal.get_component_id_from_json("group", json_path) is None
+    logger.end("test successful")
+
+
+def test_get_component_id_from_json_unknown_component(json_path):
+    logger.start("test get_component_id_from_json unknown component")
+    assert ComponentLocal.get_component_id_from_json(UNKNOWN_COMPONENT_NAME, json_path) is None
+    logger.end("test successful")
+
+
+def test_get_component_id_by_name(component_local):
+    logger.start("test get_component_id_by_name")
+    assert component_local.get_component_id_by_name("event") == EVENT_COMPONENT_ID
+    component_local.select_one_value_by_column_and_value.assert_called_once_with(
+        select_clause_value='component_id', column_name='name', column_value="event", order_by='component_id')
+    logger.end("test successful")
+
+
+def test_get_component_id_by_name_empty_name(component_local):
+    logger.start("test get_component_id_by_name empty name")
+    with pytest.raises(ValueError):
+        component_local.get_component_id_by_name("")
+    logger.end("test successful")
+
+
+def test_get_component_id_prefers_json(component_local, json_path):
+    logger.start("test get_component_id prefers the JSON")
+    assert component_local.get_component_id("event", json_path=json_path) == EVENT_COMPONENT_ID
+    component_local.select_one_value_by_column_and_value.assert_not_called()
+    logger.end("test successful")
+
+
+def test_get_component_id_falls_back_to_database(component_local, json_path):
+    logger.start("test get_component_id falls back to the database")
+    assert component_local.get_component_id("group", json_path=json_path) == EVENT_COMPONENT_ID
+    component_local.select_one_value_by_column_and_value.assert_called_once()
+    logger.end("test successful")
+
+
+def test_get_component_id_unknown_component(component_local):
+    logger.start("test get_component_id unknown component")
+    component_local.select_one_value_by_column_and_value.return_value = None
+    assert component_local.get_component_id(UNKNOWN_COMPONENT_NAME) is None
+    logger.end("test successful")
+
+
+# If we use only a call to some_test(), this can cause unexpected behavior, for example
+# it can cause the test to be run multiple times simultaneously. This is why we use the following
+# Which cause the test to be run only once with pytest:
+if __name__ == "__main__":
+    pytest.main(sys.argv[1:])

component_local-0.0.1b3800/component_local/tests/constants_tests_component_local.py

@@ -0,0 +1,17 @@
+from logger_local.LoggerComponentEnum import LoggerComponentEnum
+
+
+class ComponentTestsConstants:
+    # The TEST component_id of component-local in component.component_table
+    COMPONENT_TEST_COMPONENT_ID: int = 307
+    COMPONENT_TEST_COMPONENT_NAME = "Component Tests"
+    COMPONENT_DEVELOPER_EMAIL_ADDRESS = "shirlee.g@circ.zone"
+
+    COMPONENT_LOCAL_PYTHON_TEST_LOGGER_OBJECT = {
+        # At this point of time we do not support camelCase in logger-local
+        'component_id': COMPONENT_TEST_COMPONENT_ID,
+        'component_name': COMPONENT_TEST_COMPONENT_NAME,
+        'component_category': LoggerComponentEnum.ComponentCategory.Unit_Test.value,  # noqa E501
+        'testing_framework': LoggerComponentEnum.testingFramework.pytest.value,
+        'developer_email_address': COMPONENT_DEVELOPER_EMAIL_ADDRESS
+    }

component_local-0.0.1b3800/component_local.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: component-local
+Version: 0.0.1b3800
+Summary: PyPI component-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/component-main-local-python-restapi-serverless-com
+Author: Circles
+Author-email: info@circlez.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-sdk-remote
+Requires-Dist: logger-local
+Requires-Dist: database-mysql-local
+Requires-Dist: smart-datastore-local
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+PyPI component-local Python Package owned by Circlez.ai
+JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-3800
+GHA: https://github.com/circles-zone/component-main-local-python-restapi-serverless-com/actions

component_local-0.0.1b3800/component_local.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+setup.py
+component_local/__init__.py
+component_local.egg-info/PKG-INFO
+component_local.egg-info/SOURCES.txt
+component_local.egg-info/dependency_links.txt
+component_local.egg-info/requires.txt
+component_local.egg-info/top_level.txt
+component_local/src/__init__.py
+component_local/src/component_local.py
+component_local/src/constants_src_component_local.py
+component_local/tests/__init__.py
+component_local/tests/component_local_test.py
+component_local/tests/constants_tests_component_local.py

component_local-0.0.1b3800/component_local.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

component_local-0.0.1b3800/component_local.egg-info/requires.txt

@@ -0,0 +1,4 @@
+python-sdk-remote
+logger-local
+database-mysql-local
+smart-datastore-local

component_local-0.0.1b3800/component_local.egg-info/top_level.txt

@@ -0,0 +1 @@
+component_local

component_local-0.0.1b3800/pyproject.toml

@@ -0,0 +1,29 @@
+# This file should be in the future instead of setup.py
+# https://python-poetry.org/docs/pyproject
+# https://stackoverflow.com/questions/78048223/adding-folder-with-data-with-pyproject-toml
+# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
+
+# This file is mandatory for the `poetry version patch`
+
+# It seems we need to copy this file also to serverless-com repo, as required by dialog-workflow-python-package
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[tool.poetry]
+name = "component-local"
+# I believe we are still using the version from setup.py and not from here until Potery will work
+version = "0.0.1" # https://pypi.org/project/component-local/
+description = "component-local Python Package"
+readme = "README.md"
+authors = [
+    "Circlez.ai <info@circlez.ai>",
+]
+
+[tool.poetry.dev-dependencies]
+pytest = "^8.0"
+pytest-cov = "^5.0"

component_local-0.0.1b3800/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

component_local-0.0.1b3800/setup.py

@@ -0,0 +1,73 @@
+# serverless.com repo "python -m build" works without setup.py
+# Should update package_dir if not using our recommended directory structure
+
+import setuptools
+
+# TODO: Change the PACKAGE_NAME to the package's name - Either xxx-local or
+#  xxx-remote (without the -python-package suffix). Only lowercase, no
+#  underlines.
+# Used by pypa/gh-action-pypi-publish
+# Package Name should be identical to the inner directory name
+# Changing the package name here, will cause a change in the package directory
+#  name as well
+# PACKAGE_NAME should be singular if handling only one instance
+# PACKAGE_NAME should not include the word "main"
+
+# e.g.: queue-local, without python-package suffix
+PACKAGE_NAME = "component-local"
+
+package_dir = PACKAGE_NAME.replace("-", "_")
+# If we need backward-compatible:
+# old_package_dir = "old_package_name"
+
+PACKAGE_DESCRIPTION = f"PyPI {PACKAGE_NAME} Python Package owned by Circlez.ai"
+NEW_LINE = "\n"
+
+setuptools.setup(
+    name=PACKAGE_NAME,
+    # Increase this number every time you make a change you
+    #  want to publish. After 0.0.9 switch to 0.0.10 and not 0.1.0
+    # version can't be 0.0.
+    # If you find yourself increasing the version in more than one patch number (it might indicate there are multiple branches which you should submit their PRs before your PR)  # noqa: E501
+    version='0.0.1b3800',  # https://pypi.org/project/component-local/
+    author="Circles",
+    author_email="info@circlez.ai",
+    description=f"{PACKAGE_DESCRIPTION}",
+    # long_description=f"{description}",
+    long_description =f"{PACKAGE_DESCRIPTION}" + NEW_LINE  # noqa E501
+            + "JIRA Work Item: https://circles-zone.atlassian.net/browse/BU-3800" + NEW_LINE  # noqa E501
+            + "GHA: https://github.com/circles-zone/component-main-local-python-restapi-serverless-com/actions",  # noqa E501
+
+    long_description_content_type='text/markdown',
+    url="https://github.com/circles-zone/component-main-local-python-restapi-serverless-com",  # noqa E501
+    # packages=[package_dir],
+    # packages=[package_dir, old_package_dir],
+    packages=setuptools.find_packages(),
+
+    # I'm not sure we need package_dir
+    # package_dir={package_dir: f'{package_dir}/src'},
+    # TODO Unfortunately in event-main-local-restapi there are no
+    #  repo-directory and no package directory (flat directory structure)
+    # package_dir={package_dir: f'src'},
+
+    # package_dir={package_dir: f'{package_dir}/src',
+    #  old_package_dir: f'{package_dir}/src'},
+    package_data={package_dir: ['*.py']},
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
+        # TODO Fix all repos, especially the Python templates
+        # "License :: MIT AND (Apache-2.0 OR BSD-2-Clause)",
+        "Operating System :: OS Independent",
+    ],
+    # Do not add packages needed only for tests i.e. packages for get_test_xxx(
+    # TODO: Update which packages to include with this package in production
+    #  (dependencies) - Not for development/testing
+    install_requires=[
+        'python-sdk-remote',
+        'logger-local',
+        'database-mysql-local',
+        'smart-datastore-local',
+        # 'logzio-python-handler>=4.1.2',  # https://pypi.org/project/logzio-python-handler/  # noqa E501
+    ]
+)