python-sdk-remote 0.0.169__tar.gz → 0.0.170__tar.gz

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.169
+Version: 0.0.170
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/datetime_range.py

@@ -5,7 +5,7 @@ This module provides a DatetimeRange class with start_datetime and end_datetime
 as requested in the TODO.
 """
 
-from datetime import datetime
+from datetime import datetime, timedelta
 from typing import Optional
 
 from .mini_logger import MiniLogger as logger
@@ -72,7 +72,7 @@ class DatetimeRange:
         logger.end(object={"overlaps_result": result})
         return result
     
-    def duration(self) -> datetime:
+    def duration(self) -> timedelta:
         """
         Calculate the duration of the datetime range.
         

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/http_response.py

@@ -1,7 +1,7 @@
 import traceback
 from functools import wraps
 from http import HTTPStatus
-from typing import Any
+from typing import Any, Optional, overload
 
 from .mini_logger import MiniLogger as logger
 from .utilities import camel_to_snake, snake_to_camel, to_dict, to_json
@@ -117,16 +117,29 @@ def handler_decorator(logger):
     return decorator
 
 
-def create_authorization_http_headers(user_jwt: str = None, context: dict = None) -> dict:
+@overload
+def create_authorization_http_headers(user_jwt: str, context: Optional[dict] = None) -> dict:
+    ...
+
+
+@overload
+def create_authorization_http_headers(*, context: dict) -> dict:
+    ...
+
+
+def create_authorization_http_headers(user_jwt: Optional[str] = None, context: Optional[dict] = None) -> dict:
     """
     Create HTTP headers with authorization token.
-    
+
+    Authorization is mandatory: either user_jwt or context must be provided.
+    The overloads above make a call with neither a type error, and a call with
+    neither still raises ValueError at runtime.
     Auto-detects user_jwt from context if not provided directly.
-    
+
     Args:
         user_jwt: JWT token string. If None, will attempt to extract from context
         context: AWS Lambda context or dict containing authorization info
-        
+
     Returns:
         dict: HTTP headers with authorization
         
@@ -151,7 +164,7 @@ def create_authorization_http_headers(user_jwt: str = None, context: dict = None
     return authorization_http_headers
 
 
-def _extract_jwt_from_context(context: dict) -> str:
+def _extract_jwt_from_context(context: dict) -> Optional[str]:
     """
     Extract JWT token from various context formats.
     
@@ -159,7 +172,7 @@ def _extract_jwt_from_context(context: dict) -> str:
         context: Context dictionary that may contain JWT information
         
     Returns:
-        str: Extracted JWT token or None if not found
+        Optional[str]: Extracted JWT token or None if not found
     """
     logger.start(object={"context_keys": list(context.keys()) if isinstance(context, dict) else "not_dict"})
     

python_sdk_remote-0.0.170/python_sdk_remote/src/is_test_data.py

@@ -0,0 +1,4 @@
+class IsTestDataEnum:
+    REAL_DATA: int = 0
+    DATA_FOR_TESTS: int = 1
+    DATA_GENERETED_BY_TESTS: int = 2

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/mini_logger.py

@@ -3,6 +3,8 @@ import os
 import sys
 # from enum import Enum
 import inspect
+from typing import Optional
+
 from .constants_src_mini_logger_and_logger import LogMessageSeverity, StartEndEnum
 
 # Logger configuration constants
@@ -50,7 +52,8 @@ class MiniLogger:
     _is_write_to_sql = False  # Should be always False in MiniLogger
 
     @staticmethod
-    def _log(level: LogMessageSeverity, start_or_end: StartEndEnum = None, log_message: str = None, **kwargs):
+    def _log(level: LogMessageSeverity, start_or_end: Optional[StartEndEnum] = None,
+             log_message: Optional[str] = None, **kwargs):
         """
         Private unified method for all log operations.
         
@@ -81,7 +84,7 @@ class MiniLogger:
             method(f"Function: {function}, Line: {line}; {action_name} - {log_message} - {object}")
 
     @staticmethod
-    def start(log_message: str = None, **kwargs):
+    def start(log_message: Optional[str] = None, **kwargs):
         """
         Log method entry with DEBUG level.
 
@@ -91,7 +94,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.DEBUG, StartEndEnum.START, log_message, **kwargs)
 
     @staticmethod
-    def end(log_message: str = None, **kwargs):
+    def end(log_message: Optional[str] = None, **kwargs):
         """
         Log method exit with DEBUG level.
 
@@ -101,7 +104,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.DEBUG, StartEndEnum.END, log_message, **kwargs)
 
     @staticmethod
-    def debug(log_message: str = None, **kwargs):
+    def debug(log_message: Optional[str] = None, **kwargs):
         """
         Log debug message.
 
@@ -111,7 +114,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.DEBUG, log_message=log_message, **kwargs)
 
     @staticmethod
-    def info(log_message: str = None, **kwargs):
+    def info(log_message: Optional[str] = None, **kwargs):
         """
         Log informational message.
 
@@ -121,7 +124,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.INFORMATION, log_message=log_message, **kwargs)
 
     @staticmethod
-    def warning(log_message: str = None, **kwargs):
+    def warning(log_message: Optional[str] = None, **kwargs):
         """
         Log warning message with source information.
 
@@ -131,7 +134,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.WARNING, log_message=log_message, **kwargs)
 
     @staticmethod
-    def error(log_message: str = None, **kwargs):
+    def error(log_message: Optional[str] = None, **kwargs):
         """
         Log error message.
 
@@ -141,7 +144,7 @@ class MiniLogger:
         MiniLogger._log(LogMessageSeverity.ERROR, log_message=log_message, **kwargs)
 
     @staticmethod
-    def exception(self, log_message: str = None, **kwargs):
+    def exception(log_message: Optional[str] = None, **kwargs):
         """
         Print a log error message with the current time.
 
@@ -149,6 +152,7 @@ class MiniLogger:
             log_message (str): The message to be printed.
         """
         object = kwargs.get("object")
+        exception: Optional[Exception]
         if isinstance(object, Exception):
             exception = object
         elif isinstance(object, dict):

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/our_object.py

@@ -1,6 +1,7 @@
 import json
 from abc import ABC  # , abstractmethod
 from datetime import datetime
+from typing import Any, Optional
 
 from .mini_logger import MiniLogger as logger
 
@@ -20,12 +21,12 @@ Usage: Extend this class for all business entities to ensure consistent behavior
 """
 class OurObject(ABC):
 
-    entity_name = None
-    id = None
+    entity_name: Optional[str] = None
+    id: Optional[int] = None
 
     # Needed by print_our_object_with_id()
-    name = None
-    number = None
+    name: Optional[str] = None
+    number: Optional[int] = None
 
     fields = {
         # Needed by print_our_object_with_id()
@@ -33,7 +34,8 @@ class OurObject(ABC):
         "number"
     }
 
-    def __init__(self, entity_name: str = None, id: int = None, **kwargs):
+    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)
@@ -59,33 +61,41 @@ class OurObject(ABC):
             else:
                 setattr(self, field, None)
 
-    def set_entity_name(self, entity_name: str) -> 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"""
-        id_column_name = self.entity_name + "_id"
+        # 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
 
-    def set_id(self, id: int) -> None:
+    def set_id(self, id: Optional[int]) -> None:
         self.id = id
 
-    def get_id(self) -> int:
+    def get_id(self) -> Optional[int]:
         return self.id
 
     # Commented so we can use it in database foreach()
     # @abstractmethod
-    def get_name(self) -> str:
+    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) -> 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)
+        value = arguments.get(attr_name, None) if arguments else None
         logger.end(GET_METHOD_NAME, object={'attr_name': attr_name})
         return value
 

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/our_request.py

@@ -76,7 +76,7 @@ class OurRequest:
         
         logger.start(method_name, object=request_details)
         
-        last_exception = None
+        last_exception: Optional[Exception] = None
         
         for attempt in range(retries + 1):
             try:
@@ -222,7 +222,7 @@ class OurRequest:
         
         logger.start(method_name, object=request_details)
         
-        last_exception = None
+        last_exception: Optional[Exception] = None
         
         for attempt in range(retries + 1):
             try:

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/our_request_old.py

@@ -65,7 +65,7 @@ class OurRequest:
         
         logger.start(method_name, object=request_details)
         
-        last_exception = None
+        last_exception: Optional[Exception] = None
         
         for attempt in range(retries + 1):
             try:
@@ -210,7 +210,7 @@ class OurRequest:
         
         logger.start(method_name, object=request_details)
         
-        last_exception = None
+        last_exception: Optional[Exception] = None
         
         for attempt in range(retries + 1):
             try:

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote/src/utilities.py

@@ -5,7 +5,7 @@ import random
 import re
 from datetime import date, datetime, time, timedelta, timezone
 from functools import lru_cache
-from typing import Union
+from typing import Optional, Tuple, Union
 from urllib.parse import urlparse
 
 import jwt
@@ -47,9 +47,9 @@ def append_if_not_exist(lst: list, item: object) -> None:
         lst.append(item)
 
 
-def to_dict(data: json or dict or None) -> dict:
+def to_dict(data: Optional[Union[str, bytes, dict]]) -> dict:
     if data is None:
-        to_dict_result = {}
+        to_dict_result: dict = {}
         return to_dict_result
     if isinstance(data, dict):
         return data
@@ -57,7 +57,7 @@ def to_dict(data: json or dict or None) -> dict:
     return to_dict_result
 
 
-def to_json(data: json or dict or None) -> json:
+def to_json(data: Optional[Union[str, dict]]) -> str:
     if data is None:
         data = {}
     if isinstance(data, dict):
@@ -174,7 +174,7 @@ def is_valid_date_range(date_range: tuple) -> bool:
     return True
 
 
-def is_valid_datetime_range(datetime_range: (datetime, datetime)) -> bool:
+def is_valid_datetime_range(datetime_range: Tuple[datetime, datetime]) -> bool:
     """
     Validate that the datetime range is in the format 'YYYY-MM-DD HH:MM:SS'.
     """
@@ -230,7 +230,7 @@ def is_list_of_dicts(obj: object) -> bool:
             "is_list_of_dicts_result": is_list_of_dicts_result})
         return is_list_of_dicts_result
     except Exception as exception:
-        logger.exception(object=exception)
+        logger.exception("is_list_of_dicts failed", object=exception)
         logger.end()
         raise
 
@@ -282,7 +282,7 @@ def is_date_in_date_range(check_date: date, date_range: tuple) -> bool:
     return start_date <= check_date <= end_date
 
 
-def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (datetime, datetime)) -> bool:
+def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: Tuple[datetime, datetime]) -> bool:
     """
     Check if the given datetime is within the specified datetime range.
 
@@ -306,7 +306,8 @@ def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (dat
     return is_datetime_in_datetime_range_result
 
 
-def add_to_file_if_not_existed(file: str, key: str, value: str) -> None:
+# TODO shall we rename the function _file_ to _key_value_file_
+def add_to_file_if_not_existed(file: str, key: str, value: Optional[str]) -> None:
     logger.start(object={"file": file, "key": key, "value": value})
     if not os.path.exists(file):
         with open(file, "w") as f:
@@ -320,7 +321,7 @@ def add_to_file_if_not_existed(file: str, key: str, value: str) -> None:
     logger.end()
 
 
-def update_dot_env_example(key: str, value: str):
+def update_dot_env_example(key: str, value: Optional[str]):
     # Avoid recursion by checking environment directly
     env_name = os.getenv("ENVIRONMENT_NAME", "").lower()
     if env_name == "play1":
@@ -332,8 +333,9 @@ def update_dot_env_example(key: str, value: str):
 # TODO If running in a lower environment(i.e. local1, play1) update .env.example with the key without the value
 # TODO If running in a lower environment(i.e. local1, play1) and the key do not exist look for it in the Team Member Personal Repo and copy both the key and value to the repo .env.{environment_name} file
 # TODO move all our_*_env() to our_env.py
-def our_get_env(key: str, default: str = None, raise_if_not_found: bool = True,
-                raise_if_empty: bool = False, optional_prefix: str = None) -> str:
+# TODO shall we rename optional_prefix to prefix?
+def our_get_env(key: str, default: Optional[str] = None, raise_if_not_found: bool = True,
+                raise_if_empty: bool = False, optional_prefix: Optional[str] = None) -> Optional[str]:
     """
     Get environment variable with optional prefix fallback.
     
@@ -409,7 +411,7 @@ def our_delete_env(key: str, raise_if_not_found: bool = False) -> None:
 
 
 def get_brand_name(raise_if_not_found: bool = True,
-                   raise_if_empty: bool = False) -> str:
+                   raise_if_empty: bool = False) -> Optional[str]:
     get_brand_name_result = our_get_env("BRAND_NAME",
                                         raise_if_not_found=raise_if_not_found,
                                         raise_if_empty=raise_if_empty)
@@ -417,7 +419,7 @@ def get_brand_name(raise_if_not_found: bool = True,
 
 
 def get_environment_name(raise_if_not_found: bool = True,
-                         raise_if_empty: bool = False) -> str:
+                         raise_if_empty: bool = False) -> Optional[str]:
     environment_name = our_get_env("ENVIRONMENT_NAME",
                                    raise_if_not_found=raise_if_not_found,
                                    raise_if_empty=raise_if_empty)
@@ -430,7 +432,7 @@ def get_environment_name(raise_if_not_found: bool = True,
 
 
 def get_product_user_identifier(raise_if_not_found: bool = True,
-                                raise_if_empty: bool = False) -> str:
+                                raise_if_empty: bool = False) -> Optional[str]:
     get_product_user_identifier_result = our_get_env("PRODUCT_USER_IDENTIFIER",
                                                      raise_if_not_found=raise_if_not_found,  # noqa E501
                                                      raise_if_empty=raise_if_empty)  # noqa E501
@@ -438,7 +440,7 @@ def get_product_user_identifier(raise_if_not_found: bool = True,
 
 
 def get_product_user_password(raise_if_not_found: bool = True,
-                              raise_if_empty: bool = False) -> str:
+                              raise_if_empty: bool = False) -> Optional[str]:
     """
     Get product user password from environment variables.
     
@@ -460,26 +462,26 @@ def get_product_user_password(raise_if_not_found: bool = True,
 
 # Database-specific functions - Consider moving to database package when it's created
 def get_sql_hostname(raise_if_not_found: bool = True,
-                     raise_if_empty: bool = False) -> str:
+                     raise_if_empty: bool = False) -> Optional[str]:
     get_sql_hostname_result = our_get_env("RDS_HOSTNAME",
                                           raise_if_empty=raise_if_empty)
     return get_sql_hostname_result
 
 
-def get_sql_username(raise_if_empty: bool = False) -> str:
+def get_sql_username(raise_if_empty: bool = False) -> Optional[str]:
     get_sql_username_result = our_get_env("RDS_USERNAME",
                                           raise_if_empty=raise_if_empty)
     return get_sql_username_result
 
 
-def get_sql_password(raise_if_empty: bool = False) -> str:
+def get_sql_password(raise_if_empty: bool = False) -> Optional[str]:
     get_sql_password_result = our_get_env("RDS_PASSWORD",
                                           raise_if_empty=raise_if_empty)
     return get_sql_password_result
 
 
 # Dialog-specific function - Consider moving to dialog repo when it's created
-def get_dialog_jwt_secret_key() -> str:
+def get_dialog_jwt_secret_key() -> Optional[str]:
     get_dialog_jwt_secret_key_result = our_get_env("DIALOG_JWT_SECRET_KEY", raise_if_empty=True)
     return get_dialog_jwt_secret_key_result
 
@@ -517,7 +519,7 @@ def obfuscate_log_dict(log_dict: dict) -> dict:
     environment_name = get_environment_name()
     if environment_name == EnvironmentName.PLAY1.value:
         return log_dict
-    obfuscated_log_dict = {}
+    obfuscated_log_dict: dict = {}
     for key, value in log_dict.items():
         if isinstance(value, dict):
             obfuscated_log_dict[key] = obfuscate_log_dict(value)
@@ -542,7 +544,8 @@ def generate_otp():
     return otp
 
 
-def get_current_datetime_string(datetime_format: str = DEFAULT_DATETIME_FORMAT, tz: timezone = None) -> str:
+def get_current_datetime_string(datetime_format: str = DEFAULT_DATETIME_FORMAT,
+                                tz: Optional[timezone] = None) -> str:
     current_datetime_string = datetime.now(tz).strftime(datetime_format)
     return current_datetime_string
 
@@ -557,7 +560,7 @@ def datetime_to_str(input_datetime: datetime, datetime_format: str = DEFAULT_DAT
     return datetime_to_str_result
 
 
-def to_datetime(value: datetime or str) -> datetime:
+def to_datetime(value: Union[datetime, str]) -> datetime:
     """Return a datetime unchanged, or parse an ISO-8601 string into one.
 
     Complements datetime_from_str (which is str-only and uses a strptime format,
@@ -626,7 +629,7 @@ def camel_to_snake(camel_str: str) -> str:
 # We have both deprecation_warning as method in Logger and as a standalone function
 # We can call the deprecation_warning_function from the logger
 @lru_cache(maxsize=64)  # don't print the same warning multiple times
-def deprecation_warning_function(old_name: str, new_name: str, start_date: date = None) -> None:
+def deprecation_warning_function(old_name: str, new_name: str, start_date: Optional[date] = None) -> None:
     if start_date and start_date < date.today():
         return
     warnings_message = f"Please use {new_name} instead of {old_name}."

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.169
+Version: 0.0.170
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

{python_sdk_remote-0.0.169 → python_sdk_remote-0.0.170}/setup.py

@@ -7,7 +7,7 @@ package_dir = PACKAGE_NAME.replace("-", "_")
 # python -m build needs pyproject.toml or setup.py
 setuptools.setup(
     name=PACKAGE_NAME,
-    version='0.0.169',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.170',  # https://pypi.org/project/python-sdk-remote#history
     author="Circles",
     author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",

python_sdk_remote-0.0.169/python_sdk_remote/src/is_test_data.py

@@ -1,4 +0,0 @@
-class IsTestDataEnum:
-    REAL_DATA: 0
-    DATA_FOR_TESTS: 1
-    DATA_GENERETED_BY_TESTS: 2