python-sdk-remote 0.0.122__tar.gz → 0.0.125__tar.gz

{python_sdk_remote-0.0.122 → python_sdk_remote-0.0.125}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.122
+Version: 0.0.125
 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.125/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.122 → python_sdk_remote-0.0.125}/python_sdk_remote/src/http_response.py

@@ -1,9 +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
+from .utilities import camel_to_snake, snake_to_camel, to_dict, to_json
 
 HEADERS_KEY = 'headers'
 AUTHORIZATION_KEY = 'authorization'
@@ -17,7 +18,7 @@ AUTHORIZATION_PREFIX = 'Bearer '
 
 def get_payload_dict_from_event(event: dict) -> dict:
     """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:
@@ -32,13 +33,19 @@ def get_query_string_parameters_from_event(event: dict) -> dict:
 
 
 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_params = get_payload_dict_from_event(event)
     all_params.update(get_path_parameters_dict_from_event(event))
     all_params.update(get_query_string_parameters_from_event(event))
+    all_params = {camel_to_snake(key): value for key, value in all_params.items()}
+    all_params.update({snake_to_camel(key): value for key, value in all_params.items()})
     return all_params
 
+
 # TODO: test
-def handler_decorator(handler: callable, logger=logger):
+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
@@ -47,22 +54,27 @@ def handler_decorator(handler: callable, logger=logger):
     def my_handler(request_parameters: dict) -> dict:
         return {"message": "Hello, World!"}"""
 
-    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
+    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 wrapper
+    return decorator
 
 
+# TODO: should we auto detect user_jwt if not provided?
 def create_authorization_http_headers(user_jwt: str) -> dict:
     logger.start(object={"user_jwt": user_jwt})
     authorization_http_headers = {
@@ -107,10 +119,11 @@ def create_error_http_response(exception: Exception, status_code: HTTPStatus = H
 
 def create_ok_http_response(body: Any) -> dict:
     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
@@ -121,6 +134,6 @@ def create_http_body(body: Any) -> str:
     # 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.122 → python_sdk_remote-0.0.125}/python_sdk_remote/src/utilities.py

@@ -1,20 +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 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
@@ -354,12 +352,13 @@ 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:
@@ -415,3 +414,26 @@ def get_ip_v4():
 
 def get_ip_v6():
     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):
+    warnings_message = f"Please use {old_name} instead of {new_name}."
+    try:
+        warnings_message += " Called from: " + inspect.stack()[1].filename
+    except Exception:
+        pass
+    logger.warning(warnings_message)

{python_sdk_remote-0.0.122 → python_sdk_remote-0.0.125}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.122
+Version: 0.0.125
 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.122 → python_sdk_remote-0.0.125}/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.122',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.125',  # 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.122/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