osbot-utils 2.1.0__tar.gz → 2.3.0__tar.gz

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.1.0
+Version: 2.3.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v2.1.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.3.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/README.md

@@ -2,7 +2,7 @@
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v2.1.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.3.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/osbot_utils/helpers/sqlite/Sqlite__Table__Create.py

@@ -1,6 +1,5 @@
 import inspect
-from typing import List
-
+from typing                                                 import List
 from osbot_utils.base_classes.Kwargs_To_Self                import Kwargs_To_Self
 from osbot_utils.decorators.lists.filter_list               import filter_list
 from osbot_utils.helpers.sqlite.Sqlite__Field               import Sqlite__Field
@@ -17,8 +16,8 @@ class Sqlite__Table__Create(Kwargs_To_Self):
         self.set_default_fields()
 
     def add_field(self, field_data: dict):
-        sqlite_field = Sqlite__Field.from_json(field_data)
-        if sqlite_field:
+        if field_data and isinstance(field_data, dict):
+            sqlite_field = Sqlite__Field.from_json(field_data)
             self.fields.append(sqlite_field)
             return True
         return False

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/osbot_utils/helpers/sqlite/sample_data/Sqlite__Sample_Data__Chinook.py

@@ -1,16 +1,10 @@
-from osbot_utils.base_classes.Kwargs_To_Self import Kwargs_To_Self
-from osbot_utils.decorators.methods.cache_on_self import cache_on_self
-from osbot_utils.helpers.sqlite.Sqlite__Database import Sqlite__Database
-from osbot_utils.helpers.sqlite.Sqlite__Table import Sqlite__Table
-from osbot_utils.helpers.sqlite.Sqlite__Table__Create import Sqlite__Table__Create
-from osbot_utils.helpers.sqlite.domains.Sqlite__DB__Json import Sqlite__DB__Json
-from osbot_utils.testing.Duration import duration, Duration
-from osbot_utils.utils.Dev import pprint
-from osbot_utils.utils.Files import current_temp_folder, path_combine, folder_create, file_exists, file_not_exists, \
-    file_contents
-from osbot_utils.utils.Http import GET, GET_to_file
-from osbot_utils.utils.Json import json_loads, json_from_file, json_dump, json_file_create, json_file_load
-from osbot_utils.utils.Objects import obj_info
+from osbot_utils.base_classes.Kwargs_To_Self                import Kwargs_To_Self
+from osbot_utils.decorators.methods.cache_on_self           import cache_on_self
+from osbot_utils.helpers.sqlite.Sqlite__Database            import Sqlite__Database
+from osbot_utils.helpers.sqlite.domains.Sqlite__DB__Json    import Sqlite__DB__Json
+from osbot_utils.utils.Files                                import current_temp_folder, path_combine, folder_create, file_not_exists
+from osbot_utils.utils.Http                                 import GET_to_file
+from osbot_utils.utils.Json                                 import  json_from_file, json_file_create, json_file_load
 
 URL__CHINOOK_JSON                = 'https://github.com/lerocha/chinook-database/releases/download/v1.4.5/ChinookData.json'
 FILE_NAME__CHINOOK_DATA_JSON     = 'ChinookData.json'

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/osbot_utils/helpers/xml/rss/RSS__Channel.py

@@ -1,5 +1,5 @@
 from typing                                     import Any, Dict, List
-from osbot_utils.type_safe.Type_Safe         import Type_Safe
+from osbot_utils.type_safe.Type_Safe            import Type_Safe
 from osbot_utils.helpers.xml.rss.RSS__Image     import RSS__Image
 from osbot_utils.helpers.xml.rss.RSS__Item      import RSS__Item
 

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/osbot_utils/type_safe/Type_Safe.py

@@ -24,7 +24,7 @@ if sys.version_info < (3, 8):                                           # pragma
         else:
             return ()
 else:
-    from typing import get_origin, get_args, ForwardRef
+    from typing import get_origin, get_args, ForwardRef, Any
     from osbot_utils.helpers.python_compatibility.python_3_8 import Annotated
 
 if sys.version_info >= (3, 10):
@@ -117,12 +117,16 @@ class Type_Safe:
         # todo: refactor this to separate method
         if hasattr(annotations, 'get'):
             annotation = annotations.get(name)
-            if annotation and get_origin(annotation) is Annotated:
-                annotation_args = get_args(annotation)
-                target_type = annotation_args[0]
-                for attribute in annotation_args[1:]:
-                    if isinstance(attribute, Type_Safe__Validator):
-                        attribute.validate(value=value, field_name=name, target_type=target_type)
+            if annotation:
+                annotation_origin = get_origin(annotation)
+                if annotation_origin is Annotated:
+                    annotation_args = get_args(annotation)
+                    target_type = annotation_args[0]
+                    for attribute in annotation_args[1:]:
+                        if isinstance(attribute, Type_Safe__Validator):
+                            attribute.validate(value=value, field_name=name, target_type=target_type)
+                elif annotation_origin is dict:
+                    value = self.deserialize_dict__using_key_value_annotations(name, value)
 
         super().__setattr__(name, value)
 
@@ -341,8 +345,12 @@ class Type_Safe:
             else:
                 new__dict_key = key_class(dict_key)
 
-            if issubclass(value_class, Type_Safe):
+            if type(dict_value) == value_class:                                        # if the value is already the target, then just use it
+                new__dict_value = dict_value
+            elif issubclass(value_class, Type_Safe):
                 new__dict_value = value_class().deserialize_from_dict(dict_value)
+            elif value_class is Any:
+                new__dict_value = dict_value
             else:
                 new__dict_value = value_class(dict_value)
             new_value[new__dict_key] = new__dict_value
@@ -353,7 +361,7 @@ class Type_Safe:
     def deserialize_from_dict(self, data, raise_on_not_found=False):
         from decimal                                    import Decimal
         from enum                                       import EnumMeta
-        from osbot_utils.type_safe.Type_Safe__List   import Type_Safe__List
+        from osbot_utils.type_safe.Type_Safe__List      import Type_Safe__List
         from osbot_utils.helpers.Random_Guid            import Random_Guid
         from osbot_utils.helpers.Random_Guid_Short      import Random_Guid_Short
         from osbot_utils.utils.Objects                  import obj_is_attribute_annotation_of_type
@@ -362,6 +370,9 @@ class Type_Safe:
         from osbot_utils.helpers.Safe_Id                import Safe_Id
         from osbot_utils.helpers.Timestamp_Now          import Timestamp_Now
 
+        if hasattr(data, 'items') is False:
+            raise ValueError(f"Expected a dictionary, but got '{type(data)}'")
+
         for key, value in data.items():
             if hasattr(self, key) and isinstance(getattr(self, key), Type_Safe):
                 getattr(self, key).deserialize_from_dict(value)                                             # if the attribute is a Type_Safe object, then also deserialize it
@@ -432,7 +443,7 @@ class Type_Safe:
             json_data = json_parse(json_data)
         if json_data:                                           # if there is no data or is {} then don't create an object (since this could be caused by bad data being provided)
             return cls().deserialize_from_dict(json_data,raise_on_not_found=raise_on_not_found)
-        return None
+        return cls()
 
 # todo: see if it is possible to add recursive protection to this logic
 def serialize_to_dict(obj):

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/osbot_utils/type_safe/Type_Safe_Method.py

@@ -1,15 +1,22 @@
 import inspect                                                                            # For function introspection
 from enum     import Enum
-from typing   import get_args, get_origin, Optional, Union, List, Any, Dict               # For type hinting utilities
+from typing   import get_args, get_origin, Union, List, Any                              # For type hinting utilities
 
 
 class Type_Safe_Method:                                                                   # Class to handle method type safety validation
     def __init__(self, func):                                                             # Initialize with function
         self.func         = func                                                          # Store original function
         self.sig          = inspect.signature(func)                                       # Get function signature
-        self.annotations  = func.__annotations__                                          # Get type annotations
+        self.annotations  = func.__annotations__                                          # Get function annotations
+
+    def check_for_any_use(self):
+        for param_name, type_hint in self.annotations.items():
+            if type_hint is any:  # Detect incorrect usage of lowercase any
+                raise ValueError(f"Parameter '{param_name}' uses lowercase 'any' instead of 'Any' from typing module. "
+                              f"Please use 'from typing import Any' and annotate as '{param_name}: Any'")
 
     def handle_type_safety(self, args: tuple, kwargs: dict):                              # Main method to handle type safety
+        self.check_for_any_use()
         bound_args = self.bind_args(args, kwargs)                                         # Bind arguments to parameters
         for param_name, param_value in bound_args.arguments.items():                      # Iterate through arguments
             if param_name != 'self':                                                      # Skip self parameter
@@ -107,5 +114,6 @@ class Type_Safe_Method:
 
     def validate_direct_type(self, param_name: str,                               # Validate direct type match
                            param_value: Any, expected_type: Any):                  # Type parameters
-        if not isinstance(param_value, expected_type):                            # Check type match
-            raise ValueError(f"Parameter '{param_name}' expected type {expected_type}, but got {type(param_value)}")  # Raise error if no match
+        if expected_type is not Any:
+            if not isinstance(param_value, expected_type):                            # Check type match
+                raise ValueError(f"Parameter '{param_name}' expected type {expected_type}, but got {type(param_value)}")  # Raise error if no match

osbot_utils-2.3.0/osbot_utils/version

@@ -0,0 +1 @@
+v2.3.0

{osbot_utils-2.1.0 → osbot_utils-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name        = "osbot_utils"
-version     = "v2.1.0"
+version     = "v2.3.0"
 description = "OWASP Security Bot - Utils"
 authors     = ["Dinis Cruz <dinis.cruz@owasp.org>"]
 license     = "MIT"

osbot_utils-2.1.0/osbot_utils/version

@@ -1 +0,0 @@
-v2.1.0