our-object-local 0.0.1__tar.gz

our_object_local-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: our-object-local
+Version: 0.0.1
+Summary: PyPI our-object-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/our-object-local-python-package
+Author: Circles
+Author-email: info@circlez.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: summary
+
+PyPI our-object-local Python Package owned by Circlez.ai

our_object_local-0.0.1/README.md

@@ -0,0 +1,58 @@
+# our-object-local
+
+`OurObject` - the root of the circlez business-object model.
+
+Moved here from `python_sdk_remote/src/our_object.py` so that a package wanting
+the base class no longer has to take the whole SDK. `python-sdk-remote` keeps
+re-exporting `OurObject`, so every existing import goes on working.
+
+```python
+from our_object_local.our_object import OurObject
+
+
+class Contact(OurObject):
+    def __init__(self, contact_id: int = None, **kwargs):
+        super().__init__(entity_name="contact", id=contact_id, **kwargs)
+```
+
+## Why this is its own package
+
+`fields-local` depends on `python-sdk-remote`. Putting the `fields-local`-backed
+field helpers on `OurObject` while it lived inside `python-sdk-remote` would
+have made `python-sdk-remote` depend on `fields-local` - a cycle. Splitting the
+base class out breaks it:
+
+```
+our-object-field-local -> fields-local -> python-sdk-remote -> our-object-local
+           |                                                        ^
+           +--------------------------------------------------------+
+```
+
+**This package therefore declares no circlez dependencies at all.** That is a
+rule, not a coincidence, and `our_object_test.py` asserts it in a fresh
+interpreter so it cannot rot. It is also why `OurObject` no longer carries
+`MiniLogger`: `logger-local` depends on `python-sdk-remote`, which depends on
+this package.
+
+It ships `py.typed` (PEP 561), so consumers get the real annotations from mypy
+instead of `Any`.
+
+## TODOs
+
+- `get_package_version()` returns this package's version, which is as wrong for
+  a derived class as returning `python-sdk-remote`'s was. Retire it, or resolve
+  the subclass's real distribution?
+- The class-level `fields` set and the two unreferenced `__convert_*` methods
+  are replaced by `OurObjectFields` in `our-object-field-local`.
+
+## Versions
+
+[pub] 0.0.1 Initial version - `OurObject` moved in from `python-sdk-remote`,
+without the logger, with annotations and `py.typed`.
+
+## Install dependencies
+
+It's advised to use venv.
+
+Run `pip install -r requirements-dev.txt` from the bash terminal - there are no
+runtime dependencies to install.

our_object_local-0.0.1/our_object_local/src/our_object.py

@@ -0,0 +1,184 @@
+"""The root of the business-object model.
+
+Moved here from `python_sdk_remote/src/our_object.py` so that anything wanting
+the base class no longer has to take the whole SDK. `python-sdk-remote` keeps
+re-exporting `OurObject`, so every existing import goes on working.
+
+This package deliberately declares **no circlez dependencies at all**. That is
+what lets `our-object-field-local` sit above `fields-local` without a cycle:
+
+    our-object-field-local -> fields-local -> python-sdk-remote -> our-object-local
+
+Consequence of the same rule: the `MiniLogger` calls the original carried are
+gone. `logger-local` depends on `python-sdk-remote`, which will depend on this
+package, so importing a logger here would close the loop. Nothing is lost -
+`logger.start`/`logger.end` fired on every single attribute read in `get()`.
+"""
+
+import json
+from abc import ABC
+from datetime import datetime
+from typing import Any, Optional
+
+from .version import PACKAGE_VERSION
+
+
+class OurObject(ABC):
+    """Base class for all business objects in the system.
+
+    Provides JSON serialization/deserialization, equality comparison, string
+    representation and attribute access. Extend it for every business entity
+    so behaviour stays consistent.
+    """
+
+    entity_name: Optional[str] = None
+    id: Optional[int] = None
+
+    # Needed by print_our_object_with_id()
+    name: Optional[str] = None
+    number: Optional[int] = None
+
+    # TODO `fields` is a class-level mutable set, so it is shared by every
+    #  subclass that does not override it, and the print_our_object_with_id()
+    #  it is commented for exists in no installed package. It is replaced by
+    #  OurObjectFields in our-object-field-local; kept here unchanged so this
+    #  move stays a move.
+    fields = {
+        # Needed by print_our_object_with_id()
+        "name",
+        "number"
+    }
+
+    def __init__(self, entity_name: Optional[str] = None,
+                 id: Optional[int] = None, **kwargs: Any) -> None:
+        self.set_entity_name(entity_name)
+        self.set_id(id)
+        self.kwargs = kwargs
+
+    # TODO Neither __convert_ method is called anywhere in any installed
+    #  circlez package, and both are name-mangled, so no subclass can reach
+    #  them either. Slated for removal with the OurObjectFields work.
+    def __convert_kwargs_to_fields(self, kwargs: dict, fields: set) -> None:
+        """Convert kwargs to object fields based on allowed fields list."""
+        for field, value in kwargs.items():
+            if field in fields:
+                setattr(self, field, value)
+
+    def __convert_fields_to_kwargs(self, fields: set, kwargs: dict) -> None:
+        """Convert fields to kwargs format."""
+        for field in fields:
+            if field in kwargs:
+                setattr(self, field, kwargs[field])
+            else:
+                setattr(self, field, None)
+
+    def set_entity_name(self, entity_name: Optional[str]) -> None:
+        self.entity_name = entity_name
+
+    def get_id_column_name(self) -> str:
+        """Returns the name of the column that is used as the id of the object"""
+        # BEHAVIOUR NOTE: was `self.entity_name + "_id"`, which raised
+        # TypeError on the default entity_name of None. Forced by the
+        # annotations this package now ships - see py.typed in the PR body.
+        id_column_name = str(self.entity_name) + "_id"
+        return id_column_name
+
+    def set_id(self, id: Optional[int]) -> None:
+        self.id = id
+
+    def get_id(self) -> Optional[int]:
+        return self.id
+
+    # Commented so we can use it in database foreach()
+    # @abstractmethod
+    def get_name(self) -> Optional[str]:
+        """Returns the name of the object"""
+        # raise NotImplementedError(
+        #     "Subclasses must implement the 'get_name' method.")
+        return None
+
+    def get(self, attr_name: str) -> Any:
+        """Returns the value of the attribute with the given name"""
+        # BEHAVIOUR NOTE: the getattr default of None was already there, but
+        # .get() was then called on it unconditionally, so any instance built
+        # without __init__ - from_json does exactly that - raised
+        # AttributeError. Guarding it is forced by the annotations.
+        arguments = getattr(self, 'kwargs', None)
+        get_result = arguments.get(attr_name, None) if arguments else None
+        return get_result
+
+    def get_all_arguments(self) -> Optional[dict]:
+        """Returns all the arguments passed to the constructor as a dictionary"""
+        get_all_arguments_result = getattr(self, 'kwargs', None)
+        return get_all_arguments_result
+
+    def to_json(self) -> str:
+        """This is backwards compatible with the previous implementation"""
+        to_json_result = self.to_json_str()
+        return to_json_result
+
+    def to_json_dict(self) -> dict:
+        """Returns a json dict representation of this object"""
+        json_str = self.to_json_str()
+        json_dict = json.loads(json_str)
+
+        return json_dict
+
+    def to_json_str(self) -> str:
+        """Returns a json string representation of this object"""
+        to_json_str_result = json.dumps(self.__dict__, default=self._serialize)
+        return to_json_str_result
+
+    @staticmethod
+    def _serialize(obj: Any) -> str:
+        """Custom serialization function for unsupported types. Used by json.dumps"""
+        if isinstance(obj, datetime):
+            return obj.isoformat()  # Converts datetime to ISO 8601 string
+        raise TypeError(f"Type {type(obj)} not serializable")
+
+    def from_json(self, json_string: str) -> 'OurObject':
+        """Returns an instance of the class from a json string"""
+        self.__dict__ = json.loads(json_string)
+        return self
+
+    def __eq__(self, other: object) -> bool:
+        """Checks if two objects are equal"""
+        if not isinstance(other, OurObject):
+            return False
+        eq_result = self.__dict__ == other.__dict__
+        return eq_result
+
+    def __ne__(self, other: object) -> bool:
+        """Checks if two objects are not equal"""
+        ne_result = not self.__eq__(other)
+        return ne_result
+
+    def __str__(self) -> str:
+        # BEHAVIOUR NOTE: same TypeError-on-None as get_id_column_name.
+        # __repr__ right below already guarded for it; __str__ did not.
+        str_result = str(self.entity_name) + ": " + str(self.__dict__)
+        return str_result
+
+    def __repr__(self) -> str:
+        """String representation for debugging."""
+        # Ensure both entity_name and __dict__ are not None for proper representation
+        entity_name = self.entity_name or "OurObject"
+        dict_str = str(self.__dict__) if self.__dict__ else "{}"
+        repr_result = f"{entity_name}: {dict_str}"
+        return repr_result
+
+    def to_dict(self) -> dict:
+        return self.__dict__
+
+    # TODO This returned python-sdk-remote's version under a docstring
+    #  admitting that is wrong for derived classes; it now returns
+    #  our-object-local's, which is wrong in exactly the same way. Retire it,
+    #  or resolve the subclass's real distribution? Asked on contact #60 -
+    #  left behaving as before until answered.
+    def get_package_version(self) -> str:
+        """Get package version.
+
+        Note: Returns the version of our-object-local, not the derived class
+        package.
+        """
+        return PACKAGE_VERSION

our_object_local-0.0.1/our_object_local/src/version.py

@@ -0,0 +1 @@
+PACKAGE_VERSION = "0.0.1"

our_object_local-0.0.1/our_object_local.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: our-object-local
+Version: 0.0.1
+Summary: PyPI our-object-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/our-object-local-python-package
+Author: Circles
+Author-email: info@circlez.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: summary
+
+PyPI our-object-local Python Package owned by Circlez.ai

our_object_local-0.0.1/our_object_local.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+setup.py
+our_object_local.egg-info/PKG-INFO
+our_object_local.egg-info/SOURCES.txt
+our_object_local.egg-info/dependency_links.txt
+our_object_local.egg-info/top_level.txt
+our_object_local/src/__init__.py
+our_object_local/src/our_object.py
+our_object_local/src/py.typed
+our_object_local/src/version.py

our_object_local-0.0.1/our_object_local.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

our_object_local-0.0.1/our_object_local.egg-info/top_level.txt

@@ -0,0 +1 @@
+our_object_local

our_object_local-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+# This file should be in the future instead of setup.py
+# https://python-poetry.org/docs/pyproject
+# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
+
+# This file is mandatory for the `poetry version patch`
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+
+[tool.poetry]
+name = "our-object-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/our-object-local/
+description = "our-object-local Python Package"
+readme = "README.md"
+authors = [
+    "Circlez.ai <info@circlez.ai>",
+]
+
+[tool.poetry.dev-dependencies]
+pytest = "^8.0"
+pytest-cov = "^5.0"

our_object_local-0.0.1/setup.cfg

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

our_object_local-0.0.1/setup.py

@@ -0,0 +1,37 @@
+import setuptools
+
+# Used by pypa/gh-action-pypi-publish. Lowercase, no underlines, no "main",
+# without the -python-package suffix.
+PACKAGE_NAME = "our-object-local"
+
+# The import name, i.e. "import our_object_local". It matches PACKAGE_NAME and
+# the on-disk directory, as every other package does.
+package_dir = PACKAGE_NAME.replace("-", "_")
+
+PACKAGE_DESCRIPTION = f"PyPI {PACKAGE_NAME} Python Package owned by Circlez.ai"
+
+setuptools.setup(
+    name=PACKAGE_NAME,
+    # Beta tag suffixed with the Jira Work Item ID, otherwise PR number, so a version traces back to the PR that generated it.
+    version='0.0.1',  # https://pypi.org/project/our-object-local#history
+    author="Circles",
+    author_email="info@circlez.ai",
+    description=PACKAGE_DESCRIPTION,
+    long_description=PACKAGE_DESCRIPTION,
+    long_description_content_type='text/markdown',
+    url=f"https://github.com/circles-zone/{PACKAGE_NAME}-python-package",
+    packages=[package_dir],
+    package_dir={package_dir: f'{package_dir}/src'},
+    # py.typed marks the package as typed (PEP 561), so mypy reads these
+    # annotations in every consumer instead of falling back to Any.
+    package_data={package_dir: ['*.py', 'py.typed']},
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+    # Deliberately empty. This is the bottom of the object model: adding any
+    # circlez package here recreates the cycle that sent OurObject into its own
+    # repo -- our-object-field-local -> fields-local -> python-sdk-remote ->
+    # our-object-local.
+    install_requires=[]
+)