django-nativemojo 0.1.10__py3-none-any.whl → 0.1.15__py3-none-any.whl

mojo/serializers/settings_example.py

@@ -0,0 +1,322 @@
+"""
+Django-MOJO Serializer Settings Configuration Examples
+
+This file demonstrates how to configure the MOJO serializer system through Django settings.
+Add the desired configurations to your project's settings.py file.
+
+The serializer system supports:
+- Multiple serializer backends (simple, optimized, advanced, custom)
+- Performance tuning and caching configuration
+- Runtime serializer switching
+- Custom serializer registration
+- Monitoring and debugging options
+"""
+
+# =============================================================================
+# BASIC SERIALIZER CONFIGURATION
+# =============================================================================
+
+# Default serializer to use throughout the application
+# Options: 'simple', 'optimized', 'advanced', or any custom registered name
+MOJO_DEFAULT_SERIALIZER = 'optimized'
+
+# Enable/disable performance tracking for serializers
+MOJO_SERIALIZER_PERFORMANCE_TRACKING = True
+
+# Enable debug logging for serializer operations
+MOJO_SERIALIZER_DEBUG = False
+
+# =============================================================================
+# CUSTOM SERIALIZER REGISTRATION
+# =============================================================================
+
+# Register custom serializers
+# Format: {'name': 'import.path.to.SerializerClass'} or {'name': config_dict}
+MOJO_CUSTOM_SERIALIZERS = {
+    # Simple string path registration
+    'my_custom': 'myapp.serializers.CustomGraphSerializer',
+
+    # Detailed configuration with metadata
+    'enterprise': {
+        'class': 'myapp.serializers.EnterpriseSerializer',
+        'description': 'Enterprise-grade serializer with audit logging',
+        'is_default': False
+    },
+
+    # Redis-backed caching serializer
+    'redis_cached': {
+        'class': 'myapp.serializers.RedisCachedSerializer',
+        'description': 'Serializer with Redis-based distributed caching',
+        'is_default': False
+    }
+}
+
+# =============================================================================
+# PERFORMANCE AND CACHING CONFIGURATION
+# =============================================================================
+
+# Optimized serializer cache settings
+MOJO_OPTIMIZED_SERIALIZER = {
+    # Instance cache settings (model+graph+pk -> serialized data)
+    'instance_cache_size': 5000,      # Maximum cached instances
+    'instance_cache_ttl': 300,        # Time-to-live in seconds (5 minutes)
+
+    # Graph configuration cache (model+graph -> compiled config)
+    'graph_cache_size': 500,          # Maximum cached graph configs
+    'graph_cache_ttl': 600,           # Time-to-live in seconds (10 minutes)
+
+    # Query optimization cache
+    'query_cache_size': 500,          # Maximum cached query optimizations
+    'query_cache_ttl': 600,           # Time-to-live in seconds (10 minutes)
+
+    # Performance monitoring
+    'enable_performance_stats': True,  # Track performance metrics
+    'stats_history_size': 1000,       # Number of operations to track
+}
+
+# Advanced serializer settings (if using advanced serializer)
+MOJO_ADVANCED_SERIALIZER = {
+    # Multi-format support
+    'enable_csv_export': True,
+    'enable_excel_export': True,
+    'enable_html_debug': True,
+
+    # Excel export settings
+    'excel_max_rows': 100000,         # Maximum rows for Excel export
+    'excel_auto_width': True,         # Auto-adjust column widths
+    'excel_freeze_panes': True,       # Freeze header row
+
+    # CSV export settings
+    'csv_streaming_threshold': 1000,  # Use streaming for > N rows
+    'csv_delimiter': ',',             # CSV field delimiter
+    'csv_encoding': 'utf-8',          # CSV file encoding
+
+    # Performance settings
+    'enable_caching': True,
+    'cache_timeout': 300,             # Cache timeout in seconds
+}
+
+# =============================================================================
+# DEVELOPMENT AND DEBUGGING
+# =============================================================================
+
+# Development-specific settings
+if DEBUG:
+    # Enable detailed logging in development
+    MOJO_SERIALIZER_DEBUG = True
+
+    # Use smaller cache sizes for development
+    MOJO_OPTIMIZED_SERIALIZER['instance_cache_size'] = 1000
+    MOJO_OPTIMIZED_SERIALIZER['graph_cache_size'] = 100
+
+    # Enable performance benchmarking
+    MOJO_ENABLE_SERIALIZER_BENCHMARKS = True
+
+# Production optimizations
+else:
+    # Disable debug logging in production
+    MOJO_SERIALIZER_DEBUG = False
+
+    # Increase cache sizes for production
+    MOJO_OPTIMIZED_SERIALIZER['instance_cache_size'] = 10000
+    MOJO_OPTIMIZED_SERIALIZER['graph_cache_size'] = 1000
+
+    # Disable benchmarking in production
+    MOJO_ENABLE_SERIALIZER_BENCHMARKS = False
+
+# =============================================================================
+# REDIS INTEGRATION (Optional)
+# =============================================================================
+
+# Redis-backed caching for distributed environments
+MOJO_REDIS_SERIALIZER_CACHE = {
+    'enabled': False,                  # Enable Redis caching
+    'host': 'localhost',
+    'port': 6379,
+    'db': 2,                          # Use separate DB for serializer cache
+    'password': None,
+    'key_prefix': 'mojo:serializer:', # Cache key prefix
+    'default_timeout': 300,           # Default cache timeout
+    'connection_pool_kwargs': {
+        'max_connections': 50
+    }
+}
+
+# =============================================================================
+# MONITORING AND ALERTS
+# =============================================================================
+
+# Performance monitoring thresholds
+MOJO_SERIALIZER_MONITORING = {
+    'slow_serialization_threshold': 1.0,    # Log if serialization takes > 1 second
+    'memory_usage_threshold': 100 * 1024 * 1024,  # Alert if using > 100MB memory
+    'cache_hit_rate_threshold': 0.80,       # Alert if cache hit rate < 80%
+    'error_rate_threshold': 0.05,           # Alert if error rate > 5%
+}
+
+# Integration with external monitoring systems
+MOJO_EXTERNAL_MONITORING = {
+    # StatsD integration
+    'statsd': {
+        'enabled': False,
+        'host': 'localhost',
+        'port': 8125,
+        'prefix': 'mojo.serializer'
+    },
+
+    # Sentry integration for error tracking
+    'sentry': {
+        'enabled': False,
+        'track_performance': True,
+        'sample_rate': 0.1  # Sample 10% of operations
+    }
+}
+
+# =============================================================================
+# FEATURE FLAGS
+# =============================================================================
+
+# Feature flags for gradual rollout of new serializer features
+MOJO_SERIALIZER_FEATURES = {
+    'optimized_serializer_default': True,     # Use optimized serializer by default
+    'automatic_query_optimization': True,     # Enable automatic select_related/prefetch_related
+    'advanced_caching': True,                 # Enable advanced caching strategies
+    'performance_monitoring': True,           # Enable detailed performance monitoring
+    'async_serialization': False,             # Enable async serialization (experimental)
+    'distributed_caching': False,             # Enable distributed caching (experimental)
+}
+
+# =============================================================================
+# MODEL-SPECIFIC CONFIGURATIONS
+# =============================================================================
+
+# Override serializer settings for specific models
+MOJO_MODEL_SERIALIZER_OVERRIDES = {
+    'auth.User': {
+        'default_serializer': 'simple',       # Use simple serializer for User model
+        'cache_ttl': 60,                      # Shorter cache TTL for user data
+        'enable_caching': True
+    },
+
+    'myapp.LargeDataModel': {
+        'default_serializer': 'optimized',    # Use optimized serializer for large models
+        'cache_ttl': 1800,                    # Longer cache TTL for stable data
+        'enable_query_optimization': True
+    },
+
+    'reports.AnalyticsData': {
+        'default_serializer': 'advanced',     # Use advanced serializer for reports
+        'enable_csv_export': True,
+        'enable_excel_export': True
+    }
+}
+
+# =============================================================================
+# LOGGING CONFIGURATION
+# =============================================================================
+
+# Add serializer-specific logging configuration to Django's LOGGING setting
+SERIALIZER_LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'serializer': {
+            'format': '[{levelname}] {asctime} {name} - {message}',
+            'style': '{',
+        },
+    },
+    'handlers': {
+        'serializer_file': {
+            'level': 'INFO',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': 'logs/serializer.log',
+            'maxBytes': 10 * 1024 * 1024,  # 10MB
+            'backupCount': 5,
+            'formatter': 'serializer',
+        },
+        'performance_file': {
+            'level': 'INFO',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': 'logs/serializer_performance.log',
+            'maxBytes': 10 * 1024 * 1024,  # 10MB
+            'backupCount': 3,
+            'formatter': 'serializer',
+        },
+    },
+    'loggers': {
+        'optimized_serializer': {
+            'handlers': ['serializer_file'],
+            'level': 'INFO',
+            'propagate': True,
+        },
+        'serializer_manager': {
+            'handlers': ['serializer_file'],
+            'level': 'INFO',
+            'propagate': True,
+        },
+        'serializer_performance': {
+            'handlers': ['performance_file'],
+            'level': 'INFO',
+            'propagate': False,
+        },
+    },
+}
+
+# Merge serializer logging into main LOGGING configuration
+# Note: In your actual settings.py, you would merge this into your existing LOGGING dict
+
+# =============================================================================
+# MIGRATION AND COMPATIBILITY
+# =============================================================================
+
+# Backwards compatibility settings
+MOJO_SERIALIZER_COMPATIBILITY = {
+    # Support legacy GraphSerializer API
+    'legacy_graph_serializer_support': True,
+
+    # Automatically migrate from simple to optimized serializer
+    'auto_migrate_simple_to_optimized': True,
+
+    # Warn about deprecated serializer features
+    'deprecation_warnings': True,
+
+    # Fallback to simple serializer on errors
+    'fallback_on_errors': True
+}
+
+# =============================================================================
+# EXAMPLE USAGE IN VIEWS/MODELS
+# =============================================================================
+
+"""
+Example usage in your Django code:
+
+# In views.py
+from mojo.serializers import serialize, to_response
+
+def my_api_view(request):
+    queryset = MyModel.objects.all()
+
+    # Use default configured serializer
+    return to_response(queryset, request, graph="list")
+
+    # Force specific serializer
+    return to_response(queryset, request, graph="list", serializer_type="optimized")
+
+# In models.py
+class MyModel(MojoModel):
+    name = models.CharField(max_length=100)
+
+    class RestMeta:
+        GRAPHS = {
+            "default": {"fields": ["id", "name"]},
+            "list": {"fields": ["id", "name"]},
+            "detail": {"fields": ["id", "name", "created", "modified"]}
+        }
+
+# Management commands
+# python manage.py serializer_admin list
+# python manage.py serializer_admin benchmark --model MyModel --count 1000
+# python manage.py serializer_admin stats
+# python manage.py serializer_admin clear-cache
+"""

mojo/serializers/{models.py → simple.py}

@@ -1,9 +1,11 @@
 import ujson
-from django.db.models import ForeignKey, OneToOneField
+from django.db.models import ForeignKey, OneToOneField, ManyToOneRel
 from django.db.models.query import QuerySet
+from django.core.exceptions import FieldDoesNotExist
 from django.http import HttpResponse
 import datetime
 from mojo.helpers import logit
+from distutils.log import info
 
 logger = logit.get_logger("serializer", "serializer.log")
 
@@ -66,46 +68,64 @@ class GraphSerializer:
                 method_name, alias = field
             else:
                 method_name, alias = field, field
+            logger.info(f"Processing extra field {method_name} for {obj.__class__.__name__}")
             if hasattr(obj, method_name):
                 attr = getattr(obj, method_name)
                 data[alias] = attr() if callable(attr) else attr
+                logger.info(f"Extra field {method_name} processed successfully", data[alias])
+            else:
+                logger.warning(f"Extra field {method_name} not found for {obj.__class__.__name__}")
 
-        # Process related model graphs (ForeignKeys, OneToOneFields)
+        # Process related model graphs (ForeignKeys, OneToOneFields, ManyToManyFields)
         related_graphs = graph_config.get("graphs", {})
         for related_field, sub_graph in related_graphs.items():
             related_obj = getattr(obj, related_field, None)
             if related_obj is not None:
-                # Determine if the field is a ForeignKey or OneToOneField
+                # Determine if the field is a ForeignKey, OneToOneField, or ManyToManyField
                 field_obj = obj._meta.get_field(related_field)
                 if isinstance(field_obj, (ForeignKey, OneToOneField)):
                     # Serialize related model using its corresponding graph
                     logger.warning(f"graph '{sub_graph}' for {related_obj.__class__.__name__}")
                     data[related_field] = GraphSerializer(related_obj, graph=sub_graph).serialize()
-
+                elif isinstance(field_obj, ManyToOneRel):
+                    # Serialize related models in ManyToManyField
+                    logger.warning(f"graph '{sub_graph}' for many to many relation {related_obj.model.__name__}")
+                    m2m_qset = related_obj.all()
+                    data[related_field] = GraphSerializer(m2m_qset, graph=sub_graph).serialize()
+                else:
+                    logger.warning(f"Unsupported field type for {related_field}: {type(field_obj)}")
         return data
 
+    def get_model_field(self, model_class, field_name):
+        try:
+            return model_class._meta.get_field(field_name)
+        except FieldDoesNotExist:
+            return None
+
     def _model_to_dict_custom(self, obj, fields=None):
         """
         Custom serialization method for Django model instances.
         """
         data = {}
-        for field in obj._meta.fields:
-            # logger.info(field, type(field), isinstance(field, (ForeignKey, OneToOneField)))
-            if fields and field.name not in fields:
-                continue
-
-            field_value = getattr(obj, field.name)
+        if fields is None:
+            fields = [field.name for field in obj._meta.fields]
+        for name in fields:
+            field_value = getattr(obj, name)
+            field = self.get_model_field(obj, name)
+            # Check if the field_value is callable and call it to get the value
+            if callable(field_value):
+                field_value = field_value()
 
             # Handle DateTimeField serialization to epoch
             if isinstance(field_value, datetime.datetime):
-                data[field.name] = int(field_value.timestamp())
+                data[name] = int(field_value.timestamp())
             # Handle date serialization to ISO format
             elif isinstance(field_value, datetime.date):
-                data[field.name] = field_value.isoformat()
+                data[name] = field_value.isoformat()
             elif field_value is not None and isinstance(field, (ForeignKey, OneToOneField)):
-                data[field.name] = field_value.id
+                data[name] = field_value.id
             else:
-                data[field.name] = field_value
+                data[name] = field_value
         # logger.info(data)
         return data
 
@@ -118,7 +138,10 @@ class GraphSerializer:
         else:
             data = dict(data=data, status=True, graph=self.graph)
         data.update(dict(kwargs))
-        out = ujson.dumps(data)
+        try:
+            out = ujson.dumps(data)
+        except Exception as e:
+            logger.exception(data)
         return out
 
     def to_response(self, request, **kwargs):

testit/helpers.py

@@ -131,8 +131,7 @@ def unit_test(name=None):
     return decorator
 
 
-# Test Decorator
-def django_unit_test(name=None):
+def django_unit_test(arg=None):
     """
     Decorator to track unit test execution.
 
@@ -148,9 +147,27 @@ def django_unit_test(name=None):
             import django
             os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings')
             django.setup()
-            _run_unit(func, name, *args, **kwargs)
+
+            test_name = getattr(wrapper, '_test_name', None)
+            if test_name is None:
+                # Strip 'test_' if it exists
+                test_name = func.__name__
+                if test_name.startswith('test_'):
+                    test_name = test_name[5:]
+
+            _run_unit(func, test_name, *args, **kwargs)
+
+        # Store the custom test name if provided
+        if isinstance(arg, str):
+            wrapper._test_name = arg
         return wrapper
-    return decorator
+
+    if callable(arg):
+        # Used as @django_unit_test with no arguments
+        return decorator(arg)
+    else:
+        # Used as @django_unit_test("name") or @django_unit_test()
+        return decorator
 
 
 def get_mock_request(user=None, ip="127.0.0.1", path='/', method='GET', META=None):

django_nativemojo-0.1.10.dist-info/METADATA

@@ -1,96 +0,0 @@
-Metadata-Version: 2.3
-Name: django-nativemojo
-Version: 0.1.10
-Summary: A REST framework for DJANGO with some extra apps that make it easy to provide a secure robust graph like RESIT API.
-License: MIT
-Author: MOJO Dev Team
-Author-email: gotmojo@nativemojo.com
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: django (>=4.2.18,<6.0.0)
-Requires-Dist: django-cors-headers (>=4.7.0,<5.0.0)
-Requires-Dist: faker (>=35.2.0,<36.0.0)
-Requires-Dist: gevent (>=25.5.1,<26.0.0)
-Requires-Dist: pycryptodome (>=3.21.0,<4.0.0)
-Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
-Requires-Dist: pyobjict (>=2.0.2,<4.0.0)
-Requires-Dist: pytz (>=2025.1,<2026.0)
-Requires-Dist: redis (>=3.5.3,<6.0.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: ua-parser (>=1.0.1,<2.0.0)
-Requires-Dist: ujson (>=5.10.0,<6.0.0)
-Description-Content-Type: text/markdown
-
-# Django-MOJO Documentation
-
-Django-MOJO is a streamlined set of Django applications and a lightweight REST framework designed to simplify user authentication, authorization, and efficient API testing. This documentation provides descriptions and examples to help you get started quickly.
-
-## Why Django-MOJO?
-
-We built Django-MOJO to address the complexity and overhead of existing REST frameworks. Many frameworks are feature-heavy, making them cumbersome for projects that require simplicity, speed, and robust security.
-
-## Key Differentiators
-
-- **Lightweight Framework:** Django-MOJO is minimalistic, providing an easy way to add REST APIs to your Django models without unnecessary complexity.
-- **Built-in Security:** Security is integral to Django-MOJO. We offer an alternative to Django's built-in permissions system, automatically protecting your REST APIs and data.
-- **Robust Object-Level Permission System:** Unlike Django's native model-level permissions, Django-MOJO provides a simple yet robust permission system at the object level. This allows fine-grained control, enabling permissions to be applied to individual objects and extended to both user and group levels.
-- **Effortless Integration:** Adding REST endpoints to your models is straightforward, enabling rapid development without compromising security or performance.
-
-With Django-MOJO, you get a simple, efficient framework with powerful security features designed for developers who value speed and control.
-
-## Table of Contents
-
-1. [Overview](#overview)
-2. [Installation](#installation)
-3. [MOJO.Auth - Authentication and Authorization](#mojo-auth)
-   - [JWT Authentication Middleware](#jwt-authentication)
-   - [Models](#models)
-   - [REST API](#mojo-auth-rest-api)
-4. [MOJO - REST Framework](#mojo)
-   - [URL Decorators](#url-decorators)
-   - [GraphSerializer](#graphserializer)
-5. [Testit - Testing Suite](#testit)
-   - [Writing Tests](#writing-tests)
-   - [Running Tests](#running-tests)
-6. [Taskit - Task Runner](#taskit)
-7. [Utilities](#utilities)
-8. [Contributing](#contributing)
-9. [License](#license)
-
-## Overview
-
-Django-MOJO is a collection of Django-based applications focused on authentication, task management, and testing. These tools are built to enhance development efficiency by providing utilities for common requirements such as user management, token-based authentication, and automated testing.
-
-## Installation
-
-```bash
-pip install django-nativemojo
-```
-
-## Detailed Documentation
-
-For detailed information about each module and its usage, refer to the documentation within the `docs` folder:
-
-- [MOJO Auth Documentation](docs/auth.md): Authentication and authorization management with JWT support.
-- [MOJO REST Documentation](docs/rest.md): Provides RESTful API capabilities for Django models.
-- [MOJO Testing Documentation](docs/testit.md): Offers tools and utilities for testing Django applications.
-- [MOJO Tasks Documentation](docs/tasks.md): Handles task management and processing with Redis.
-- [MOJO Decorators Documentation](docs/decorators.md): Describes decorators to enhance Django views with HTTP routing, validation, etc.
-- [Helpers Documentation](docs/helpers.md): Lists various helper utilities for common tasks.
-- [MOJO Metrics Documentation](docs/metrics.md): Details on recording and retrieving metrics using Redis.
-- [Cron Scheduler Documentation](docs/cron.md): Explains task scheduling using a cron syntax.
-
-## Contributing
-
-We welcome contributions! Please create an issue or submit a pull request on the GitHub repository.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-