osbot-utils 2.59.0__tar.gz → 2.61.0__tar.gz

{osbot_utils-2.59.0 → osbot_utils-2.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: osbot_utils
-Version: 2.59.0
+Version: 2.61.0
 Summary: OWASP Security Bot - Utils
 License: MIT
 Author: Dinis Cruz
@@ -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.59.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.61.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.59.0 → osbot_utils-2.61.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.59.0-blue)
+![Current Release](https://img.shields.io/badge/release-v2.61.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.59.0 → osbot_utils-2.61.0}/osbot_utils/helpers/html/Html__To__Html_Document.py

@@ -3,13 +3,12 @@ from osbot_utils.helpers.html.Html__To__Html_Dict           import Html__To__Htm
 from osbot_utils.helpers.html.schemas.Schema__Html_Document import Schema__Html_Document
 from osbot_utils.type_safe.Type_Safe                        import Type_Safe
 
-
 class Html__To__Html_Document(Type_Safe):
     html: str
     html__dict    : dict
     html__document: Schema__Html_Document
 
-    def convert(self):
+    def convert(self) -> Schema__Html_Document:
         if self.html:
             html__dict =  Html__To__Html_Dict(self.html).convert()
             if html__dict:

{osbot_utils-2.59.0 → osbot_utils-2.61.0}/osbot_utils/helpers/html/schemas/Schema__Html_Node.py

@@ -4,7 +4,7 @@ from osbot_utils.type_safe.Type_Safe                          import Type_Safe
 
 
 class Schema__Html_Node(Type_Safe):
-    attrs    : Dict[str, Optional[str]]                                               # HTML attributes (e.g., {'class': 'container'})
+    attrs    : Dict[str, Optional[str]]                                     # HTML attributes (e.g., {'class': 'container'}) # todo: see what Safe_Ster we can use for these name attrs
     nodes    : List[Union['Schema__Html_Node', Schema__Html_Node__Data]]    # Child nodes (recursive structure)
-    tag      : str                                                          # HTML tag name (e.g., 'div', 'meta', 'title')
+    tag      : str                                                          # HTML tag name (e.g., 'div', 'meta', 'title')  # todo: see what Safe_Ster we can use for the tag
 

osbot_utils-2.61.0/osbot_utils/helpers/safe_float/Safe_Float.py

@@ -0,0 +1,155 @@
+import math
+from decimal import Decimal, ROUND_HALF_UP, InvalidOperation
+from typing import Optional, Union
+
+class Safe_Float(float):                             # Base class for type-safe floats with validation rules
+
+    min_value      : Optional[float] = None
+    max_value      : Optional[float] = None
+    allow_none     : bool            = True
+    allow_bool     : bool            = False
+    allow_str      : bool            = True
+    allow_int      : bool            = True
+    strict_type    : bool            = False
+    decimal_places : Optional[int]   = None
+
+    # Precision handling options
+    use_decimal    : bool            = False
+    epsilon        : float           = 1e-9
+    round_output   : bool            = True
+    clamp_to_range : bool            = False
+
+    def __new__(cls, value: Optional[Union[float, int, str]] = None) -> 'Safe_Float':
+        if value is None:
+            if cls.allow_none:
+                return super().__new__(cls, 0.0)
+            else:
+                raise ValueError(f"{cls.__name__} does not allow None values")
+
+        # Store original value for range checking
+        original_value = value
+
+        # Convert to float
+        if isinstance(value, str):
+            if not cls.allow_str:
+                raise TypeError(f"{cls.__name__} does not allow string conversion")
+            try:
+                if cls.use_decimal:
+                    value = Decimal(value)
+                else:
+                    value = float(value)
+            except (ValueError, InvalidOperation):
+                raise ValueError(f"Cannot convert '{value}' to float")
+        elif isinstance(value, bool):
+            if not cls.allow_bool:
+                raise TypeError(f"{cls.__name__} does not allow boolean values")
+            value = float(value)
+        elif isinstance(value, int):
+            if not cls.allow_int:
+                raise TypeError(f"{cls.__name__} does not allow integer conversion")
+            if cls.use_decimal:
+                value = Decimal(value)
+            else:
+                value = float(value)
+        elif isinstance(value, float):
+            if math.isinf(value):
+                raise ValueError(f"{cls.__name__} does not allow infinite values")
+            if math.isnan(value):
+                raise ValueError(f"{cls.__name__} does not allow NaN values")
+
+            if cls.use_decimal:
+                value = Decimal(str(value))
+        elif not isinstance(value, (float, Decimal)):
+            raise TypeError(f"{cls.__name__} requires a float value, got {type(value).__name__}")
+
+        # Get numeric value for range checking (before rounding)
+        check_value = float(value) if isinstance(value, Decimal) else value
+
+        # Range validation BEFORE rounding (unless clamping)
+        if not cls.clamp_to_range:
+            if cls.min_value is not None and check_value < cls.min_value:
+                raise ValueError(f"{cls.__name__} must be >= {cls.min_value}, got {check_value}")
+            if cls.max_value is not None and check_value > cls.max_value:
+                raise ValueError(f"{cls.__name__} must be <= {cls.max_value}, got {check_value}")
+
+        # NOW do rounding
+        if isinstance(value, Decimal) and cls.decimal_places is not None:
+            value = value.quantize(Decimal(f'0.{"0" * cls.decimal_places}'), rounding=ROUND_HALF_UP)
+
+        if isinstance(value, Decimal):
+            value = float(value)
+
+        # Check again for special values
+        if math.isinf(value):
+            raise ValueError(f"{cls.__name__} does not allow infinite values")
+        if math.isnan(value):
+            raise ValueError(f"{cls.__name__} does not allow NaN values")
+
+        # Clean up floating point errors (only if not already handled by Decimal)
+        if cls.round_output and cls.decimal_places is not None and not cls.use_decimal:
+            value = cls.__clean_float(value, cls.decimal_places)
+
+        # Handle clamping AFTER rounding
+        if cls.clamp_to_range:
+            if cls.min_value is not None and value < cls.min_value:
+                value = cls.min_value
+            if cls.max_value is not None and value > cls.max_value:
+                value = cls.max_value
+
+        return super().__new__(cls, value)
+
+    def __truediv__(self, other):
+        # Simple and safe - no special handling for infinity
+        if float(other) == 0:
+            raise ZeroDivisionError(f"{self.__class__.__name__} division by zero")
+
+        if self.use_decimal:
+            result = float(Decimal(str(float(self))) / Decimal(str(float(other))))
+        else:
+            result = float(self) / float(other)
+
+        # Check for overflow/underflow
+        if math.isinf(result) or math.isnan(result):
+            raise OverflowError(f"Division resulted in {result}")
+
+        if self.round_output and self.decimal_places is not None:
+            result = self.__clean_float(result, self.decimal_places)
+
+        try:
+            return self.__class__(result)
+        except (ValueError, TypeError):
+            return result
+
+    @classmethod
+    def __clean_float(cls, value: float, decimal_places: int) -> float:             # Clean up floating point representation errors
+        rounded = round(value, decimal_places + 2)                                  # First, round to eliminate tiny errors
+
+        # Check if very close to a clean decimal
+        str_val = f"{rounded:.{decimal_places + 2}f}"
+        if str_val.endswith('999999') or str_val.endswith('000001'):
+            # Use Decimal for exact rounding
+            d = Decimal(str(value))
+            return float(d.quantize(Decimal(f'0.{"0" * decimal_places}'), rounding=ROUND_HALF_UP))
+
+        return round(value, decimal_places) if decimal_places else value
+
+    def __mul__(self, other):
+        if self.use_decimal:
+            result = float(Decimal(str(float(self))) * Decimal(str(float(other))))
+        else:
+            result = float(self) * float(other)
+
+        if self.round_output and self.decimal_places is not None:
+            if not (math.isinf(result) or math.isnan(result)):
+                result = self.__clean_float(result, self.decimal_places)
+
+        try:
+            return self.__class__(result)
+        except (ValueError, TypeError):
+            return result
+
+    def __eq__(self, other):
+        """Equality with epsilon tolerance"""
+        if isinstance(other, (int, float)):
+            return abs(float(self) - float(other)) < self.epsilon
+        return super().__eq__(other)

osbot_utils-2.61.0/osbot_utils/helpers/safe_float/Safe_Float__Engineering.py

@@ -0,0 +1,7 @@
+from osbot_utils.helpers.safe_float.Safe_Float import Safe_Float
+
+class Safe_Float__Engineering(Safe_Float):          # Engineering calculations with controlled precision
+    #decimal_places  = 6
+    epsilon         = 1e-6
+    round_output    = True
+    use_decimal     = False                         # Performance over exactness

osbot_utils-2.61.0/osbot_utils/helpers/safe_float/Safe_Float__Money.py

@@ -0,0 +1,11 @@
+# Safe_Float__Money.py
+from osbot_utils.helpers.safe_float.Safe_Float import Safe_Float
+
+
+class Safe_Float__Money(Safe_Float):    # Money calculations with exact decimal arithmetic
+    decimal_places  = 2
+    use_decimal     = True              # Use Decimal internally
+    allow_inf       = False
+    allow_nan       = False
+    min_value       = 0.0
+    round_output    = True

osbot_utils-2.61.0/osbot_utils/helpers/safe_float/Safe_Float__Percentage_Exact.py

@@ -0,0 +1,9 @@
+from osbot_utils.helpers.safe_float.Safe_Float import Safe_Float
+
+
+class Safe_Float__Percentage_Exact(Safe_Float):         # Exact percentage calculations
+    min_value       = 0.0
+    max_value       = 100.0
+    decimal_places  = 2
+    use_decimal     = True
+    round_output    = True

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_Int.py

@@ -0,0 +1,77 @@
+from typing import Optional, Union
+
+from osbot_utils.helpers.safe_float.Safe_Float import Safe_Float
+
+
+class Safe_Int(int):            # Base class for type-safe integers with validation rules
+
+    min_value      : Optional[int] = None    # Minimum allowed value (inclusive)
+    max_value      : Optional[int] = None    # Maximum allowed value (inclusive)
+    allow_none     : bool          = True    # Whether None is allowed as input
+    allow_bool     : bool          = False   # Whether bool is allowed as input
+    allow_str      : bool          = True    # Whether string conversion is allowed
+    strict_type    : bool          = False   # If True, only accept int type (no conversions)
+
+    def __new__(cls, value: Optional[Union[int, str]] = None) -> 'Safe_Int':
+        # Handle None input
+        if value is None:
+            if cls.allow_none:
+                return super().__new__(cls, 0)  # Default to 0 for None
+            else:
+                raise ValueError(f"{cls.__name__} does not allow None values")
+
+        # Strict type checking
+        if cls.strict_type and not isinstance(value, int):
+            raise TypeError(f"{cls.__name__} requires int type, got {type(value).__name__}")
+
+        # Type conversion
+        if isinstance(value, str):
+            if not cls.allow_str:
+                raise TypeError(f"{cls.__name__} does not allow string conversion")
+            try:
+                value = int(value)
+            except ValueError:
+                raise ValueError(f"Cannot convert '{value}' to integer")
+
+        elif isinstance(value, bool):
+            if not cls.allow_bool:
+                raise TypeError(f"{cls.__name__} does not allow boolean values")
+            value = int(value)
+
+        elif not isinstance(value, int):
+            raise TypeError(f"{cls.__name__} requires an integer value, got {type(value).__name__}")
+
+        # Range validation
+        if cls.min_value is not None and value < cls.min_value:
+            raise ValueError(f"{cls.__name__} must be >= {cls.min_value}, got {value}")
+
+        if cls.max_value is not None and value > cls.max_value:
+            raise ValueError(f"{cls.__name__} must be <= {cls.max_value}, got {value}")
+
+        return super().__new__(cls, value)
+
+    # Arithmetic operations that maintain type safety
+    def __add__(self, other):
+        result = super().__add__(other)
+        try:
+            return self.__class__(result)
+        except (ValueError, TypeError):
+            return result  # Return plain int if validation fails
+
+    def __sub__(self, other):
+        result = super().__sub__(other)
+        try:
+            return self.__class__(result)
+        except (ValueError, TypeError):
+            return result
+
+    def __mul__(self, other):
+        result = super().__mul__(other)
+        try:
+            return self.__class__(result)
+        except (ValueError, TypeError):
+            return result
+
+    def __truediv__(self, other):
+        result = super().__truediv__(other)
+        return Safe_Float(result)

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_UInt.py

@@ -0,0 +1,7 @@
+from osbot_utils.helpers.safe_int.Safe_Int import Safe_Int
+
+class Safe_UInt(Safe_Int):             # Unsigned Integer - only accepts non-negative integer values
+
+    min_value  = 0       # Unsigned means >= 0
+    max_value  = None    # No upper limit by default
+    allow_bool = False  # Don't allow True/False as 1/0

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_UInt__Byte.py

@@ -0,0 +1,10 @@
+from osbot_utils.helpers.safe_int.Safe_UInt import Safe_UInt
+
+TYPE_SAFE_UINT__BYTE__MIN_VALUE = 0
+TYPE_SAFE_UINT__BYTE__MAX_VALUE = 255
+
+class Safe_UInt__Byte(Safe_UInt):           # Single byte value (0-255)
+
+    min_value = TYPE_SAFE_UINT__BYTE__MIN_VALUE
+    max_value = TYPE_SAFE_UINT__BYTE__MAX_VALUE
+    allow_bool = False

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_UInt__FileSize.py

@@ -0,0 +1,19 @@
+from osbot_utils.helpers.safe_int.Safe_UInt import Safe_UInt
+
+TYPE_SAFE_UINT__FILE_SIZE__MIN_VALUE = 0
+TYPE_SAFE_UINT__FILE_SIZE__MAX_VALUE = 2 ** 63 - 1         # Max file size on most systems
+
+class Safe_UInt__FileSize(Safe_UInt):                     # File size in bytes
+
+    min_value = TYPE_SAFE_UINT__FILE_SIZE__MIN_VALUE
+    max_value = TYPE_SAFE_UINT__FILE_SIZE__MAX_VALUE
+    allow_bool = False
+
+    def to_kb(self) -> float:
+        return self / 1024
+
+    def to_mb(self) -> float:
+        return self / (1024 * 1024)
+
+    def to_gb(self) -> float:
+        return self / (1024 * 1024 * 1024)

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_UInt__Percentage.py

@@ -0,0 +1,10 @@
+from osbot_utils.helpers.safe_int.Safe_UInt import Safe_UInt
+
+TYPE_SAFE_UINT__PERCENTAGE__MIN_VALUE = 0
+TYPE_SAFE_UINT__PERCENTAGE__MAX_VALUE = 100
+
+class Safe_UInt__Percentage(Safe_UInt):           # Percentage value (0-100)
+
+    min_value = TYPE_SAFE_UINT__PERCENTAGE__MIN_VALUE
+    max_value = TYPE_SAFE_UINT__PERCENTAGE__MAX_VALUE
+    allow_bool = False

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/Safe_UInt__Port.py

@@ -0,0 +1,11 @@
+from osbot_utils.helpers.safe_int.Safe_UInt import Safe_UInt
+
+TYPE_SAFE_UINT__PORT__MIN_VALUE = 0
+TYPE_SAFE_UINT__PORT__MAX_VALUE = 65535
+
+class Safe_UInt__Port(Safe_UInt):                         # Network port number (0-65535)
+
+    min_value  = TYPE_SAFE_UINT__PORT__MIN_VALUE
+    max_value  = TYPE_SAFE_UINT__PORT__MAX_VALUE
+    allow_bool = False
+    allow_none = False                                  # don't allow 0 as port value since that is a really weird value for a port

osbot_utils-2.61.0/osbot_utils/helpers/safe_int/__init__.py

@@ -0,0 +1,10 @@
+from osbot_utils.helpers.safe_int.Safe_Int import Safe_Int
+
+TYPE_SAFE_INT__BYTE__MIN_VALUE = 0
+TYPE_SAFE_INT__BYTE__MAX_VALUE = 255
+
+class Safe_Int__Byte(Safe_Int): # Single byte value (0-255)
+
+    min_value = TYPE_SAFE_INT__BYTE__MIN_VALUE
+    max_value = TYPE_SAFE_INT__BYTE__MAX_VALUE
+    allow_bool = False

{osbot_utils-2.59.0 → osbot_utils-2.61.0}/osbot_utils/helpers/safe_str/Safe_Str.py

@@ -21,7 +21,7 @@ class Safe_Str(str):
             if cls.allow_empty:
                 value = ""
             else:
-                raise ValueError("Value cannot be None when allow_empty is False")
+                raise ValueError(f"in {cls.__name__}, value cannot be None when allow_empty is False") from None
 
         if not isinstance(value, str):                                                                                  # Convert to string if not already
             value = str(value)

{osbot_utils-2.59.0 → osbot_utils-2.61.0}/osbot_utils/type_safe/shared/Type_Safe__Validation.py

@@ -285,7 +285,7 @@ class Type_Safe__Validation:
             if self.obj_is_type_union_compatible(var_type, IMMUTABLE_TYPES) is False:                        # if var_type is not something like Optional[Union[int, str]]
                 if var_type not in IMMUTABLE_TYPES or type(var_type) not in IMMUTABLE_TYPES:
                     if not isinstance(var_type, EnumMeta):
-                        if not issubclass(var_type, str):
+                        if not issubclass(var_type, (int,str, float)):
                             type_safe_raise_exception.immutable_type_error(var_name, var_type)
 
     def validate_variable_type(self, var_name, var_type, var_value):                                # Validate type compatibility

osbot_utils-2.61.0/osbot_utils/version

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

{osbot_utils-2.59.0 → osbot_utils-2.61.0}/pyproject.toml

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

osbot_utils-2.59.0/osbot_utils/version

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