python-sdk-remote 0.0.127__tar.gz → 0.0.128__tar.gz

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.127
+Version: 0.0.128
 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.128/README.md

@@ -0,0 +1,11 @@
+# TODO: rewrite with more example
+
+In serverless, use this decorator:
+```py
+from python_sdk_remote.http_response import handler_decorator
+from logger_local.Logger import Logger
+logger = Logger.create_logger(object=your_logger_object)
+@handler_decorator(logger=logger)
+def my_handler(request_parameters: dict) -> dict:
+  # here you can use both camelCase and snake_case keys from request_parameters
+```

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/constants.py

@@ -1,17 +1,8 @@
-import os
-
 from logger_local.LoggerComponentEnum import LoggerComponentEnum
 
 PYTHON_SDK_REMOTE_COMPONENT_ID = 184
 PYTHON_SDK_REMOTE_COMPONENT_NAME = 'python_sdk_remote'
 
-ENVIRONMENT_NAME = os.getenv("ENVIRONMENT_NAME")
-BRAND_NAME = os.getenv("BRAND_NAME")
-LOGZIO_TOKEN = os.getenv("LOGZIO_TOKEN")
-# TODO Shall Can we use python-sdk function to get the value from Environment?
-# TODO Shall we get the value from environment here of send the value to the function as @akiva-skolnik did?
-GOOGLE_PORT_FOR_AUTHENTICATION = os.getenv("PORT_FOR_AUTHENTICATION")
-
 OBJECT_TO_INSERT_CODE = {
     'component_id': PYTHON_SDK_REMOTE_COMPONENT_ID,
     'component_name': PYTHON_SDK_REMOTE_COMPONENT_NAME,

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/http_response.py

@@ -1,10 +1,10 @@
-import json
 import traceback
+from functools import wraps
 from http import HTTPStatus
 from typing import Any
 
 from .mini_logger import MiniLogger as logger
-import warnings
+from .utilities import camel_to_snake, snake_to_camel, to_dict, to_json
 
 HEADERS_KEY = 'headers'
 AUTHORIZATION_KEY = 'authorization'
@@ -17,26 +17,65 @@ AUTHORIZATION_PREFIX = 'Bearer '
 # TODO: add handler wrapper?
 
 def get_payload_dict_from_event(event: dict) -> dict:
-    warnings.warn("DELETE get_payload_dict_from_event",DeprecationWarning,stacklevel=2)
     """Extracts params sent with payload"""
-    return json.loads(event.get('body') or '{}')
+    return to_dict(event.get('body'))
 
 
 def get_path_parameters_dict_from_event(event: dict) -> dict:
-    warnings.warn("DELETE get_path_parameters_dict_from_event",DeprecationWarning,stacklevel=2)
     """Extracts params sent implicitly: `url/param?test=5` -> param
     (when the path is defined with /{param})"""
     return event.get('pathParameters') or {}
 
 
 def get_query_string_parameters_from_event(event: dict) -> dict:
-    warnings.warn("DELETE get_query_string_parameters_from_event",DeprecationWarning,stacklevel=2)
     """Extracts params sent explicitly: `url/test?a=1&b=2` ->  {'a': '1', 'b': '2'}"""
     return event.get("queryStringParameters") or {}  # params sent with ?a=1&b=2
 
 
+def get_request_parameters_from_event(event: dict) -> dict:
+    """Extracts all params from the event object.
+    The order of precedence is: payload > path > query string
+    returns a dictionary with all the parameters, with both camelCase and snake_case keys."""
+    all_parameters_dict = get_payload_dict_from_event(event)
+    all_parameters_dict.update(get_path_parameters_dict_from_event(event))
+    all_parameters_dict.update(get_query_string_parameters_from_event(event))
+    all_parameters_dict = {camel_to_snake(key): value for key, value in all_parameters_dict.items()}
+    all_parameters_dict.update({snake_to_camel(key): value for key, value in all_parameters_dict.items()})
+    return all_parameters_dict
+
+
+# TODO: test
+def handler_decorator(logger):
+    """Decorator for AWS Lambda handler functions. It wraps the handler function with logging and error handling.
+    Usage:
+    from python_sdk_remote.http_response import handler_decorator
+    logger = ...
+    @handler_decorator(logger=logger)
+    def my_handler(request_parameters: dict) -> dict:
+        return {"message": "Hello, World!"}"""
+
+    def decorator(handler: callable) -> callable:
+        @wraps(handler)
+        def wrapper(event, context):
+            handler_response = None
+            try:
+                logger.start(object={"event": event, "context": context})
+                request_parameters = get_request_parameters_from_event(event)
+                body_result: dict = handler(request_parameters)
+                handler_response = create_ok_http_response(body_result)
+            except Exception as e:
+                handler_response = create_error_http_response(e)
+            finally:
+                logger.end(object={"handler_response": handler_response})
+            return handler_response
+
+        return wrapper
+
+    return decorator
+
+
+# TODO: should we auto detect user_jwt if not provided?
 def create_authorization_http_headers(user_jwt: str) -> dict:
-    warnings.warn("DELETE create_authorization_http_headers",DeprecationWarning,stacklevel=2)
     logger.start(object={"user_jwt": user_jwt})
     #TODO check the validity of user_jwt and it is not None and raise exception, please do the same in all other functions.
     authorization_http_headers = {
@@ -48,7 +87,6 @@ def create_authorization_http_headers(user_jwt: str) -> dict:
 
 
 def get_user_jwt_from_event(event: dict) -> str:
-    warnings.warn("DELETE get_user_jwt_from_event",DeprecationWarning,stacklevel=2)
     logger.start(object={"event": event})
     auth_header = event.get(HEADERS_KEY, {}).get(AUTHORIZATION_KEY)
     if auth_header is None:
@@ -59,7 +97,6 @@ def get_user_jwt_from_event(event: dict) -> str:
 
 
 def create_return_http_headers() -> dict:
-    warnings.warn("DELETE create_return_http_headers",DeprecationWarning,stacklevel=2)
     logger.start()
     # Adding "Access-Control-Allow-Origin" : "*" to take care of CORS from localhost
     # TODO Do we need to add those? In which cases? try  adding crossDomain: true, to the request, 'Access-Control-Allow-Credentials': true to header
@@ -72,7 +109,6 @@ def create_return_http_headers() -> dict:
 
 
 def create_error_http_response(exception: Exception, status_code: HTTPStatus = HTTPStatus.BAD_REQUEST) -> dict:
-    warnings.warn("DELETE create_error_http_response",DeprecationWarning,stacklevel=2)
     logger.start(object={"exception": exception})
     error_http_response = {
         "statusCode": status_code.value,
@@ -85,12 +121,12 @@ def create_error_http_response(exception: Exception, status_code: HTTPStatus = H
 
 
 def create_ok_http_response(body: Any) -> dict:
-    warnings.warn("DELETE create_ok_http_response",DeprecationWarning,stacklevel=2)
     logger.start(object={"body": body})
+    # TODO: test sending statusCode/headers/body inside the body
     ok_http_response = {
-        "statusCode": HTTPStatus.OK.value,
-        "headers": create_return_http_headers(),
-        "body": create_http_body(body)
+        "statusCode": body.get("statusCode") or HTTPStatus.OK.value,
+        "headers": body.get("headers") or create_return_http_headers(),
+        "body": create_http_body(body.get("body") or body)
     }
     logger.end(object={"ok_http_response": ok_http_response})
     return ok_http_response
@@ -98,10 +134,9 @@ def create_ok_http_response(body: Any) -> dict:
 
 # https://google.github.io/styleguide/jsoncstyleguide.xml?showone=Property_Name_Format#Property_Name_Format
 def create_http_body(body: Any) -> str:
-    warnings.warn("DELETE create_http_body",DeprecationWarning,stacklevel=2)
     # TODO console.warning() if the body is not a valid camelCase JSON
     # https://stackoverflow.com/questions/17156078/converting-identifier-naming-between-camelcase-and-underscores-during-json-seria
     logger.start(object={"body": body})
-    http_body = json.dumps(body)
+    http_body = to_json(body)
     logger.end(object={"http_body": http_body})
     return http_body

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/item.py

@@ -1,13 +1,12 @@
 from abc import abstractmethod
 
 from .our_object import OurObject
-import warnings
+
+
 class Item(OurObject):
     def __init__(self, **kwargs):
-        warnings.warn("DELETE __init__",DeprecationWarning,stacklevel=2)
         super().__init__(**kwargs)
 
     @abstractmethod
     def get_id(self):
-        warnings.warn("DELETE get_id",DeprecationWarning,stacklevel=2)
         raise NotImplementedError("Subclasses must implement the 'get_id' method.")

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/our_object.py

@@ -2,13 +2,11 @@ import json
 from abc import ABC, abstractmethod
 
 from .mini_logger import MiniLogger as logger
-import warnings
 
 
 # TODO Where are we using it? Shall we extend the usage of OurObject as the father of all our entities?
 class OurObject(ABC):
     def __init__(self, **kwargs):
-        warnings.warn("DELETE __init__",DeprecationWarning,stacklevel=2)
         INIT_METHOD_NAME = '__init__'
         logger.start(INIT_METHOD_NAME, object={'kwargs': kwargs})
         self.kwargs = kwargs
@@ -16,13 +14,11 @@ class OurObject(ABC):
 
     @abstractmethod
     def get_name(self):
-        warnings.warn("DELETE get_name",DeprecationWarning,stacklevel=2)
         """Returns the name of the object"""
         raise NotImplementedError(
             "Subclasses must implement the 'get_name' method.")
 
     def get(self, attr_name: str):
-        warnings.warn("DELETE get",DeprecationWarning,stacklevel=2)
         """Returns the value of the attribute with the given name"""
         GET_METHOD_NAME = 'get'
         logger.start(GET_METHOD_NAME, object={'attr_name': attr_name})
@@ -32,17 +28,14 @@ class OurObject(ABC):
         return value
 
     def get_all_arguments(self):
-        warnings.warn("DELETE get_all_arguments",DeprecationWarning,stacklevel=2)
         """Returns all the arguments passed to the constructor as a dictionary"""
         return getattr(self, 'kwargs', None)
 
     def to_json(self) -> str:
-        warnings.warn("DELETE to_json",DeprecationWarning,stacklevel=2)
         """Returns a json string representation of this object"""
         return json.dumps(self.__dict__)
 
     def from_json(self, json_string: str) -> 'OurObject':
-        warnings.warn("DELETE from_json",DeprecationWarning,stacklevel=2)
         """Returns an instance of the class from a json string"""
         FROM_JSON_METHOD_NAME = 'from_json'
         logger.start(FROM_JSON_METHOD_NAME,
@@ -53,13 +46,11 @@ class OurObject(ABC):
         return self
 
     def __eq__(self, other) -> bool:
-        warnings.warn("DELETE __eq__",DeprecationWarning,stacklevel=2)
         """Checks if two objects are equal"""
         if not isinstance(other, OurObject):
             return False
         return self.__dict__ == other.__dict__
 
     def __ne__(self, other) -> bool:
-        warnings.warn("DELETE __ne__",DeprecationWarning,stacklevel=2)
         """Checks if two objects are not equal"""
         return not self.__eq__(other)

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/unified_json.py

@@ -1,11 +1,9 @@
 from .valid_json_versions import valid_json_versions
-import warnings
 
 
 # TODO Shall we merge it with the machine-learning-unified-json?
 class UnifiedJson:
     def __init__(self, data: dict, json_version: str):
-        warnings.warn("DELETE __init__",DeprecationWarning,stacklevel=2)
         if json_version not in valid_json_versions:
             raise Exception(
                 f"version {json_version} is not in valid_json_versions {valid_json_versions}, "
@@ -15,21 +13,16 @@ class UnifiedJson:
         self.data = data
 
     def get_unified_json(self):
-        warnings.warn("DELETE get_unified_json",DeprecationWarning,stacklevel=2)
         return {"version": self.json_version, "data": self.data}
 
     def get_data(self):
-        warnings.warn("DELETE get_data",DeprecationWarning,stacklevel=2)
         return self.data
 
     def get_json_version(self):
-        warnings.warn("DELETE get_json_version",DeprecationWarning,stacklevel=2)
         return self.json_version
 
     def __str__(self):
-        warnings.warn("DELETE __str__",DeprecationWarning,stacklevel=2)
         return self.get_unified_json()
 
     def __repr__(self):
-        warnings.warn("DELETE __repr__",DeprecationWarning,stacklevel=2)
         return self.__str__()

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote/src/utilities.py

@@ -1,21 +1,18 @@
+import inspect
 import json
-import jwt
-import requests
-import re
 import os
 import random
+import re
 from datetime import date, datetime, time, timedelta, timezone
+from functools import lru_cache
 from urllib.parse import urlparse
-import warnings
 
+import jwt
+import requests
 from dotenv import load_dotenv
 from url_remote.environment_name_enum import EnvironmentName
 
 from .mini_logger import MiniLogger as logger
-from .http_response import (create_authorization_http_headers,  # noqa - used for backwards compatibility
-                            get_user_jwt_from_event,
-                            create_return_http_headers, create_error_http_response, create_ok_http_response,
-                            create_http_body)
 
 load_dotenv()
 # TODO Let's do brainstorming on this
@@ -36,13 +33,11 @@ DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
 
 
 def append_if_not_exist(lst: list, item: object) -> None:
-    warnings.warn("DELETE append_if_not_exist",DeprecationWarning,stacklevel=2)
     if item not in lst:
         lst.append(item)
 
 
 def to_dict(data: json or dict or None) -> dict:
-    warnings.warn("DELETE to_dict",DeprecationWarning,stacklevel=2)
     if data is None:
         return {}
     if isinstance(data, dict):
@@ -51,7 +46,6 @@ def to_dict(data: json or dict or None) -> dict:
 
 
 def to_json(data: json or dict or None) -> json:
-    warnings.warn("DELETE to_json",DeprecationWarning,stacklevel=2)
     if data is None:
         data = {}
     if isinstance(data, dict):
@@ -60,7 +54,6 @@ def to_json(data: json or dict or None) -> json:
 
 
 def timedelta_to_time_format(time_delta: timedelta) -> str:
-    warnings.warn("DELETE timedelta_to_time_format",DeprecationWarning,stacklevel=2)
     """
     Convert a timedelta to a time format in HH:MM:SS.
 
@@ -97,7 +90,6 @@ def timedelta_to_time_format(time_delta: timedelta) -> str:
 
 
 def is_valid_time_range(time_range: tuple) -> bool:
-    warnings.warn("DELETE is_valid_time_range",DeprecationWarning,stacklevel=2)
     """
     Validate that the time range is in the format 'HH:MM:SS'.
     """
@@ -124,7 +116,6 @@ def is_valid_time_range(time_range: tuple) -> bool:
 # TODO shall we also use Url type and not only str? - Strongly Type which I prefer
 #   (if yes we should change it also in all the calls to this function)
 def validate_url(url: str):
-    warnings.warn("DELETE validate_url",DeprecationWarning,stacklevel=2)
     logger.start(object={"url": url})
     if url is not None or url != "":
         parsed_url = urlparse(url)
@@ -136,7 +127,6 @@ def validate_url(url: str):
 
 
 def is_valid_date_range(date_range: tuple) -> bool:
-    warnings.warn("DELETE is_valid_date_range",DeprecationWarning,stacklevel=2)
     """
     Validate that the date range is in the format 'YYYY-MM-DD'.
     """
@@ -155,7 +145,6 @@ def is_valid_date_range(date_range: tuple) -> bool:
 
 
 def is_valid_datetime_range(datetime_range: (datetime, datetime)) -> bool:
-    warnings.warn("DELETE is_valid_datetime_range",DeprecationWarning,stacklevel=2)
     """
     Validate that the datetime range is in the format 'YYYY-MM-DD HH:MM:SS'.
     """
@@ -173,7 +162,6 @@ def is_valid_datetime_range(datetime_range: (datetime, datetime)) -> bool:
 
 
 def is_list_of_dicts(obj: object) -> bool:
-    warnings.warn("DELETE is_list_of_dicts",DeprecationWarning,stacklevel=2)
     """
     Check if an object is a list of dictionaries.
 
@@ -218,7 +206,6 @@ def is_list_of_dicts(obj: object) -> bool:
 
 
 def is_time_in_time_range(check_time: time, time_range: tuple) -> bool:
-    warnings.warn("DELETE is_time_in_time_range",DeprecationWarning,stacklevel=2)
     """
     Check if the given time is within the specified time range.
 
@@ -242,7 +229,6 @@ def is_time_in_time_range(check_time: time, time_range: tuple) -> bool:
 
 
 def is_date_in_date_range(check_date: date, date_range: tuple) -> bool:
-    warnings.warn("DELETE is_date_in_date_range",DeprecationWarning,stacklevel=2)
     """
     Check if the given date is within the specified date range.
 
@@ -267,7 +253,6 @@ def is_date_in_date_range(check_date: date, date_range: tuple) -> bool:
 
 
 def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (datetime, datetime)) -> bool:
-    warnings.warn("DELETE is_datetime_in_datetime_range",DeprecationWarning,stacklevel=2)
     """
     Check if the given datetime is within the specified datetime range.
 
@@ -331,7 +316,6 @@ def get_dialog_jwt_secret_key() -> str:
 
 
 def encode_jwt(payload: dict, key: str) -> str:
-    warnings.warn("DELETE encode_jwt",DeprecationWarning,stacklevel=2)
     """Example:
     payload = {
         "user_id": 123,
@@ -343,7 +327,6 @@ def encode_jwt(payload: dict, key: str) -> str:
 
 
 def decode_jwt(token: str, key: str) -> dict:
-    warnings.warn("DELETE decode_jwt",DeprecationWarning,stacklevel=2)
     """key can be private / public"""
     return jwt.decode(token, key, algorithms=['HS256'])
 
@@ -369,44 +352,39 @@ def obfuscate_log_dict(log_dict: dict) -> dict:
         if isinstance(value, dict):
             obfuscated_log_dict[key] = obfuscate_log_dict(value)
         elif re.search(r'password|secret|token|jwt|e[\-_]?mail|phone|name|address|ssn', key, re.IGNORECASE):
-           # TODO Maybe we can reveal a small part
+            # TODO Maybe we can reveal a small part
             obfuscated_log_dict[key] = "***"
         else:
             obfuscated_log_dict[key] = value
     return obfuscated_log_dict
 
+
 # TODO: add tests to the following functions
 
 def remove_digits(text: str) -> str:
-    warnings.warn("DELETE remove_digits",DeprecationWarning,stacklevel=2)
     return ''.join(i for i in text if not i.isdigit())
 
 
 def generate_otp():
-    warnings.warn("DELETE generate_otp",DeprecationWarning,stacklevel=2)
     """Generates a 6-digit OTP"""
     otp = random.randint(100000, 999999)
     return otp
 
 
 def get_current_datetime_string(datetime_format: str = DEFAULT_DATETIME_FORMAT, tz: timezone = None) -> str:
-    warnings.warn("DELETE get_current_datetime_string",DeprecationWarning,stacklevel=2)
     current_datetime_string = datetime.now(tz).strftime(datetime_format)
     return current_datetime_string
 
 
 def datetime_from_str(date_str: str, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> datetime:
-    warnings.warn("DELETE datetime_from_str",DeprecationWarning,stacklevel=2)
     return datetime.strptime(date_str, datetime_format)
 
 
 def datetime_to_str(input_datetime: datetime, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> str:
-    warnings.warn("DELETE datetime_to_str",DeprecationWarning,stacklevel=2)
     return input_datetime.strftime(datetime_format)
 
 
 def validate_arguments(args: dict) -> None:
-    warnings.warn("DELETE validate_arguments",DeprecationWarning,stacklevel=2)
     """
     Validate method arguments to ensure they are not None or ''
     :param args: arguments to be validated (usually locals())
@@ -418,7 +396,6 @@ def validate_arguments(args: dict) -> None:
 
 
 def reformat_time_string(input_str: str) -> str:
-    warnings.warn("DELETE reformat_time_string",DeprecationWarning,stacklevel=2)
     """Example:
     "1234" -> "12:34:00:00"
     """
@@ -432,10 +409,33 @@ def reformat_time_string(input_str: str) -> str:
 
 
 def get_ip_v4():
-    warnings.warn("DELETE get_ip_v4",DeprecationWarning,stacklevel=2)
     return requests.get('https://ipv4.seeip.org/jsonip').json()['ip']
 
 
 def get_ip_v6():
-    warnings.warn("DELETE get_ip_v6",DeprecationWarning,stacklevel=2)
     return requests.get('https://api.seeip.org/jsonip').json()['ip']
+
+
+def snake_to_camel(snake_str: str) -> str:
+    """Converts snake_case to camelCase."""
+    components = snake_str.split('_')
+    camel_str = components[0] + ''.join(x.title() for x in components[1:])
+    return camel_str
+
+
+def camel_to_snake(camel_str: str) -> str:
+    """Converts camelCase to snake_case."""
+    snake_str = re.sub(r'(?<!^)(?=[A-Z])', '_', camel_str).lower()
+    return snake_str
+
+
+@lru_cache(maxsize=64)  # don't print the same warning multiple times
+def deprecation_warning(old_name: str, new_name: str, start_date: date = None) -> None:
+    if start_date and start_date < date.today():
+        return
+    warnings_message = f"Please use {old_name} instead of {new_name}."
+    try:
+        warnings_message += " Called from: " + inspect.stack()[2].filename
+    except Exception:
+        pass
+    logger.warning(warnings_message)

{python_sdk_remote-0.0.127 → python_sdk_remote-0.0.128}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.127
+Version: 0.0.128
 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.127 → python_sdk_remote-0.0.128}/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.127',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.128',  # https://pypi.org/project/python-sdk-remote/
     author="Circles",
     author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",

python_sdk_remote-0.0.127/README.md

@@ -1,27 +0,0 @@
-# python-sdk-package
-
-https://github.com/grosser/repo_dependency_graph Ruby, Graph the dependencies of your repositories
-https://github.com/thebjorn/pydeps Python
-
-To create local package and remote package layers (not to create GraphQL and REST-API layers)
-
-#database Python scripts in /db folder
-Please place <table-name>.py in /db<br>
-No need for seperate file for _ml table<br>
-Please delete the example file if not needed<br>
-
-# Create the files to create the database schema, tables, view and populate Meta Data and Test Date
-
-/db/<table-name>.py - CREATE SCHEMA ... CREATE TABLE ... CREATE VIEW ...<br>
-/db/<table-name>_insert.py to create records
-
-# Update the setup.py (i.e.name, version)
-
-# Please create test directory inside the directory of the project i.e. /<project-name>/tests
-
-# Update the serverless.yml in the root directory
-
-provider:
-stage: play1
-
-Update the endpoints in serverless.yml