maleo-foundation 0.2.96__py3-none-any.whl → 0.2.97__py3-none-any.whl

maleo_foundation/models/transfers/results/client/controllers/http.py

@@ -4,10 +4,10 @@ from pydantic import BaseModel, Field, model_validator
 from typing import Any
 
 class BaseClientHTTPControllerResults(BaseModel):
-    response:Response = Field(..., description="Client's HTTP Controller response")
-    status_code:int = Field(..., description="Client's HTTP Controller response status code")
-    content:Any = Field(..., description="Client's HTTP Controller response content")
-    success:bool = Field(..., description="Client's HTTP Controller success status")
+    response: Response = Field(..., description="Client's HTTP Controller response")
+    status_code: int = Field(..., description="Client's HTTP Controller response status code")
+    content: Any = Field(..., description="Client's HTTP Controller response content")
+    success: bool = Field(..., description="Client's HTTP Controller success status")
 
     class Config:
         arbitrary_types_allowed=True

maleo_foundation/models/transfers/results/encryption/aes.py

@@ -12,7 +12,7 @@ class MaleoFoundationAESEncryptionResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class Encrypt(BaseServiceGeneralResultsTransfers.SingleData):
-        data:EncryptData = Field(..., description="Single encryption data")
+        data: EncryptData = Field(..., description="Single encryption data")
 
     class Decrypt(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")
+        data: MaleoFoundationEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")

maleo_foundation/models/transfers/results/encryption/rsa.py

@@ -6,7 +6,7 @@ class MaleoFoundationRSAEncryptionResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class Encrypt(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationEncryptionSchemas.Ciphertext = Field(..., description="Single encryption data")
+        data: MaleoFoundationEncryptionSchemas.Ciphertext = Field(..., description="Single encryption data")
 
     class Decrypt(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")
+        data: MaleoFoundationEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")

maleo_foundation/models/transfers/results/hash.py

@@ -7,7 +7,7 @@ class MaleoFoundationHashResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class Hash(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationHashSchemas.Hash = Field(..., description="Hash data")
+        data: MaleoFoundationHashSchemas.Hash = Field(..., description="Hash data")
 
     class Verify(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationHashSchemas.IsValid = Field(..., description="Verify data")
+        data: MaleoFoundationHashSchemas.IsValid = Field(..., description="Verify data")

maleo_foundation/models/transfers/results/key.py

@@ -7,10 +7,10 @@ class MaleoFoundationKeyResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class CreatePrivate(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationKeyGeneralTransfers.PrivateKey = Field(..., description="Private key data")
+        data: MaleoFoundationKeyGeneralTransfers.PrivateKey = Field(..., description="Private key data")
 
     class CreatePublic(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationKeyGeneralTransfers.PublicKey = Field(..., description="Private key data")
+        data: MaleoFoundationKeyGeneralTransfers.PublicKey = Field(..., description="Private key data")
 
     class CreatePair(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationKeyGeneralTransfers.KeyPair = Field(..., description="Key pair data")
+        data: MaleoFoundationKeyGeneralTransfers.KeyPair = Field(..., description="Key pair data")

maleo_foundation/models/transfers/results/signature.py

@@ -6,7 +6,7 @@ class MaleoFoundationSignatureResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class Sign(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationSignatureSchemas.Signature = Field(..., description="Single signature data")
+        data: MaleoFoundationSignatureSchemas.Signature = Field(..., description="Single signature data")
 
     class Verify(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationSignatureSchemas.IsValid = Field(..., description="Single verify data")
+        data: MaleoFoundationSignatureSchemas.IsValid = Field(..., description="Single verify data")

maleo_foundation/models/transfers/results/token.py

@@ -6,7 +6,7 @@ class MaleoFoundationTokenResultsTransfers:
     class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
 
     class Encode(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationTokenSchemas.Token
+        data: MaleoFoundationTokenSchemas.Token
 
     class Decode(BaseServiceGeneralResultsTransfers.SingleData):
-        data:MaleoFoundationTokenGeneralTransfers.DecodePayload
+        data: MaleoFoundationTokenGeneralTransfers.DecodePayload

maleo_foundation/utils/cleaner.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List, Optional
+
+def clean_pubsub_message(
+    msg:Dict[str, Any],
+    enums:Optional[List[str]] = None
+) -> Dict[str, Any]:
+    for k, v in msg.items():
+        # Clean enums
+        if isinstance(v, dict) and len(v) == 1:
+            only_key = next(iter(v))
+            if enums is not None and only_key in enums:
+                msg[k] = v[only_key]
+
+        # Clean "map"
+        if isinstance(v, dict) and "map" in v and isinstance(v["map"], dict):
+            msg[k] = v["map"]
+
+        # Clean "array"
+        if isinstance(v, dict) and "array" in v and isinstance(v["array"], list):
+            msg[k] = v["array"]
+
+    return msg

maleo_foundation/utils/client.py

@@ -9,17 +9,17 @@ from maleo_foundation.models.transfers.results.client.service import \
 class BaseClientUtils:
     @staticmethod
     def result_processor(
-        fail_class:Type[BaseClientServiceResultsTransfers.Fail],
-        data_found_class:Union[
+        fail_class: Type[BaseClientServiceResultsTransfers.Fail],
+        data_found_class: Union[
             Type[BaseClientServiceResultsTransfers.SingleData],
             Type[BaseClientServiceResultsTransfers.UnpaginatedMultipleData],
             Type[BaseClientServiceResultsTransfers.PaginatedMultipleData]
         ],
-        no_data_class:Optional[Type[BaseClientServiceResultsTransfers.NoData]] = None,
+        no_data_class: Optional[Type[BaseClientServiceResultsTransfers.NoData]] = None,
     ):
         """Decorator to handle repository-related exceptions consistently."""
         def decorator(func):
-            def _processor(result:BaseTypes.StringToAnyDict):
+            def _processor(result: BaseTypes.StringToAnyDict):
                 if "success" not in result and "data" not in result:
                     raise ValueError("Result did not have both 'success' and 'data' field")
                 success:bool = result.get("success")
@@ -40,7 +40,7 @@ class BaseClientUtils:
                 @wraps(func)
                 async def async_wrapper(*args, **kwargs):
                     try:
-                        result:BaseTypes.StringToAnyDict = await func(*args, **kwargs)
+                        result: BaseTypes.StringToAnyDict = await func(*args, **kwargs)
                         return _processor(result=result)
                     except ValidationError as e:
                         raise
@@ -51,7 +51,7 @@ class BaseClientUtils:
                 @wraps(func)
                 def sync_wrapper(*args, **kwargs):
                     try:
-                        result:BaseTypes.StringToAnyDict = func(*args, **kwargs)
+                        result: BaseTypes.StringToAnyDict = func(*args, **kwargs)
                         return _processor(result=result)
                     except ValidationError as e:
                         raise

maleo_foundation/utils/controller.py

@@ -13,8 +13,8 @@ from maleo_foundation.expanded_types.general import BaseGeneralExpandedTypes
 class BaseControllerUtils:
     @staticmethod
     def field_expansion_handler(
-        expandable_fields_dependencies_map:BaseTypes.OptionalStringToListOfStringDict = None,
-        field_expansion_processors:BaseGeneralExpandedTypes.OptionalListOfFieldExpansionProcessor = None
+        expandable_fields_dependencies_map: BaseTypes.OptionalStringToListOfStringDict = None,
+        field_expansion_processors: BaseGeneralExpandedTypes.OptionalListOfFieldExpansionProcessor = None
     ):
         """
         Decorator to handle expandable fields validation and processing.
@@ -23,7 +23,7 @@ class BaseControllerUtils:
             expandable_fields_dependencies_map: Dictionary where keys are dependency fields and values are lists of dependent fields
             field_expansion_processors: List of processor functions that handle that field's data
         """
-        def decorator(func:Callable[..., Awaitable[BaseServiceRESTControllerResults]]):
+        def decorator(func: Callable[..., Awaitable[BaseServiceRESTControllerResults]]):
             @wraps(func)
             async def wrapper(*args, **kwargs):
                 sig = inspect.signature(func)
@@ -31,7 +31,7 @@ class BaseControllerUtils:
                 bound.apply_defaults()
 
                 parameters = bound.arguments.get("parameters")
-                expand:BaseTypes.OptionalListOfStrings = getattr(parameters, 'expand', None)
+                expand: BaseTypes.OptionalListOfStrings = getattr(parameters, 'expand', None)
 
                 #* Validate expandable fields dependencies
                 if expand is not None and expandable_fields_dependencies_map is not None:
@@ -54,7 +54,7 @@ class BaseControllerUtils:
                     return result
 
                 #* Recursive function to apply expansion processors
-                def recursive_expand(data:Union[Dict, List], expand:BaseTypes.OptionalListOfStrings):
+                def recursive_expand(data: Union[Dict, List], expand: BaseTypes.OptionalListOfStrings):
                     if isinstance(data, list):
                         for idx, item in enumerate(data):
                             data[idx] = recursive_expand(item, expand)
@@ -93,7 +93,7 @@ class BaseControllerUtils:
 
     @staticmethod
     def field_modification_handler(
-        field_modification_processors:BaseGeneralExpandedTypes.OptionalListOfFieldModificationProcessor = None
+        field_modification_processors: BaseGeneralExpandedTypes.OptionalListOfFieldModificationProcessor = None
     ):
         """
         Decorator to handle expandable fields validation and processing.
@@ -102,7 +102,7 @@ class BaseControllerUtils:
             expandable_fields_dependencies_map: Dictionary where keys are dependency fields and values are lists of dependent fields
             field_modification_processors: List of processor functions that handle that field's data
         """
-        def decorator(func:Callable[..., Awaitable[BaseServiceRESTControllerResults]]):
+        def decorator(func: Callable[..., Awaitable[BaseServiceRESTControllerResults]]):
             @wraps(func)
             async def wrapper(*args, **kwargs):
                 #* Call the original function
@@ -112,7 +112,7 @@ class BaseControllerUtils:
                     return result
 
                 #* Recursive function to apply modification processors
-                def recursive_modify(data:Union[Dict, List]):
+                def recursive_modify(data: Union[Dict, List]):
                     if isinstance(data, list):
                         for idx, item in enumerate(data):
                             data[idx] = recursive_modify(item)

maleo_foundation/utils/dependencies/auth.py

@@ -7,7 +7,7 @@ from maleo_foundation.authorization import TOKEN_SCHEME, Authorization
 class AuthDependencies:
     @staticmethod
     def authentication(
-        request:Request
+        request: Request
     ) -> Authentication:
         return Authentication(
             credentials=request.auth,
@@ -16,7 +16,7 @@ class AuthDependencies:
 
     @staticmethod
     def authorization(
-        token:HTTPAuthorizationCredentials = Security(TOKEN_SCHEME)
+        token: HTTPAuthorizationCredentials = Security(TOKEN_SCHEME)
     ) -> Authorization:
         return Authorization(
             scheme=token.scheme,

maleo_foundation/utils/dependencies/context.py

@@ -4,6 +4,6 @@ from maleo_foundation.models.transfers.general import RequestContextTransfers
 class ContextDependencies:
     @staticmethod
     def get_request_context(
-        request:Request
+        request: Request
     ) -> RequestContextTransfers:
         return request.state.request_context

maleo_foundation/utils/exceptions.py

@@ -17,14 +17,14 @@ from maleo_foundation.utils.logging import BaseLogger
 
 class BaseExceptions:
     @staticmethod
-    def authentication_error_handler(request:Request, exc:Exception):
+    def authentication_error_handler(request: Request, exc: Exception):
         return JSONResponse(
             content=BaseResponses.Unauthorized(other=str(exc)).model_dump(mode="json"),
             status_code=status.HTTP_401_UNAUTHORIZED
         )
 
     @staticmethod
-    async def validation_exception_handler(request:Request, exc:RequestValidationError):
+    async def validation_exception_handler(request: Request, exc: RequestValidationError):
         serialized_error = jsonable_encoder(exc.errors())
         return JSONResponse(
             content=BaseResponses.ValidationError(other=serialized_error).model_dump(mode="json"),
@@ -32,7 +32,7 @@ class BaseExceptions:
         )
 
     @staticmethod
-    async def http_exception_handler(request:Request, exc:StarletteHTTPException):
+    async def http_exception_handler(request: Request, exc: StarletteHTTPException):
         if exc.status_code in BaseResponses.other_responses:
             return JSONResponse(
                 content=BaseResponses.other_responses[exc.status_code]["model"]().model_dump(mode="json"),
@@ -46,13 +46,13 @@ class BaseExceptions:
 
     @staticmethod
     def repository_exception_handler(
-        operation:str,
-        logger:Optional[BaseLogger] = None,
-        fail_result_class:type[BaseServiceRepositoryResultsTransfers.Fail] = BaseServiceRepositoryResultsTransfers.Fail
+        operation: str,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[BaseServiceRepositoryResultsTransfers.Fail] = BaseServiceRepositoryResultsTransfers.Fail
     ):
         """Decorator to handle repository-related exceptions consistently for sync and async functions."""
         def decorator(func):
-            def _handler(e:Exception, category:str, description:str):
+            def _handler(e: Exception, category: str, description: str):
                 if logger:
                     logger.error(
                         f"{category} occurred while {operation}: '{str(e)}'",
@@ -115,9 +115,9 @@ class BaseExceptions:
 
     @staticmethod
     def service_exception_handler(
-        operation:str,
-        logger:Optional[BaseLogger] = None,
-        fail_result_class:type[BaseServiceGeneralResultsTransfers.Fail] = BaseServiceGeneralResultsTransfers.Fail
+        operation: str,
+        logger: Optional[BaseLogger] = None,
+        fail_result_class: type[BaseServiceGeneralResultsTransfers.Fail] = BaseServiceGeneralResultsTransfers.Fail
     ):
         """Decorator to handle service-related exceptions consistently."""
         def decorator(func):

maleo_foundation/utils/extractor.py

@@ -4,7 +4,7 @@ from starlette.requests import HTTPConnection
 from uuid import uuid4
 from maleo_foundation.models.transfers.general import RequestContextTransfers
 
-def extract_client_ip(conn:HTTPConnection) -> str:
+def extract_client_ip(conn: HTTPConnection) -> str:
     """Extract client IP with more robust handling of proxies"""
     #* Check for X-Forwarded-For header (common when behind proxy/load balancer)
     x_forwarded_for = conn.headers.get("X-Forwarded-For")
@@ -21,7 +21,7 @@ def extract_client_ip(conn:HTTPConnection) -> str:
     #* Fall back to direct client connection
     return conn.client.host if conn.client else "unknown"
 
-def extract_request_context(request:Request) -> RequestContextTransfers:
+def extract_request_context(request: Request) -> RequestContextTransfers:
     headers = request.headers
 
     request_id = headers.get("x-request-id")

maleo_foundation/utils/formatter/case.py

@@ -8,24 +8,24 @@ class CaseFormatter:
         SNAKE = "snake"
 
     @staticmethod
-    def to_camel_case(text:str) -> str:
+    def to_camel_case(text: str) -> str:
         """Converts snake_case or PascalCase to camelCase."""
         words = re.split(r'[_\s]', text)  # Handle snake_case and spaces
         return words[0].lower() + "".join(word.capitalize() for word in words[1:])
 
     @staticmethod
-    def to_pascal_case(text:str) -> str:
+    def to_pascal_case(text: str) -> str:
         """Converts snake_case or camelCase to PascalCase."""
         words = re.split(r'[_\s]', text)
         return "".join(word.capitalize() for word in words)
 
     @staticmethod
-    def to_snake_case(text:str) -> str:
+    def to_snake_case(text: str) -> str:
         """Converts camelCase or PascalCase to snake_case."""
         return re.sub(r'([a-z0-9])([A-Z])', r'\1_\2', text).lower()
 
     @staticmethod
-    def convert(text:str, target:Case) -> str:
+    def convert(text: str, target: Case) -> str:
         """Converts text to the specified case format."""
         if target == CaseFormatter.Case.CAMEL:
             return CaseFormatter.to_camel_case(text)

maleo_foundation/utils/loaders/credential/google.py

@@ -6,7 +6,9 @@ from typing import Optional, Union
 
 class GoogleCredentialsLoader:
     @staticmethod
-    def load(credentials_path: Optional[Union[Path, str]] = None) -> Credentials:
+    def load(
+        credentials_path: Optional[Union[Path, str]] = None
+    ) -> Credentials:
         """
         Load Google credentials either from a service account file or from the default credentials.
         Priority:

maleo_foundation/utils/loaders/json.py

@@ -4,7 +4,7 @@ from pathlib import Path
 
 class JSONLoader:
     @staticmethod
-    def load_from_path(path:Union[Path, str]) -> Union[Dict[str, Any], List[Any]]:
+    def load_from_path(path: Union[Path, str]) -> Union[Dict[str, Any], List[Any]]:
         file_path = Path(path)
 
         if not file_path.is_file():
@@ -14,5 +14,5 @@ class JSONLoader:
             return json.load(f)
 
     @staticmethod
-    def load_from_string(string:str) -> Dict:
+    def load_from_string(string: str) -> Dict:
         return json.loads(string)

maleo_foundation/utils/loaders/yaml.py

@@ -4,7 +4,7 @@ from typing import Dict, Union
 
 class YAMLLoader:
     @staticmethod
-    def load_from_path(path:Union[Path, str]) -> Dict:
+    def load_from_path(path: Union[Path, str]) -> Dict:
         file_path = Path(path)
 
         if not file_path.exists() or not file_path.is_file():
@@ -14,5 +14,5 @@ class YAMLLoader:
             return yaml.safe_load(f)
 
     @staticmethod
-    def load_from_string(string:str) -> Dict:
+    def load_from_string(string: str) -> Dict:
         return yaml.safe_load(string)

maleo_foundation/utils/logging.py

@@ -12,7 +12,10 @@ from maleo_foundation.types import BaseTypes
 from maleo_foundation.utils.loaders.credential.google import GoogleCredentialsLoader
 
 class GoogleCloudLogging:
-    def __init__(self, credentials_path:Optional[Union[Path, str]] = None) -> None:
+    def __init__(
+        self,
+        credentials_path: Optional[Union[Path, str]] = None
+    ) -> None:
         self._credentials = GoogleCredentialsLoader.load(credentials_path=credentials_path)
         self._client = Client(credentials=self._credentials)
         self._client.setup_logging()
@@ -31,13 +34,16 @@ class GoogleCloudLogging:
         if self._client is not None:
             self._client = None
 
-    def create_handler(self, name:str) -> CloudLoggingHandler:
+    def create_handler(
+        self,
+        name: str
+    ) -> CloudLoggingHandler:
         return CloudLoggingHandler(client=self._client, name=name)
 
 class SimpleConfig(BaseModel):
-    dir:str = Field(..., description="Log's directory")
-    level:BaseEnums.LoggerLevel = Field(BaseEnums.LoggerLevel.INFO, description="Log's level")
-    google_cloud_logging:Optional[GoogleCloudLogging] = Field(default_factory=GoogleCloudLogging, description="Google cloud logging")
+    dir: str = Field(..., description="Log's directory")
+    level: BaseEnums.LoggerLevel = Field(BaseEnums.LoggerLevel.INFO, description="Log's level")
+    google_cloud_logging: Optional[GoogleCloudLogging] = Field(default_factory=GoogleCloudLogging, description="Google cloud logging")
 
     class Config:
         arbitrary_types_allowed=True
@@ -45,13 +51,13 @@ class SimpleConfig(BaseModel):
 class BaseLogger(logging.Logger):
     def __init__(
         self,
-        dir:str,
-        type:BaseEnums.LoggerType,
-        service_key:BaseTypes.OptionalString = None,
-        middleware_type:Optional[BaseEnums.MiddlewareLoggerType] = None,
-        client_key:BaseTypes.OptionalString = None,
-        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
-        google_cloud_logging:Optional[GoogleCloudLogging] = None
+        dir: str,
+        type: BaseEnums.LoggerType,
+        service_key: BaseTypes.OptionalString = None,
+        middleware_type: Optional[BaseEnums.MiddlewareLoggerType] = None,
+        client_key: BaseTypes.OptionalString = None,
+        level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging: Optional[GoogleCloudLogging] = None
     ):
         self._type = type #* Declare logger type
 
@@ -156,8 +162,8 @@ class BaseLogger(logging.Logger):
 class MiddlewareLogger(BaseLogger):
     def __init__(
         self,
-        dir:str,
-        service_key:BaseTypes.OptionalString = None,
+        dir: str,
+        service_key: BaseTypes.OptionalString = None,
         middleware_type = None,
         level = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging = None
@@ -175,11 +181,11 @@ class MiddlewareLogger(BaseLogger):
 class ServiceLogger(BaseLogger):
     def __init__(
         self,
-        dir:str,
-        type:BaseEnums.ServiceLoggerType,
-        service_key:BaseTypes.OptionalString = None,
-        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
-        google_cloud_logging:Optional[GoogleCloudLogging] = None
+        dir: str,
+        type: BaseEnums.ServiceLoggerType,
+        service_key: BaseTypes.OptionalString = None,
+        level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging: Optional[GoogleCloudLogging] = None
     ):
         super().__init__(
             dir=dir,
@@ -194,11 +200,11 @@ class ServiceLogger(BaseLogger):
 class ClientLogger(BaseLogger):
     def __init__(
         self,
-        dir:str,
-        client_key:str,
-        service_key:BaseTypes.OptionalString = None,
-        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
-        google_cloud_logging:Optional[GoogleCloudLogging] = None
+        dir: str,
+        client_key: str,
+        service_key: BaseTypes.OptionalString = None,
+        level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging: Optional[GoogleCloudLogging] = None
     ):
         super().__init__(
             dir=dir,

maleo_foundation/utils/merger.py

@@ -1,8 +1,11 @@
 from collections.abc import Mapping
 from typing import Dict
 
-def deep_merge(*obj:Dict) -> Dict:
-    def merge_dicts(a:Dict, b:Dict) -> Dict:
+def deep_merge(*obj: Dict) -> Dict:
+    def merge_dicts(
+        a: Dict,
+        b: Dict
+    ) -> Dict:
         result = dict(a)
         for key, value in b.items():
             if (