python-sdk-remote 0.0.172__py3-none-any.whl → 0.0.174__py3-none-any.whl

python_sdk_remote/__init__.py

@@ -67,7 +67,10 @@ from .our_objects_local import OurObjectsLocal
 
 # Existing classes
 from .mini_logger import MiniLogger
-from .our_object import OurObject
+# OurObject moved to our-object-local. Imported from there rather than from the
+# deprecated .our_object re-export, so that `import python_sdk_remote` does not
+# emit a deprecation warning for itself on every single import.
+from our_object_local.our_object import OurObject
 from .version import PACKAGE_VERSION
 
 # Constants

python_sdk_remote/item.py

@@ -1,6 +1,8 @@
 from abc import abstractmethod
 
-from .our_object import OurObject
+# Straight from the owning package, not through our_object.py: that module is the
+# deprecated path and warns, and this package must not warn about itself.
+from our_object_local.our_object import OurObject
 
 ENTITY_NAME = "item"
 

python_sdk_remote/our_object.py

@@ -1,174 +1,56 @@
-import json
-from abc import ABC  # , abstractmethod
-from datetime import datetime
-from typing import Any, Optional
+"""Backward-compatibility re-export of `OurObject`, which now lives in `our-object-local`.
 
-from .mini_logger import MiniLogger as logger
+The class moved to the `our-object-local` package so that anything wanting the
+base business object no longer has to take the whole SDK, and so that
+`our-object-field-local` can sit above `fields-local` without a cycle:
 
-from .version import PACKAGE_VERSION
+    our-object-field-local -> fields-local -> python-sdk-remote -> our-object-local
 
+`our-object-local` declares no circlez dependencies at all, which is what keeps
+that chain acyclic.
 
-"""
-Base class for all business objects in the system.
-
-This class provides common functionality for all entities including:
-- JSON serialization/deserialization
-- Equality comparison
-- String representation
-- Attribute access
-
-Usage: Extend this class for all business entities to ensure consistent behavior.
-"""
-class OurObject(ABC):
-
-    entity_name: Optional[str] = None
-    id: Optional[int] = None
-
-    # Needed by print_our_object_with_id()
-    name: Optional[str] = None
-    number: Optional[int] = None
-
-    fields = {
-        # Needed by print_our_object_with_id()
-        "name",
-        "number"
-    }
-
-    def __init__(self, entity_name: Optional[str] = None,
-                 id: Optional[int] = None, **kwargs: Any):
-        INIT_METHOD_NAME = '__init__'
-        logger.start(INIT_METHOD_NAME, object={'kwargs': kwargs})
-        self.set_entity_name(entity_name)
-        self.set_id(id)
-        self.kwargs = kwargs
-        logger.end(INIT_METHOD_NAME, object={'kwargs': kwargs})
-
-    def __convert_kwargs_to_fields(self, kwargs, fields):
-        """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, kwargs):
-        """
-        Convert fields to kwargs format.
-        
-        Note: This method may be removed in future versions if unused.
-        """
-        for field in fields:
-            if field in kwargs:
-                setattr(self, field, kwargs[field])
-            else:
-                setattr(self, field, None)
+This module is temporary. It exists only so that
+`from python_sdk_remote.our_object import OurObject` - what every consumer
+writes today - keeps working while they migrate: `Contact` (contact-local),
+`Event` (event-local), `FieldLocal` (fields-local), `CalendarLocal`
+(calendar-local), `Item` (in this package), and both `GenericCRUD.foreach()`
+and `HelperMysqlObject` in database-mysql-local.
 
-    def set_entity_name(self, entity_name: Optional[str]) -> None:
-        self.entity_name = entity_name
+New code should import from the owning package instead:
 
-    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. Same fix as in
-        # our-object-local, so the two copies stay identical.
-        id_column_name = str(self.entity_name) + "_id"
-        return id_column_name
+    from our_object_local.our_object import OurObject
 
-    def set_id(self, id: Optional[int]) -> None:
-        self.id = id
+Reading `OurObject` from here calls `deprecation_warning_function`, so every
+remaining caller shows up in the logs - and therefore in the metrics - with its
+own file name. That is what tells us when this module can be deleted. The
+warning is raised from a module-level `__getattr__` (PEP 562) rather than at
+import time on purpose: at import time the only frame above us is
+`<frozen importlib._bootstrap>`, which names no caller and measures nothing.
 
-    def get_id(self) -> Optional[int]:
-        return self.id
+Nothing inside this package reads `OurObject` through this module - `item.py`
+and `__init__.py` import it straight from `our_object_local` - so every warning
+counted here comes from a real consumer.
 
-    # 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"""
-        GET_METHOD_NAME = 'get'
-        logger.start(GET_METHOD_NAME, object={'attr_name': attr_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. Same guard as in our-object-local.
-        arguments = getattr(self, 'kwargs', None)
-        value = arguments.get(attr_name, None) if arguments else None
-        logger.end(GET_METHOD_NAME, object={'attr_name': attr_name})
-        return value
-
-    def get_all_arguments(self):
-        """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) -> str:
-        """Returns a json string 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):
-        """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"""
-        FROM_JSON_METHOD_NAME = 'from_json'
-        logger.start(FROM_JSON_METHOD_NAME,
-                     object={'json_string': json_string})
-        self.__dict__ = json.loads(json_string)
-        logger.end(FROM_JSON_METHOD_NAME,
-                   object={'json_dict': self.__dict__})
-        return self
+Not to be confused with `OurObjectsLocal` (plural) in `our_objects_local.py`,
+which is an unrelated `GenericCRUD` collection layer that stays in this package.
+"""
+from typing import TYPE_CHECKING, Any
 
-    def __eq__(self, other) -> bool:
-        """Checks if two objects are equal"""
-        if not isinstance(other, OurObject):
-            return False
-        eq_result = self.__dict__ == other.__dict__
-        return eq_result
+from .utilities import deprecation_warning_function
 
-    def __ne__(self, other) -> bool:
-        """Checks if two objects are not equal"""
-        ne_result = not self.__eq__(other)
-        return ne_result
+if TYPE_CHECKING:  # so type checkers still resolve OurObject to the real class
+    from our_object_local.our_object import OurObject
 
-    def __str__(self):
-        str_result = self.entity_name + ": " + str(self.__dict__)
-        return str_result
+OLD_OUR_OBJECT_IMPORT_PATH = 'python_sdk_remote.our_object.OurObject'
+NEW_OUR_OBJECT_IMPORT_PATH = 'our_object_local.our_object.OurObject'
 
-    def __repr__(self):
-        """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
+__all__ = ['OurObject']
 
-    def to_dict(self):
-        return self.__dict__
 
-    def get_package_version(self) -> str:
-        """
-        Get package version.
-        
-        Note: Returns version of python-sdk-remote, not the derived class package.
-        """
-        return PACKAGE_VERSION
+def __getattr__(name: str) -> Any:
+    if name == 'OurObject':
+        deprecation_warning_function(old_name=OLD_OUR_OBJECT_IMPORT_PATH,
+                                     new_name=NEW_OUR_OBJECT_IMPORT_PATH)
+        from our_object_local.our_object import OurObject as our_object_class
+        return our_object_class
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

{python_sdk_remote-0.0.172.dist-info → python_sdk_remote-0.0.174.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.172
+Version: 0.0.174
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles
@@ -12,6 +12,7 @@ Requires-Dist: requests
 Requires-Dist: python-dotenv
 Requires-Dist: url-remote
 Requires-Dist: pyjwt
+Requires-Dist: our-object-local
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{python_sdk_remote-0.0.172.dist-info → python_sdk_remote-0.0.174.dist-info}/RECORD

@@ -1,4 +1,4 @@
-python_sdk_remote/__init__.py,sha256=MtYZUgsmQEFdxHIRnxyMyE6i5c5ahu4LNVUYkziIrj8,3550
+python_sdk_remote/__init__.py,sha256=wBfMpAOPwxDMD4wdG74B5OboGVmC_fKGlEid4p8iAeY,3790
 python_sdk_remote/constants.py,sha256=UBJta5-UdA1Y-owTesMB4TMht-ZvHApYwXAG8EtL6uE,1372
 python_sdk_remote/constants_src_mini_logger_and_logger.py,sha256=EB9-UIX-YRfLcFCT1VianrngcoTso397gF07a3WM3zk,437
 python_sdk_remote/datetime_range.py,sha256=5dCA6vSTnqp6pnd5exEVsmbeWpaee-oxfG0cE21eW_k,4376
@@ -6,10 +6,10 @@ python_sdk_remote/exceptions.py,sha256=N4eiN-ijGW3hBOp6AnMy28NH_Ekbtu57b6Zcqzofk
 python_sdk_remote/generic_crud.py,sha256=jzmR27kr8Pnf4Gk90SKoxbM5ufLsOr2ofekRtcHw248,9907
 python_sdk_remote/http_response.py,sha256=T659q_iPt8SkT8k-T4ZfRy9VSh0uvHyluecqwZnhRqI,12888
 python_sdk_remote/is_test_data.py,sha256=ZVu7ylFMV2FO0w0Huxqo5AXyZZ8GwbqJn3bWMRVR5ZE,110
-python_sdk_remote/item.py,sha256=6DQs1nBKbEmnHjE50vZtkMr14ECS_9b8cvE7ItPAbhE,322
+python_sdk_remote/item.py,sha256=SH7kKyoJ5i6f_FmoEahmeITznuzbgThaT1IAyHdM8mk,494
 python_sdk_remote/mini_logger.py,sha256=0bWAT0XeB2B-_rTf9Ql6uewZsSgGasQ5rp3aRmsp1xE,6585
 python_sdk_remote/our_obfuscation.py,sha256=YrQksRpJ_AwEio4xHq_TE8BQDXNGUbCQ-5E0OkcXYeM,10717
-python_sdk_remote/our_object.py,sha256=iGvlkBG4jjYEtVBFrN-DVX0Oz5f6ZisWRgiYbXxfKto,6178
+python_sdk_remote/our_object.py,sha256=wQsoe0fL-HQHd8vkiMsjlCaCJopkz5GsYgdVcsjEkKQ,2610
 python_sdk_remote/our_objects.py,sha256=CUcuh5bYaO2JiVKu_hMsPqiWOuURMge0NBnnS_UpWZY,254
 python_sdk_remote/our_objects_local.py,sha256=vfBGZ25uFVzCMPahbrQ9OTwIDyMh2w8FApsCkgvqFcY,7655
 python_sdk_remote/our_objects_remote.py,sha256=fdgZwA8DaNA5G3thdUTCj7TRrO6xpqxvR5MJPZ19g1Y,140
@@ -20,7 +20,7 @@ python_sdk_remote/utilities.py,sha256=1nlrE6FXVIdQDtLmF7IR935D6HMKoXIdp5vXRu6t_s
 python_sdk_remote/valid_json_versions.py,sha256=zVtvhsEDKkfK3o8crdcP6YWjLnzh-OykWGPT7vghb6k,147
 python_sdk_remote/validate_environment.py,sha256=VQKta418TmJwkUGXp0Rorhy65YANoNVgg86BIYPf2Wc,2321
 python_sdk_remote/version.py,sha256=nJV1jCPXMEluCrvcEBWwM8BS6DzFTv7pULfqjGXs3uA,421
-python_sdk_remote-0.0.172.dist-info/METADATA,sha256=bgSzmch2RcWz6KTa3DRFkkpAnzPvUD-e_LEYIVGUDHI,729
-python_sdk_remote-0.0.172.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_sdk_remote-0.0.172.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
-python_sdk_remote-0.0.172.dist-info/RECORD,,
+python_sdk_remote-0.0.174.dist-info/METADATA,sha256=bHC3i-azJySipirsSHiBI4Av8QqCySgbMtjm2u4I9I4,761
+python_sdk_remote-0.0.174.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_sdk_remote-0.0.174.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
+python_sdk_remote-0.0.174.dist-info/RECORD,,