Merge dev into main

Author: DinisCruz

README.md

@@ -1,6 +1,6 @@
 # OSBot-Fast-API
 
-![Current Release](https://img.shields.io/badge/release-v0.31.0-blue)
+![Current Release](https://img.shields.io/badge/release-v0.31.2-blue)
 ![Python](https://img.shields.io/badge/python-3.8+-green)
 ![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-red)
 ![Type-Safe](https://img.shields.io/badge/Type--Safe-✓-brightgreen)

docs/llm-brief/v3.28.0__osbot-utils-safe-primitives__reference-guide.md

@@ -106,6 +106,11 @@ def client(self):
         from starlette.testclient import TestClient             # moved here for performance reasons
         return TestClient(self.app())
 
+    def config__no_default_routes(self): self.config.default_routes = False ; return self
+    def config__no_api_key       (self): self.config.enable_api_key = False ; return self
+    def config__no_docs_offline  (self): self.config.docs_offline   = False ; return self
+
+
     def enable_api_key(self):
         self.config.enable_api_key = True
         return self

osbot_fast_api/api/Fast_API.py

@@ -7,6 +7,12 @@
 
 # todo: these are actually routes, so we should move them into a better location
 #       maybe 'default_routes' or something similar
+
+ROUTES_PATHS__CONFIG = ['/config/info'          ,
+                        '/config/openapi.py'    ,
+                        '/config/status'        ,
+                        '/config/version'       ]
+
 class Routes__Config(Fast_API__Routes):
     tag  = 'config'
 

osbot_fast_api/api/routes/Routes__Config.py

@@ -12,6 +12,10 @@ class Schema__Set_Cookie(Type_Safe):
 # todo: these are actually routes, so we should move them into a better location
 #       maybe 'default_routes' or something similar
 
+ROUTES_PATHS__SET_COOKIE = ['/auth/set-auth-cookie' ,
+                            '/auth/set-cookie-form']
+
+
 class Routes__Set_Cookie(Fast_API__Routes):
     tag: str = 'auth'
 

osbot_fast_api/api/routes/Routes__Set_Cookie.py

@@ -20,14 +20,22 @@ def convert_class(self, type_safe_class: Type[Type_Safe]
 
         annotations     = type_safe_cache.get_class_annotations(type_safe_class)    # Get class annotations (using type_safe_cache)
         pydantic_fields = {}                                                        # Build Pydantic fields
+        cls_kwargs      = type_safe_class.__cls_kwargs__()                          # Get class kwargs with defaults once
 
         for field_name, field_type in annotations:
             pydantic_type = self.convert_type(field_type)                           # Convert Type_Safe types to Pydantic
-            default_value = self.get_default_value(type_safe_class, field_name)     # Get default value if exists
-
-            if default_value is not None:                                           # Create field with proper config
-                pydantic_fields[field_name] = (pydantic_type, default_value)
-            else:
+            has_default   = field_name in cls_kwargs                                # Check if field has any default (including None)
+
+            if has_default:
+                default_value = cls_kwargs[field_name]
+                default_value = self.normalize_default_value(default_value)         # Normalize collections
+
+                if default_value is None:                                           # Explicit None default - make Optional
+                    pydantic_type = Optional[pydantic_type]
+                    pydantic_fields[field_name] = (pydantic_type, None)
+                else:
+                    pydantic_fields[field_name] = (pydantic_type, default_value)
+            else:                                                                   # No default - required field
                 pydantic_fields[field_name] = (pydantic_type, Field(...))
 
         model_name = f"{type_safe_class.__name__}__BaseModel"                       # Generate model name
@@ -93,23 +101,17 @@ def convert_type(self, type_safe_type: Any                              # Type a
 
         return type_safe_type                                                           # Return as-is for standard types
 
-    def get_default_value(self, type_safe_class: Type[Type_Safe],                       # Class to get default from
-                                field_name: str                                         # Field name to check
-                           ) -> Any:                                                    # Returns default value or None
-        cls_kwargs = type_safe_class.__cls_kwargs__()                                   # Get class kwargs with defaults
+    def get_default_value(self, type_safe_class: Type[Type_Safe],                   # Class to get default from
+                                field_name: str                                     # Field name to check
+                           ) -> Any:                                                # Returns default value or None
+        cls_kwargs = type_safe_class.__cls_kwargs__()                               # Get class kwargs with defaults
 
         if field_name in cls_kwargs:
-            value = cls_kwargs[field_name]
-            if isinstance(value, Type_Safe__List):                                      # Convert Type_Safe collections
-                return list(value)
-            elif isinstance(value, Type_Safe__Dict):
-                return dict(value)
-            elif isinstance(value, Type_Safe__Set):
-                return list(value)                                                      # Convert set to list for Pydantic
-            return value
+            return self.normalize_default_value(cls_kwargs[field_name])
 
         return None
 
+
     def extract_instance_data(self, type_safe_instance: Type_Safe                       # Instance to extract data from
                                ) -> Dict[str, Any]:                                     # Returns dict of instance data
         data = {}
@@ -163,5 +165,15 @@ def convert_dict(self, type_safe_dict: Type_Safe__Dict
 
         return result
 
+    def normalize_default_value(self, value: Any                                   # Default value to normalize
+                                  ) -> Any:                                         # Returns normalized value
+        if isinstance(value, Type_Safe__List):                                      # Convert Type_Safe collections
+            return list(value)
+        elif isinstance(value, Type_Safe__Dict):
+            return dict(value)
+        elif isinstance(value, Type_Safe__Set):
+            return list(value)                                                      # Convert set to list for Pydantic
+        return value
+
 
 type_safe__to__basemodel = Type_Safe__To__BaseModel()                                   # Singleton instance for convenience (and to have a more global model_cache)

osbot_fast_api/api/transformers/Type_Safe__To__BaseModel.py

@@ -1,11 +1,11 @@
-from typing                                                        import Type, Dict, Any, get_args, Union, Optional, Tuple
-from osbot_utils.type_safe.Type_Safe                               import Type_Safe
-from osbot_utils.type_safe.Type_Safe__Primitive                    import Type_Safe__Primitive
-from osbot_utils.type_safe.primitives.core.Safe_Str            import Safe_Str
-from osbot_utils.type_safe.primitives.core.Safe_Int            import Safe_Int
-from osbot_utils.type_safe.primitives.core.Safe_Float        import Safe_Float
-from osbot_utils.type_safe.type_safe_core.decorators.type_safe     import type_safe
-from osbot_utils.type_safe.type_safe_core.shared.Type_Safe__Cache  import type_safe_cache
+from typing                                                         import Type, Dict, Any, get_args, Union, Optional, Tuple
+from osbot_utils.type_safe.Type_Safe                                import Type_Safe
+from osbot_utils.type_safe.Type_Safe__Primitive                     import Type_Safe__Primitive
+from osbot_utils.type_safe.primitives.core.Safe_Str                 import Safe_Str
+from osbot_utils.type_safe.primitives.core.Safe_Int                 import Safe_Int
+from osbot_utils.type_safe.primitives.core.Safe_Float               import Safe_Float
+from osbot_utils.type_safe.type_safe_core.decorators.type_safe      import type_safe
+from osbot_utils.type_safe.type_safe_core.shared.Type_Safe__Cache   import type_safe_cache
 
 
 class Type_Safe__To__Json(Type_Safe):       # Converts Type_Safe classes to JSON Schema (draft-07 compatible)
@@ -14,6 +14,9 @@ class Type_Safe__To__Json(Type_Safe):       # Converts Type_Safe classes to JSON
     include_examples : bool = False
     strict_mode      : bool = False                                             # If True, includes all Type_Safe constraints
 
+    # todo: the @type_safe here breaks some of the cache behaviour below since the @type_safe will
+    #       convert the Dict to Type_Safe__Dict which means the returned objects are not the same (but from the cached value, so the performance implications might not be that big)
+    #       (see if this has any side effects or main performance implications)
     @type_safe
     def convert_class(self, type_safe_class : Type[Type_Safe]        ,          # Type_Safe class to convert
                             title           : str             = None ,          # Optional schema title

osbot_fast_api/api/transformers/Type_Safe__To__Json.py

@@ -1 +1 @@
-v0.31.0
+v0.31.2