string-schema 0.1.4__tar.gz → 0.1.6__tar.gz

{string_schema-0.1.4/string_schema.egg-info → string_schema-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: string-schema
-Version: 0.1.4
+Version: 0.1.6
 Summary: A simple, LLM-friendly schema definition library for converting string syntax to structured schemas
 Home-page: https://github.com/xychenmsn/string-schema
 Author: Michael Chen
@@ -151,6 +151,7 @@ String Schema takes human-readable text descriptions and converts them into stru
 - **🤖 LLM Data Extraction**: Define extraction schemas that LLMs can easily follow
 - **🔧 API Development**: Generate Pydantic models and OpenAPI docs from simple syntax
 - **✅ Data Validation**: Create robust validation schemas with minimal code
+- **🌍 Timezone-Aware APIs**: Automatic UTC conversion for consistent datetime handling
 - **📋 Configuration**: Define and validate application configuration schemas
 - **🔄 Data Transformation**: Convert between different schema formats
 
@@ -175,6 +176,12 @@ print(user_dict)  # {"name": "John Doe", "email": "john@example.com", "age": 25}
 user_model = validate_to_model(raw_data, "name:string, email:email, age:int?")
 print(user_model.name)  # "John Doe" - Full type safety
 print(user_model.age)   # 25 - Converted to int
+
+# 🌍 Automatic timezone handling for datetime fields
+from datetime import datetime
+event_data = {"name": "Meeting", "start_time": datetime(2025, 8, 13, 14, 30)}
+event_dict = validate_to_dict(event_data, "name:string, start_time:datetime")
+print(event_dict)  # {"name": "Meeting", "start_time": "2025-08-13T14:30:00+00:00"}
 ```
 
 ### 🎨 Function Decorators

{string_schema-0.1.4 → string_schema-0.1.6}/README.md

@@ -103,6 +103,7 @@ String Schema takes human-readable text descriptions and converts them into stru
 - **🤖 LLM Data Extraction**: Define extraction schemas that LLMs can easily follow
 - **🔧 API Development**: Generate Pydantic models and OpenAPI docs from simple syntax
 - **✅ Data Validation**: Create robust validation schemas with minimal code
+- **🌍 Timezone-Aware APIs**: Automatic UTC conversion for consistent datetime handling
 - **📋 Configuration**: Define and validate application configuration schemas
 - **🔄 Data Transformation**: Convert between different schema formats
 
@@ -127,6 +128,12 @@ print(user_dict)  # {"name": "John Doe", "email": "john@example.com", "age": 25}
 user_model = validate_to_model(raw_data, "name:string, email:email, age:int?")
 print(user_model.name)  # "John Doe" - Full type safety
 print(user_model.age)   # 25 - Converted to int
+
+# 🌍 Automatic timezone handling for datetime fields
+from datetime import datetime
+event_data = {"name": "Meeting", "start_time": datetime(2025, 8, 13, 14, 30)}
+event_dict = validate_to_dict(event_data, "name:string, start_time:datetime")
+print(event_dict)  # {"name": "Meeting", "start_time": "2025-08-13T14:30:00+00:00"}
 ```
 
 ### 🎨 Function Decorators

{string_schema-0.1.4 → string_schema-0.1.6}/docs/pydantic-utilities.md

@@ -41,6 +41,7 @@ ProfileModel = string_to_model("name:string, profile:{bio:text?, avatar:url?, so
 
 - ✅ Basic types: `string`, `int`, `number`, `boolean`
 - ✅ Special types: `email`, `url`, `uuid`, `datetime`, `phone`
+- ✅ **Timezone-aware datetime**: Automatic UTC conversion for consistent API responses
 - ✅ Arrays: `[string]`, `[{name:string, price:number}]`
 - ✅ Nested objects: `profile:{bio:text?, avatar:url?}`
 - ✅ Enums: `status:enum(active,inactive,pending)`
@@ -57,6 +58,11 @@ ProfileModel = string_to_model("name:string, profile:{bio:text?, avatar:url?, so
 user_dict = validate_to_dict(raw_data, "name:string, email:email, age:int?")
 # Returns: {"name": "John", "email": "john@example.com", "age": 30}
 
+# Automatic timezone handling for datetime fields
+event_data = {"name": "Meeting", "start_time": datetime(2025, 8, 13, 14, 30)}
+event_dict = validate_to_dict(event_data, "name:string, start_time:datetime")
+# Returns: {"name": "Meeting", "start_time": "2025-08-13T14:30:00+00:00"}
+
 # Array validation
 events = validate_to_dict(raw_events, "[{user_id:uuid, event:enum(login,logout,purchase)}]")
 
@@ -79,6 +85,60 @@ if profile.profile:
     print(profile.profile.bio)
 ```
 
+## 🌍 Timezone Handling
+
+String Schema automatically ensures all datetime fields include timezone information for consistent, timezone-aware API responses.
+
+### **Automatic UTC Conversion**
+
+```python
+from datetime import datetime
+from string_schema import validate_to_dict
+
+# Naive datetime gets UTC timezone
+data = {"event": "Meeting", "time": datetime(2025, 8, 13, 14, 30)}
+result = validate_to_dict(data, "event:string, time:datetime")
+# Returns: {"event": "Meeting", "time": "2025-08-13T14:30:00+00:00"}
+
+# Timezone-aware datetime preserved
+from datetime import timezone
+utc_time = datetime(2025, 8, 13, 14, 30, tzinfo=timezone.utc)
+data = {"event": "UTC Meeting", "time": utc_time}
+result = validate_to_dict(data, "event:string, time:datetime")
+# Returns: {"event": "UTC Meeting", "time": "2025-08-13T14:30:00+00:00"}
+```
+
+### **Nested and Array Support**
+
+```python
+# Nested datetime handling
+user_data = {
+    "name": "John",
+    "profile": {
+        "created_at": datetime(2025, 8, 13, 10, 0),
+        "last_login": datetime(2025, 8, 13, 12, 0)
+    }
+}
+result = validate_to_dict(user_data, "name:string, profile:{created_at:datetime, last_login:datetime}")
+# All nested datetime fields get timezone info automatically
+
+# Array datetime handling
+events = [
+    {"id": 1, "timestamp": datetime(2025, 8, 13, 9, 0)},
+    {"id": 2, "timestamp": datetime(2025, 8, 13, 10, 0)}
+]
+result = validate_to_dict(events, "[{id:int, timestamp:datetime}]")
+# All timestamps in array items get timezone info
+```
+
+### **Benefits**
+
+- ✅ **Consistent API Responses**: All datetime fields include timezone information
+- ✅ **Global Application Support**: Works correctly across all timezones
+- ✅ **Frontend Compatibility**: JavaScript automatically handles timezone conversion
+- ✅ **Zero Configuration**: Works automatically for all datetime fields
+- ✅ **Performance Optimized**: Minimal overhead with maximum benefit
+
 ## 🎨 Decorators
 
 ### 4. `@returns_dict(schema_str)`

{string_schema-0.1.4 → string_schema-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "string-schema"
-version = "0.1.4"
+version = "0.1.6"
 description = "A simple, LLM-friendly schema definition library for converting string syntax to structured schemas"
 readme = "README.md"
 license = "MIT"
@@ -64,6 +64,12 @@ include = ["string_schema*"]
 [tool.setuptools.package-data]
 string_schema = ["py.typed"]
 
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-dir]
+"" = "."
+
 [tool.black]
 line-length = 100
 target-version = ['py311', 'py312', 'py313']

{string_schema-0.1.4 → string_schema-0.1.6}/setup.py

@@ -9,7 +9,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="string-schema",
-    version="0.1.4",
+    version="0.1.6",
     author="Michael Chen",
     author_email="xychen@msn.com",
     description="A simple, LLM-friendly schema definition library for converting string syntax to structured schemas",

{string_schema-0.1.4 → string_schema-0.1.6}/string_schema/utilities.py

@@ -15,6 +15,7 @@ Key Functions:
 
 import functools
 import uuid
+from datetime import datetime, timezone
 from typing import Any, Dict, Type, Union, Callable, Optional, List
 import logging
 
@@ -30,6 +31,48 @@ except ImportError:
 logger = logging.getLogger(__name__)
 
 
+def _ensure_timezone_aware_dict(data: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Ensure all datetime values in a dictionary have timezone information.
+
+    This function recursively processes dictionaries and lists to add UTC timezone
+    information to naive datetime objects, ensuring consistent API responses.
+
+    Args:
+        data: Dictionary that may contain datetime values
+
+    Returns:
+        Dictionary with timezone-aware datetime values converted to ISO format
+    """
+    if not isinstance(data, dict):
+        return data
+
+    result = {}
+    for key, value in data.items():
+        if isinstance(value, datetime):
+            # Add UTC timezone to naive datetime objects
+            if value.tzinfo is None:
+                value = value.replace(tzinfo=timezone.utc)
+            # Convert to ISO format string for consistent API responses
+            result[key] = value.isoformat()
+        elif isinstance(value, dict):
+            # Recursively process nested dictionaries
+            result[key] = _ensure_timezone_aware_dict(value)
+        elif isinstance(value, list):
+            # Process lists that may contain dictionaries or datetime objects
+            result[key] = [
+                _ensure_timezone_aware_dict(item) if isinstance(item, dict)
+                else item.isoformat() if isinstance(item, datetime) and item.tzinfo is None
+                else item.replace(tzinfo=timezone.utc).isoformat() if isinstance(item, datetime)
+                else item
+                for item in value
+            ]
+        else:
+            result[key] = value
+
+    return result
+
+
 def string_to_model(schema_str: str, name: Optional[str] = None) -> Type[BaseModel]:
     """
     Create Pydantic model from string schema.
@@ -218,13 +261,21 @@ def validate_to_dict(data: Union[Dict[str, Any], Any], schema_str: str) -> Union
             try:
                 # Try Pydantic v2 RootModel style
                 validated_instance = TempModel(data)
-                # Return the validated array data
-                return validated_instance.model_dump() if hasattr(validated_instance, 'model_dump') else validated_instance.dict()
+                # Return the validated array data with timezone-aware conversion
+                result_data = validated_instance.model_dump() if hasattr(validated_instance, 'model_dump') else validated_instance.dict()
+                # Process array items for timezone-aware datetime conversion
+                if isinstance(result_data, list):
+                    return [_ensure_timezone_aware_dict(item) if isinstance(item, dict) else item for item in result_data]
+                return result_data
             except:
                 # Fallback to Pydantic v1 style
                 validated_instance = TempModel(__root__=data)
-                # Return the validated array data
-                return validated_instance.model_dump()['__root__'] if hasattr(validated_instance, 'model_dump') else validated_instance.dict()['__root__']
+                # Return the validated array data with timezone-aware conversion
+                result_data = validated_instance.model_dump()['__root__'] if hasattr(validated_instance, 'model_dump') else validated_instance.dict()['__root__']
+                # Process array items for timezone-aware datetime conversion
+                if isinstance(result_data, list):
+                    return [_ensure_timezone_aware_dict(item) if isinstance(item, dict) else item for item in result_data]
+                return result_data
         else:
             # Handle different input types for object schemas
             if isinstance(data, dict):
@@ -236,11 +287,14 @@ def validate_to_dict(data: Union[Dict[str, Any], Any], schema_str: str) -> Union
                 # Try direct validation
                 validated_instance = TempModel(data)
 
-            # Return as dictionary (use model_dump for Pydantic v2, fallback to dict for v1)
+            # Return as dictionary with timezone-aware datetime handling
             if hasattr(validated_instance, 'model_dump'):
-                return validated_instance.model_dump()
+                result_dict = validated_instance.model_dump()
             else:
-                return validated_instance.dict()
+                result_dict = validated_instance.dict()
+
+            # Ensure timezone-aware datetime conversion for consistent API responses
+            return _ensure_timezone_aware_dict(result_dict)
 
     except ValidationError as e:
         # Re-raise the original validation error

{string_schema-0.1.4 → string_schema-0.1.6/string_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: string-schema
-Version: 0.1.4
+Version: 0.1.6
 Summary: A simple, LLM-friendly schema definition library for converting string syntax to structured schemas
 Home-page: https://github.com/xychenmsn/string-schema
 Author: Michael Chen
@@ -151,6 +151,7 @@ String Schema takes human-readable text descriptions and converts them into stru
 - **🤖 LLM Data Extraction**: Define extraction schemas that LLMs can easily follow
 - **🔧 API Development**: Generate Pydantic models and OpenAPI docs from simple syntax
 - **✅ Data Validation**: Create robust validation schemas with minimal code
+- **🌍 Timezone-Aware APIs**: Automatic UTC conversion for consistent datetime handling
 - **📋 Configuration**: Define and validate application configuration schemas
 - **🔄 Data Transformation**: Convert between different schema formats
 
@@ -175,6 +176,12 @@ print(user_dict)  # {"name": "John Doe", "email": "john@example.com", "age": 25}
 user_model = validate_to_model(raw_data, "name:string, email:email, age:int?")
 print(user_model.name)  # "John Doe" - Full type safety
 print(user_model.age)   # 25 - Converted to int
+
+# 🌍 Automatic timezone handling for datetime fields
+from datetime import datetime
+event_data = {"name": "Meeting", "start_time": datetime(2025, 8, 13, 14, 30)}
+event_dict = validate_to_dict(event_data, "name:string, start_time:datetime")
+print(event_dict)  # {"name": "Meeting", "start_time": "2025-08-13T14:30:00+00:00"}
 ```
 
 ### 🎨 Function Decorators

{string_schema-0.1.4 → string_schema-0.1.6}/string_schema.egg-info/SOURCES.txt

@@ -3,6 +3,25 @@ MANIFEST.in
 README.md
 pyproject.toml
 setup.py
+./string_schema/__init__.py
+./string_schema/py.typed
+./string_schema/utilities.py
+./string_schema/core/__init__.py
+./string_schema/core/builders.py
+./string_schema/core/fields.py
+./string_schema/core/validators.py
+./string_schema/examples/__init__.py
+./string_schema/examples/presets.py
+./string_schema/examples/recipes.py
+./string_schema/integrations/__init__.py
+./string_schema/integrations/json_schema.py
+./string_schema/integrations/openapi.py
+./string_schema/integrations/pydantic.py
+./string_schema/integrations/reverse.py
+./string_schema/parsing/__init__.py
+./string_schema/parsing/optimizer.py
+./string_schema/parsing/string_parser.py
+./string_schema/parsing/syntax.py
 docs/README.md
 docs/advanced-usage.md
 docs/api-reference.md