statezero 0.1.0b1__py3-none-any.whl

statezero/adaptors/django/schemas.py

@@ -0,0 +1,324 @@
+from typing import Any, Dict, List, Literal, Optional, Set, Type, Union
+
+from django.apps import apps
+from django.db import models
+from djmoney.models.fields import MoneyField
+from django.conf import settings
+
+from statezero.adaptors.django.config import config, registry
+from statezero.core.classes import (
+    FieldFormat,
+    FieldType,
+    ModelSchemaMetadata,
+    SchemaFieldMetadata,
+)
+
+from statezero.core.interfaces import AbstractSchemaGenerator, AbstractSchemaOverride
+from statezero.core.types import ORMField
+
+
+class DjangoSchemaGenerator(AbstractSchemaGenerator):
+    def __init__(self):
+        # Initialize definitions as an empty dictionary.
+        self.definitions: Dict[str, Dict[str, Any]] = {}
+
+    def generate_schema(
+        self,
+        model: Type,
+        global_schema_overrides: Dict[ORMField, dict],  # type:ignore
+        additional_fields: List[Any],
+        definitions: Dict[str, Dict[str, Any]] = {},
+        allowed_fields: Optional[Set[str]] = None,  # Pre-computed allowed fields.
+    ) -> ModelSchemaMetadata:
+        properties: Dict[str, SchemaFieldMetadata] = {}
+        relationships: Dict[str, Dict[str, Any]] = {}
+
+        # Get model config from registry
+        model_config = registry.get_config(model)
+
+        # Process all concrete fields and many-to-many fields
+        all_fields = list(model._meta.fields) + list(model._meta.many_to_many)
+        all_field_names: Set[str] = set()
+        db_field_names: Set[str] = set()
+
+        if model_config.fields != "__all__":
+            all_fields = [
+                field for field in all_fields if field.name in model_config.fields
+            ]
+
+        for field in all_fields:
+            # Skip auto-created reverse relations.
+            if getattr(field, "auto_created", False) and not field.concrete:
+                continue
+
+            all_field_names.add(field.name)
+            db_field_names.add(field.name)
+
+            # If allowed_fields is provided and is not the magic "__all__", skip fields not in the allowed set.
+            if (
+                allowed_fields is not None
+                and allowed_fields != "__all__"
+                and field.name not in allowed_fields
+            ):
+                continue
+
+            if field == model._meta.pk:
+                schema_field = self.get_pk_schema(field)
+            else:
+                schema_field = self.get_field_metadata(field, global_schema_overrides)
+
+            properties[field.name] = schema_field
+
+            # If the field represents a relation, record that.
+            if field.is_relation:
+                relationships[field.name] = {
+                    "type": self.get_relation_type(field),
+                    "model": config.orm_provider.get_model_name(field.related_model),
+                    "class_name": field.related_model.__name__,
+                    "primary_key_field": field.related_model._meta.pk.name,
+                }
+
+        # Process any additional fields from the registry
+        add_fields = model_config.additional_fields or []
+        for field in add_fields:
+            # If allowed_fields is provided and is not "__all__", skip additional fields not allowed.
+            if (
+                allowed_fields is not None
+                and allowed_fields != "__all__"
+                and field.name not in allowed_fields
+            ):
+                continue
+
+            # Ensure the underlying model field has the expected properties.
+            field.field.name = field.name
+            field.field.title = field.title
+
+            schema_field = self.get_field_metadata(field.field, global_schema_overrides)
+            # Override title if provided (in case the model field didn't have one)
+            schema_field.title = field.title or schema_field.title
+            schema_field.read_only = True  # Always mark additional fields as read-only
+            properties[field.name] = schema_field
+            all_field_names.add(field.name)
+
+        # Handle "__all__" notation and set up field sets.
+        filterable_fields = (
+            db_field_names
+            if model_config.filterable_fields == "__all__"
+            else model_config.filterable_fields or set()
+        )
+
+        searchable_fields = (
+            db_field_names
+            if model_config.searchable_fields == "__all__"
+            else model_config.searchable_fields or set()
+        )
+
+        ordering_fields = (
+            db_field_names
+            if model_config.ordering_fields == "__all__"
+            else model_config.ordering_fields or set()
+        )
+
+        # Merge passed definitions with those collected during field processing.
+        merged_definitions = {**definitions, **self.definitions}
+
+        # Extract default ordering from model's Meta
+        default_ordering = None
+        if hasattr(model._meta, "ordering") and model._meta.ordering:
+            default_ordering = list(model._meta.ordering)
+
+        schema_meta = ModelSchemaMetadata(
+            model_name=config.orm_provider.get_model_name(model),
+            title=model._meta.verbose_name.title(),
+            plural_title=(
+                model._meta.verbose_name_plural.title()
+                if hasattr(model._meta, "verbose_name_plural")
+                else model.__name__ + "s"
+            ),
+            primary_key_field=model._meta.pk.name,
+            filterable_fields=filterable_fields,
+            searchable_fields=searchable_fields,
+            ordering_fields=ordering_fields,
+            properties=properties,
+            relationships=relationships,
+            default_ordering=default_ordering,
+            definitions=merged_definitions,
+            class_name=model.__name__,
+            date_format=getattr(settings, "REST_FRAMEWORK", {}).get(
+                "DATE_FORMAT", "iso-8601"
+            ),
+            datetime_format=getattr(settings, "REST_FRAMEWORK", {}).get(
+                "DATETIME_FORMAT", "iso-8601"
+            ),
+            time_format=getattr(settings, "REST_FRAMEWORK", {}).get(
+                "TIME_FORMAT", "iso-8601"
+            ),
+        )
+        return schema_meta
+
+    def get_pk_schema(self, field: models.Field) -> SchemaFieldMetadata:
+        title = self.get_field_title(field)
+        description = (
+            str(field.help_text)
+            if hasattr(field, "help_text") and field.help_text
+            else None
+        )
+
+        if isinstance(field, models.AutoField):
+            return SchemaFieldMetadata(
+                type=FieldType.INTEGER,
+                title=title,
+                required=True,
+                nullable=False,
+                format=FieldFormat.ID,
+                description=description,
+            )
+        elif isinstance(field, models.UUIDField):
+            return SchemaFieldMetadata(
+                type=FieldType.STRING,
+                title=title,
+                required=True,
+                nullable=False,
+                format=FieldFormat.UUID,
+                description=description,
+            )
+        elif isinstance(field, models.CharField):
+            return SchemaFieldMetadata(
+                type=FieldType.STRING,
+                title=title,
+                required=True,
+                nullable=False,
+                format=FieldFormat.ID,
+                max_length=field.max_length,
+                description=description,
+            )
+        else:
+            return SchemaFieldMetadata(
+                type=FieldType.OBJECT,
+                title=title,
+                required=True,
+                nullable=False,
+                format=FieldFormat.ID,
+                description=description,
+            )
+
+    def get_field_metadata(
+        self, field: models.Field, global_schema_overrides: Dict[ORMField, dict]
+    ) -> SchemaFieldMetadata:  # type:ignore
+
+        # Check for a custom schema override for this field type.
+        override: AbstractSchemaOverride = global_schema_overrides.get(field.__class__)
+        if override:
+            schema, definition, key = override.get_schema(field)
+            if definition and key:
+                self.definitions[key] = definition
+            return schema
+
+        # Process normally
+        title = self.get_field_title(field)
+        required = self.is_field_required(field)
+        nullable = field.null
+        choices = (
+            {str(choice[0]): choice[1] for choice in field.choices}
+            if field.choices
+            else None
+        )
+        max_length = getattr(field, "max_length", None)
+        max_digits = getattr(field, "max_digits", None)
+        decimal_places = getattr(field, "decimal_places", None)
+        description = (
+            str(field.help_text)
+            if hasattr(field, "help_text") and field.help_text
+            else None
+        )
+
+        if isinstance(field, models.TextField):
+            field_type = FieldType.STRING
+            field_format = FieldFormat.TEXT
+        elif isinstance(field, models.CharField):
+            field_type = FieldType.STRING
+            field_format = None
+        elif isinstance(field, models.IntegerField):
+            field_type = FieldType.INTEGER
+            field_format = None
+        elif isinstance(field, models.BooleanField):
+            field_type = FieldType.BOOLEAN
+            field_format = None
+        elif isinstance(field, models.DateTimeField):
+            field_type = FieldType.STRING
+            field_format = FieldFormat.DATETIME
+        elif isinstance(field, models.DateField):
+            field_type = FieldType.STRING
+            field_format = FieldFormat.DATE
+        elif isinstance(field, (models.ForeignKey, models.OneToOneField)):
+            field_type = self.get_pk_type(field)
+            field_format = self.get_relation_type(field)
+        elif isinstance(field, models.ManyToManyField):
+            field_type = FieldType.ARRAY
+            field_format = FieldFormat.MANY_TO_MANY
+        elif isinstance(field, models.DecimalField):
+            field_type = FieldType.NUMBER
+            field_format = FieldFormat.DECIMAL
+        elif isinstance(field, models.FileField):
+            field_type = FieldType.STRING
+            field_format = FieldFormat.FILE_PATH
+        elif isinstance(field, models.ImageField):
+            field_type = FieldType.STRING
+            field_format = FieldFormat.IMAGE_PATH
+        elif isinstance(field, models.JSONField):
+            field_type = FieldType.OBJECT
+            field_format = FieldFormat.JSON
+        else:
+            field_type = FieldType.OBJECT
+            field_format = None
+
+        # Handle callable defaults: ignore if callable or NOT_PROVIDED.
+        default = field.default
+
+        if default == models.fields.NOT_PROVIDED:
+            default = None
+        elif callable(default):
+            default = default()
+
+        return SchemaFieldMetadata(
+            type=field_type,
+            title=title,
+            required=required,
+            nullable=nullable,
+            format=field_format,
+            max_length=max_length,
+            choices=choices,
+            default=default,
+            validators=[],
+            max_digits=max_digits,
+            decimal_places=decimal_places,
+            description=description,
+        )
+
+    def get_field_title(self, field: models.Field) -> str:
+        if field.verbose_name and not hasattr(field, "title"):
+            return field.verbose_name.capitalize()
+        return field.title or field.name.replace("_", " ").title()
+
+    @staticmethod
+    def is_field_required(field: models.Field) -> bool:
+        return (
+            not field.blank
+            and not field.null
+            and field.default == models.fields.NOT_PROVIDED
+        )
+
+    def get_relation_type(self, field: models.Field) -> Optional[FieldFormat]:
+        if isinstance(field, models.ForeignKey):
+            return FieldFormat.FOREIGN_KEY
+        elif isinstance(field, models.OneToOneField):
+            return FieldFormat.ONE_TO_ONE
+        elif isinstance(field, models.ManyToManyField):
+            return FieldFormat.MANY_TO_MANY
+        return None
+
+    def get_pk_type(self, field: models.Field) -> FieldType:
+        target_field = field.target_field if hasattr(field, "target_field") else field
+        if isinstance(target_field, (models.UUIDField, models.CharField)):
+            return FieldType.STRING
+        return FieldType.INTEGER

statezero/adaptors/django/search_providers/basic_search.py

@@ -0,0 +1,24 @@
+from typing import Set
+from django.db.models import QuerySet, Q
+from statezero.core.interfaces import AbstractSearchProvider
+
+class BasicSearchProvider(AbstractSearchProvider):
+    """Simple search provider using basic Django field lookups."""
+    
+    def search(self, queryset: QuerySet, query: str, search_fields: Set[str]) -> QuerySet:
+        """Apply search using basic field lookups."""
+        if not search_fields or not query or not query.strip():
+            return queryset
+            
+        # Split the query into individual terms.
+        terms = [term.strip() for term in query.split() if term.strip()]
+        if not terms:
+            return queryset
+            
+        # Build Q objects to OR across fields and terms.
+        q_objects = Q()
+        for field in search_fields:
+            for term in terms:
+                q_objects |= Q(**{f"{field}__icontains": term})
+                
+        return queryset.filter(q_objects)

statezero/adaptors/django/search_providers/postgres_search.py

@@ -0,0 +1,51 @@
+from typing import Set
+import logging
+from django.db.models import QuerySet
+from django.contrib.postgres.search import SearchVector, SearchQuery, SearchRank
+from django.db import connection
+
+from statezero.core.interfaces import AbstractSearchProvider
+from statezero.adaptors.django.config import registry
+
+logger = logging.getLogger(__name__)
+
+class PostgreSQLSearchProvider(AbstractSearchProvider):
+    """
+    PostgreSQL-specific search provider using full-text search capabilities.
+    Uses a precomputed 'pg_search_vector' column if available and if the provided
+    search_fields exactly match the expected model configuration (pulled from the registry);
+    otherwise, builds the search vector dynamically from the given fields.
+    """
+    def search(self, queryset: QuerySet, query: str, search_fields: Set[str]) -> QuerySet:
+        if not query or not query.strip() or not search_fields:
+            return queryset
+
+        # Pull expected_search_fields from the model configuration via the registry.
+        model_config = registry.get_config(queryset.model)
+        expected_search_fields = set(getattr(model_config, "searchable_fields", []))
+        
+        search_query = SearchQuery(query, search_type='websearch')
+        
+        use_precomputed = False
+        if self._has_search_column(queryset):
+            # Only use the precomputed column if the provided search_fields match the expected ones.
+            if expected_search_fields and search_fields == expected_search_fields:
+                use_precomputed = True
+
+        if use_precomputed:
+            return queryset.annotate(
+                rank=SearchRank('pg_search_vector', search_query)
+            ).filter(pg_search_vector=search_query).order_by('-rank')
+        
+        # Fallback: build the search vector dynamically using the provided fields.
+        search_vector = SearchVector(*search_fields)
+        return queryset.annotate(
+            pg_search_vector=search_vector,
+            rank=SearchRank(search_vector, search_query)
+        ).filter(pg_search_vector=search_query).order_by('-rank')
+    
+    def _has_search_column(self, queryset: QuerySet) -> bool:
+        table_name = queryset.model._meta.db_table
+        with connection.cursor() as cursor:
+            columns = [col.name for col in connection.introspection.get_table_description(cursor, table_name)]
+        return 'pg_search_vector' in columns