Add comprehensive API documentation for ThrillWiki integration and features

- Introduced Next.js integration guide for ThrillWiki API, detailing authentication, core domain APIs, data structures, and implementation patterns.
- Documented the migration to Rich Choice Objects, highlighting changes for frontend developers and enhanced metadata availability.
- Fixed the missing `get_by_slug` method in the Ride model, ensuring proper functionality of ride detail endpoints.
- Created a test script to verify manufacturer syncing with ride models, ensuring data integrity across related models.
This commit is contained in:
pacnpal
2025-09-16 11:29:17 -04:00
parent 61d73a2147
commit c2c26cfd1d
98 changed files with 11476 additions and 4803 deletions

View File

@@ -1 +1,12 @@
default_app_config = "apps.core.apps.CoreConfig"
"""
Core Django App
This app handles core system functionality including health checks,
system status, and other foundational features.
"""
# Import core choices to ensure they are registered with the global registry
from .choices import core_choices
# Ensure choices are registered on app startup
__all__ = ['core_choices']

View File

@@ -0,0 +1,32 @@
"""
Rich Choice Objects System
This module provides a comprehensive system for managing choice fields throughout
the ThrillWiki application. It replaces simple tuple-based choices with rich
dataclass objects that support metadata, descriptions, categories, and deprecation.
Key Components:
- RichChoice: Base dataclass for choice objects
- ChoiceRegistry: Centralized management of all choice definitions
- RichChoiceField: Django model field for rich choices
- RichChoiceSerializer: DRF serializer for API responses
"""
from .base import RichChoice, ChoiceCategory, ChoiceGroup
from .registry import ChoiceRegistry, register_choices
from .fields import RichChoiceField
from .serializers import RichChoiceSerializer, RichChoiceOptionSerializer
from .utils import validate_choice_value, get_choice_display
__all__ = [
'RichChoice',
'ChoiceCategory',
'ChoiceGroup',
'ChoiceRegistry',
'register_choices',
'RichChoiceField',
'RichChoiceSerializer',
'RichChoiceOptionSerializer',
'validate_choice_value',
'get_choice_display',
]

View File

@@ -0,0 +1,154 @@
"""
Base Rich Choice Objects
This module defines the core dataclass structures for rich choice objects.
"""
from dataclasses import dataclass, field
from typing import Dict, Any, Optional
from enum import Enum
class ChoiceCategory(Enum):
"""Categories for organizing choice types"""
STATUS = "status"
TYPE = "type"
CLASSIFICATION = "classification"
PREFERENCE = "preference"
PERMISSION = "permission"
PRIORITY = "priority"
ACTION = "action"
NOTIFICATION = "notification"
MODERATION = "moderation"
TECHNICAL = "technical"
BUSINESS = "business"
SECURITY = "security"
OTHER = "other"
@dataclass(frozen=True)
class RichChoice:
"""
Rich choice object with metadata support.
This replaces simple tuple choices with a comprehensive object that can
carry additional information like descriptions, colors, icons, and custom metadata.
Attributes:
value: The stored value (equivalent to first element of tuple choice)
label: Human-readable display name (equivalent to second element of tuple choice)
description: Detailed description of what this choice means
metadata: Dictionary of additional properties (colors, icons, etc.)
deprecated: Whether this choice is deprecated and should not be used for new entries
category: Category for organizing related choices
"""
value: str
label: str
description: str = ""
metadata: Dict[str, Any] = field(default_factory=dict)
deprecated: bool = False
category: ChoiceCategory = ChoiceCategory.OTHER
def __post_init__(self):
"""Validate the choice object after initialization"""
if not self.value:
raise ValueError("Choice value cannot be empty")
if not self.label:
raise ValueError("Choice label cannot be empty")
@property
def color(self) -> Optional[str]:
"""Get the color from metadata if available"""
return self.metadata.get('color')
@property
def icon(self) -> Optional[str]:
"""Get the icon from metadata if available"""
return self.metadata.get('icon')
@property
def css_class(self) -> Optional[str]:
"""Get the CSS class from metadata if available"""
return self.metadata.get('css_class')
@property
def sort_order(self) -> int:
"""Get the sort order from metadata, defaulting to 0"""
return self.metadata.get('sort_order', 0)
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary representation for API serialization"""
return {
'value': self.value,
'label': self.label,
'description': self.description,
'metadata': self.metadata,
'deprecated': self.deprecated,
'category': self.category.value,
'color': self.color,
'icon': self.icon,
'css_class': self.css_class,
'sort_order': self.sort_order,
}
def __str__(self) -> str:
return self.label
def __repr__(self) -> str:
return f"RichChoice(value='{self.value}', label='{self.label}')"
@dataclass
class ChoiceGroup:
"""
A group of related choices with shared metadata.
This allows for organizing choices into logical groups with
common properties and behaviors.
"""
name: str
choices: list[RichChoice]
description: str = ""
metadata: Dict[str, Any] = field(default_factory=dict)
def __post_init__(self):
"""Validate the choice group after initialization"""
if not self.name:
raise ValueError("Choice group name cannot be empty")
if not self.choices:
raise ValueError("Choice group must contain at least one choice")
# Validate that all choice values are unique within the group
values = [choice.value for choice in self.choices]
if len(values) != len(set(values)):
raise ValueError("All choice values within a group must be unique")
def get_choice(self, value: str) -> Optional[RichChoice]:
"""Get a choice by its value"""
for choice in self.choices:
if choice.value == value:
return choice
return None
def get_choices_by_category(self, category: ChoiceCategory) -> list[RichChoice]:
"""Get all choices in a specific category"""
return [choice for choice in self.choices if choice.category == category]
def get_active_choices(self) -> list[RichChoice]:
"""Get all non-deprecated choices"""
return [choice for choice in self.choices if not choice.deprecated]
def to_tuple_choices(self) -> list[tuple[str, str]]:
"""Convert to legacy tuple choices format"""
return [(choice.value, choice.label) for choice in self.choices]
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary representation for API serialization"""
return {
'name': self.name,
'description': self.description,
'metadata': self.metadata,
'choices': [choice.to_dict() for choice in self.choices]
}

View File

@@ -0,0 +1,158 @@
"""
Core System Rich Choice Objects
This module defines all choice objects for core system functionality,
including health checks, API statuses, and other system-level choices.
"""
from .base import RichChoice, ChoiceCategory
from .registry import register_choices
# Health Check Status Choices
HEALTH_STATUSES = [
RichChoice(
value="healthy",
label="Healthy",
description="System is operating normally with no issues detected",
metadata={
'color': 'green',
'icon': 'check-circle',
'css_class': 'bg-green-100 text-green-800',
'sort_order': 1,
'http_status': 200
},
category=ChoiceCategory.STATUS
),
RichChoice(
value="unhealthy",
label="Unhealthy",
description="System has detected issues that may affect functionality",
metadata={
'color': 'red',
'icon': 'x-circle',
'css_class': 'bg-red-100 text-red-800',
'sort_order': 2,
'http_status': 503
},
category=ChoiceCategory.STATUS
),
]
# Simple Health Check Status Choices
SIMPLE_HEALTH_STATUSES = [
RichChoice(
value="ok",
label="OK",
description="Basic health check passed",
metadata={
'color': 'green',
'icon': 'check',
'css_class': 'bg-green-100 text-green-800',
'sort_order': 1,
'http_status': 200
},
category=ChoiceCategory.STATUS
),
RichChoice(
value="error",
label="Error",
description="Basic health check failed",
metadata={
'color': 'red',
'icon': 'x',
'css_class': 'bg-red-100 text-red-800',
'sort_order': 2,
'http_status': 500
},
category=ChoiceCategory.STATUS
),
]
# Entity Type Choices for Search
ENTITY_TYPES = [
RichChoice(
value="park",
label="Park",
description="Theme parks and amusement parks",
metadata={
'color': 'green',
'icon': 'map-pin',
'css_class': 'bg-green-100 text-green-800',
'sort_order': 1,
'search_weight': 1.0
},
category=ChoiceCategory.CLASSIFICATION
),
RichChoice(
value="ride",
label="Ride",
description="Individual rides and attractions",
metadata={
'color': 'blue',
'icon': 'activity',
'css_class': 'bg-blue-100 text-blue-800',
'sort_order': 2,
'search_weight': 1.0
},
category=ChoiceCategory.CLASSIFICATION
),
RichChoice(
value="company",
label="Company",
description="Manufacturers, operators, and designers",
metadata={
'color': 'purple',
'icon': 'building',
'css_class': 'bg-purple-100 text-purple-800',
'sort_order': 3,
'search_weight': 0.8
},
category=ChoiceCategory.CLASSIFICATION
),
RichChoice(
value="user",
label="User",
description="User profiles and accounts",
metadata={
'color': 'orange',
'icon': 'user',
'css_class': 'bg-orange-100 text-orange-800',
'sort_order': 4,
'search_weight': 0.5
},
category=ChoiceCategory.CLASSIFICATION
),
]
def register_core_choices():
"""Register all core system choices with the global registry"""
register_choices(
name="health_statuses",
choices=HEALTH_STATUSES,
domain="core",
description="Health check status options",
metadata={'domain': 'core', 'type': 'health_status'}
)
register_choices(
name="simple_health_statuses",
choices=SIMPLE_HEALTH_STATUSES,
domain="core",
description="Simple health check status options",
metadata={'domain': 'core', 'type': 'simple_health_status'}
)
register_choices(
name="entity_types",
choices=ENTITY_TYPES,
domain="core",
description="Entity type classifications for search functionality",
metadata={'domain': 'core', 'type': 'entity_type'}
)
# Auto-register choices when module is imported
register_core_choices()

View File

@@ -0,0 +1,198 @@
"""
Django Model Fields for Rich Choices
This module provides Django model field implementations for rich choice objects.
"""
from typing import Any, Optional
from django.db import models
from django.core.exceptions import ValidationError
from django.forms import ChoiceField
from .base import RichChoice
from .registry import registry
class RichChoiceField(models.CharField):
"""
Django model field for rich choice objects.
This field stores the choice value as a CharField but provides
rich choice functionality through the registry system.
"""
def __init__(
self,
choice_group: str,
domain: str = "core",
max_length: int = 50,
allow_deprecated: bool = False,
**kwargs
):
"""
Initialize the RichChoiceField.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
max_length: Maximum length for the stored value
allow_deprecated: Whether to allow deprecated choices
**kwargs: Additional arguments passed to CharField
"""
self.choice_group = choice_group
self.domain = domain
self.allow_deprecated = allow_deprecated
# Set choices from registry for Django admin and forms
if self.allow_deprecated:
choices_list = registry.get_choices(choice_group, domain)
else:
choices_list = registry.get_active_choices(choice_group, domain)
choices = [(choice.value, choice.label) for choice in choices_list]
kwargs['choices'] = choices
kwargs['max_length'] = max_length
super().__init__(**kwargs)
def validate(self, value: Any, model_instance: Any) -> None:
"""Validate the choice value"""
super().validate(value, model_instance)
if value is None or value == '':
return
# Check if choice exists in registry
choice = registry.get_choice(self.choice_group, value, self.domain)
if choice is None:
raise ValidationError(
f"'{value}' is not a valid choice for {self.choice_group}"
)
# Check if deprecated choices are allowed
if choice.deprecated and not self.allow_deprecated:
raise ValidationError(
f"'{value}' is deprecated and cannot be used for new entries"
)
def get_rich_choice(self, value: str) -> Optional[RichChoice]:
"""Get the RichChoice object for a value"""
return registry.get_choice(self.choice_group, value, self.domain)
def get_choice_display(self, value: str) -> str:
"""Get the display label for a choice value"""
return registry.get_choice_display(self.choice_group, value, self.domain)
def contribute_to_class(self, cls: Any, name: str, private_only: bool = False, **kwargs: Any) -> None:
"""Add helper methods to the model class (signature compatible with Django Field)"""
super().contribute_to_class(cls, name, private_only=private_only, **kwargs)
# Add get_FOO_rich_choice method
def get_rich_choice_method(instance):
value = getattr(instance, name)
return self.get_rich_choice(value) if value else None
setattr(cls, f'get_{name}_rich_choice', get_rich_choice_method)
# Add get_FOO_display method (Django provides this, but we enhance it)
def get_display_method(instance):
value = getattr(instance, name)
return self.get_choice_display(value) if value else ''
setattr(cls, f'get_{name}_display', get_display_method)
def deconstruct(self):
"""Support for Django migrations"""
name, path, args, kwargs = super().deconstruct()
kwargs['choice_group'] = self.choice_group
kwargs['domain'] = self.domain
kwargs['allow_deprecated'] = self.allow_deprecated
return name, path, args, kwargs
class RichChoiceFormField(ChoiceField):
"""
Form field for rich choices with enhanced functionality.
"""
def __init__(
self,
choice_group: str,
domain: str = "core",
allow_deprecated: bool = False,
show_descriptions: bool = False,
**kwargs
):
"""
Initialize the form field.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
allow_deprecated: Whether to allow deprecated choices
show_descriptions: Whether to show descriptions in choice labels
**kwargs: Additional arguments passed to ChoiceField
"""
self.choice_group = choice_group
self.domain = domain
self.allow_deprecated = allow_deprecated
self.show_descriptions = show_descriptions
# Get choices from registry
if allow_deprecated:
choices_list = registry.get_choices(choice_group, domain)
else:
choices_list = registry.get_active_choices(choice_group, domain)
# Format choices for display
choices = []
for choice in choices_list:
label = choice.label
if show_descriptions and choice.description:
label = f"{choice.label} - {choice.description}"
choices.append((choice.value, label))
kwargs['choices'] = choices
super().__init__(**kwargs)
def validate(self, value: Any) -> None:
"""Validate the choice value"""
super().validate(value)
if value is None or value == '':
return
# Check if choice exists in registry
choice = registry.get_choice(self.choice_group, value, self.domain)
if choice is None:
raise ValidationError(
f"'{value}' is not a valid choice for {self.choice_group}"
)
# Check if deprecated choices are allowed
if choice.deprecated and not self.allow_deprecated:
raise ValidationError(
f"'{value}' is deprecated and cannot be used"
)
def create_rich_choice_field(
choice_group: str,
domain: str = "core",
max_length: int = 50,
allow_deprecated: bool = False,
**kwargs
) -> RichChoiceField:
"""
Factory function to create a RichChoiceField.
This is useful for creating fields with consistent settings
across multiple models.
"""
return RichChoiceField(
choice_group=choice_group,
domain=domain,
max_length=max_length,
allow_deprecated=allow_deprecated,
**kwargs
)

View File

@@ -0,0 +1,197 @@
"""
Choice Registry
Centralized registry for managing all choice definitions across the application.
"""
from typing import Dict, List, Optional, Any
from django.core.exceptions import ImproperlyConfigured
from .base import RichChoice, ChoiceGroup
class ChoiceRegistry:
"""
Centralized registry for managing all choice definitions.
This provides a single source of truth for all choice objects
throughout the application, with support for namespacing by domain.
"""
def __init__(self):
self._choices: Dict[str, ChoiceGroup] = {}
self._domains: Dict[str, List[str]] = {}
def register(
self,
name: str,
choices: List[RichChoice],
domain: str = "core",
description: str = "",
metadata: Optional[Dict[str, Any]] = None
) -> ChoiceGroup:
"""
Register a group of choices.
Args:
name: Unique name for the choice group
choices: List of RichChoice objects
domain: Domain namespace (e.g., 'rides', 'parks', 'accounts')
description: Description of the choice group
metadata: Additional metadata for the group
Returns:
The registered ChoiceGroup
Raises:
ImproperlyConfigured: If name is already registered with different choices
"""
full_name = f"{domain}.{name}"
if full_name in self._choices:
# Check if the existing registration is identical
existing_group = self._choices[full_name]
existing_values = [choice.value for choice in existing_group.choices]
new_values = [choice.value for choice in choices]
if existing_values == new_values:
# Same choices, return existing group (allow duplicate registration)
return existing_group
else:
# Different choices, this is an error
raise ImproperlyConfigured(
f"Choice group '{full_name}' is already registered with different choices. "
f"Existing: {existing_values}, New: {new_values}"
)
choice_group = ChoiceGroup(
name=full_name,
choices=choices,
description=description,
metadata=metadata or {}
)
self._choices[full_name] = choice_group
# Track domain
if domain not in self._domains:
self._domains[domain] = []
self._domains[domain].append(name)
return choice_group
def get(self, name: str, domain: str = "core") -> Optional[ChoiceGroup]:
"""Get a choice group by name and domain"""
full_name = f"{domain}.{name}"
return self._choices.get(full_name)
def get_choice(self, group_name: str, value: str, domain: str = "core") -> Optional[RichChoice]:
"""Get a specific choice by group name, value, and domain"""
choice_group = self.get(group_name, domain)
if choice_group:
return choice_group.get_choice(value)
return None
def get_choices(self, name: str, domain: str = "core") -> List[RichChoice]:
"""Get all choices in a group"""
choice_group = self.get(name, domain)
return choice_group.choices if choice_group else []
def get_active_choices(self, name: str, domain: str = "core") -> List[RichChoice]:
"""Get all non-deprecated choices in a group"""
choice_group = self.get(name, domain)
return choice_group.get_active_choices() if choice_group else []
def get_domains(self) -> List[str]:
"""Get all registered domains"""
return list(self._domains.keys())
def get_domain_choices(self, domain: str) -> Dict[str, ChoiceGroup]:
"""Get all choice groups for a specific domain"""
if domain not in self._domains:
return {}
return {
name: self._choices[f"{domain}.{name}"]
for name in self._domains[domain]
}
def list_all(self) -> Dict[str, ChoiceGroup]:
"""Get all registered choice groups"""
return self._choices.copy()
def validate_choice(self, group_name: str, value: str, domain: str = "core") -> bool:
"""Validate that a choice value exists in a group"""
choice = self.get_choice(group_name, value, domain)
return choice is not None and not choice.deprecated
def get_choice_display(self, group_name: str, value: str, domain: str = "core") -> str:
"""Get the display label for a choice value"""
choice = self.get_choice(group_name, value, domain)
if choice:
return choice.label
else:
raise ValueError(f"Choice value '{value}' not found in group '{group_name}' for domain '{domain}'")
def clear_domain(self, domain: str) -> None:
"""Clear all choices for a specific domain (useful for testing)"""
if domain in self._domains:
for name in self._domains[domain]:
full_name = f"{domain}.{name}"
if full_name in self._choices:
del self._choices[full_name]
del self._domains[domain]
def clear_all(self) -> None:
"""Clear all registered choices (useful for testing)"""
self._choices.clear()
self._domains.clear()
# Global registry instance
registry = ChoiceRegistry()
def register_choices(
name: str,
choices: List[RichChoice],
domain: str = "core",
description: str = "",
metadata: Optional[Dict[str, Any]] = None
) -> ChoiceGroup:
"""
Convenience function to register choices with the global registry.
Args:
name: Unique name for the choice group
choices: List of RichChoice objects
domain: Domain namespace
description: Description of the choice group
metadata: Additional metadata for the group
Returns:
The registered ChoiceGroup
"""
return registry.register(name, choices, domain, description, metadata)
def get_choices(name: str, domain: str = "core") -> List[RichChoice]:
"""Get choices from the global registry"""
return registry.get_choices(name, domain)
def get_choice(group_name: str, value: str, domain: str = "core") -> Optional[RichChoice]:
"""Get a specific choice from the global registry"""
return registry.get_choice(group_name, value, domain)
def validate_choice(group_name: str, value: str, domain: str = "core") -> bool:
"""Validate a choice value using the global registry"""
return registry.validate_choice(group_name, value, domain)
def get_choice_display(group_name: str, value: str, domain: str = "core") -> str:
"""Get choice display label using the global registry"""
return registry.get_choice_display(group_name, value, domain)

View File

@@ -0,0 +1,275 @@
"""
DRF Serializers for Rich Choices
This module provides Django REST Framework serializer implementations
for rich choice objects.
"""
from typing import Any, Dict, List
from rest_framework import serializers
from .base import RichChoice, ChoiceGroup
from .registry import registry
class RichChoiceSerializer(serializers.Serializer):
"""
Serializer for individual RichChoice objects.
This provides a consistent API representation for choice objects
with all their metadata.
"""
value = serializers.CharField()
label = serializers.CharField()
description = serializers.CharField()
metadata = serializers.DictField()
deprecated = serializers.BooleanField()
category = serializers.CharField()
color = serializers.CharField(allow_null=True)
icon = serializers.CharField(allow_null=True)
css_class = serializers.CharField(allow_null=True)
sort_order = serializers.IntegerField()
def to_representation(self, instance: RichChoice) -> Dict[str, Any]:
"""Convert RichChoice to dictionary representation"""
return instance.to_dict()
class RichChoiceOptionSerializer(serializers.Serializer):
"""
Serializer for choice options in filter endpoints.
This replaces the legacy FilterOptionSerializer with rich choice support.
"""
value = serializers.CharField()
label = serializers.CharField()
description = serializers.CharField(allow_blank=True)
count = serializers.IntegerField(required=False, allow_null=True)
selected = serializers.BooleanField(default=False)
deprecated = serializers.BooleanField(default=False)
color = serializers.CharField(allow_null=True, required=False)
icon = serializers.CharField(allow_null=True, required=False)
css_class = serializers.CharField(allow_null=True, required=False)
metadata = serializers.DictField(required=False)
def to_representation(self, instance) -> Dict[str, Any]:
"""Convert choice option to dictionary representation"""
if isinstance(instance, RichChoice):
# Convert RichChoice to option format
return {
'value': instance.value,
'label': instance.label,
'description': instance.description,
'count': None,
'selected': False,
'deprecated': instance.deprecated,
'color': instance.color,
'icon': instance.icon,
'css_class': instance.css_class,
'metadata': instance.metadata,
}
elif isinstance(instance, dict):
# Handle dictionary input (for backwards compatibility)
return {
'value': instance.get('value', ''),
'label': instance.get('label', ''),
'description': instance.get('description', ''),
'count': instance.get('count'),
'selected': instance.get('selected', False),
'deprecated': instance.get('deprecated', False),
'color': instance.get('color'),
'icon': instance.get('icon'),
'css_class': instance.get('css_class'),
'metadata': instance.get('metadata', {}),
}
else:
return super().to_representation(instance)
class ChoiceGroupSerializer(serializers.Serializer):
"""
Serializer for ChoiceGroup objects.
This provides API representation for entire choice groups
with all their choices and metadata.
"""
name = serializers.CharField()
description = serializers.CharField()
metadata = serializers.DictField()
choices = RichChoiceSerializer(many=True)
def to_representation(self, instance: ChoiceGroup) -> Dict[str, Any]:
"""Convert ChoiceGroup to dictionary representation"""
return instance.to_dict()
class RichChoiceFieldSerializer(serializers.CharField):
"""
Serializer field for rich choice values.
This field serializes the choice value but can optionally
include rich choice metadata in the response.
"""
def __init__(
self,
choice_group: str,
domain: str = "core",
include_metadata: bool = False,
**kwargs
):
"""
Initialize the serializer field.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
include_metadata: Whether to include rich choice metadata
**kwargs: Additional arguments passed to CharField
"""
self.choice_group = choice_group
self.domain = domain
self.include_metadata = include_metadata
super().__init__(**kwargs)
def to_representation(self, value: str) -> Any:
"""Convert choice value to representation"""
if not value:
return value
if self.include_metadata:
# Return rich choice object
choice = registry.get_choice(self.choice_group, value, self.domain)
if choice:
return RichChoiceSerializer(choice).data
else:
# Fallback for unknown values
return {
'value': value,
'label': value,
'description': '',
'metadata': {},
'deprecated': False,
'category': 'other',
'color': None,
'icon': None,
'css_class': None,
'sort_order': 0,
}
else:
# Return just the value
return value
def to_internal_value(self, data: Any) -> str:
"""Convert input data to choice value"""
if isinstance(data, dict) and 'value' in data:
# Handle rich choice object input
return data['value']
else:
# Handle string input
return super().to_internal_value(data)
def create_choice_options_serializer(
choice_group: str,
domain: str = "core",
include_counts: bool = False,
queryset=None,
count_field: str = 'id'
) -> List[Dict[str, Any]]:
"""
Create choice options for filter endpoints.
This function generates choice options with optional counts
for use in filter metadata endpoints.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
include_counts: Whether to include counts for each option
queryset: QuerySet to count against (required if include_counts=True)
count_field: Field to filter on for counting (default: 'id')
Returns:
List of choice option dictionaries
"""
choices = registry.get_active_choices(choice_group, domain)
options = []
for choice in choices:
option_data = {
'value': choice.value,
'label': choice.label,
'description': choice.description,
'selected': False,
'deprecated': choice.deprecated,
'color': choice.color,
'icon': choice.icon,
'css_class': choice.css_class,
'metadata': choice.metadata,
}
if include_counts and queryset is not None:
# Count items for this choice
try:
count = queryset.filter(**{count_field: choice.value}).count()
option_data['count'] = count
except Exception:
# If counting fails, set count to None
option_data['count'] = None
else:
option_data['count'] = None
options.append(option_data)
# Sort by sort_order, then by label
options.sort(key=lambda x: (
(lambda c: c.sort_order if (c is not None and hasattr(c, 'sort_order')) else 0)(
registry.get_choice(choice_group, x['value'], domain)
),
x['label']
))
return options
def serialize_choice_value(
value: str,
choice_group: str,
domain: str = "core",
include_metadata: bool = False
) -> Any:
"""
Serialize a single choice value.
Args:
value: The choice value to serialize
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
include_metadata: Whether to include rich choice metadata
Returns:
Serialized choice value (string or rich object)
"""
if not value:
return value
if include_metadata:
choice = registry.get_choice(choice_group, value, domain)
if choice:
return RichChoiceSerializer(choice).data
else:
# Fallback for unknown values
return {
'value': value,
'label': value,
'description': '',
'metadata': {},
'deprecated': False,
'category': 'other',
'color': None,
'icon': None,
'css_class': None,
'sort_order': 0,
}
else:
return value

View File

@@ -0,0 +1,318 @@
"""
Utility Functions for Rich Choices
This module provides utility functions for working with rich choice objects.
"""
from typing import Any, Dict, List, Optional, Tuple
from .base import RichChoice, ChoiceCategory
from .registry import registry
def validate_choice_value(
value: str,
choice_group: str,
domain: str = "core",
allow_deprecated: bool = False
) -> bool:
"""
Validate that a choice value is valid for a given choice group.
Args:
value: The choice value to validate
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
allow_deprecated: Whether to allow deprecated choices
Returns:
True if valid, False otherwise
"""
if not value:
return True # Allow empty values (handled by field's null/blank settings)
choice = registry.get_choice(choice_group, value, domain)
if choice is None:
return False
if choice.deprecated and not allow_deprecated:
return False
return True
def get_choice_display(
value: str,
choice_group: str,
domain: str = "core"
) -> str:
"""
Get the display label for a choice value.
Args:
value: The choice value
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
Returns:
Display label for the choice
Raises:
ValueError: If the choice value is not found in the registry
"""
if not value:
return ""
choice = registry.get_choice(choice_group, value, domain)
if choice:
return choice.label
else:
raise ValueError(f"Choice value '{value}' not found in group '{choice_group}' for domain '{domain}'")
def create_status_choices(
statuses: Dict[str, Dict[str, Any]],
category: ChoiceCategory = ChoiceCategory.STATUS
) -> List[RichChoice]:
"""
Create status choices with consistent color coding.
Args:
statuses: Dictionary mapping status value to config dict
category: Choice category (defaults to STATUS)
Returns:
List of RichChoice objects for statuses
"""
choices = []
for value, config in statuses.items():
metadata = config.get('metadata', {})
# Add default status colors if not specified
if 'color' not in metadata:
if 'operating' in value.lower() or 'active' in value.lower():
metadata['color'] = 'green'
elif 'closed' in value.lower() or 'inactive' in value.lower():
metadata['color'] = 'red'
elif 'temp' in value.lower() or 'pending' in value.lower():
metadata['color'] = 'yellow'
elif 'construction' in value.lower():
metadata['color'] = 'blue'
else:
metadata['color'] = 'gray'
choice = RichChoice(
value=value,
label=config['label'],
description=config.get('description', ''),
metadata=metadata,
deprecated=config.get('deprecated', False),
category=category
)
choices.append(choice)
return choices
def create_type_choices(
types: Dict[str, Dict[str, Any]],
category: ChoiceCategory = ChoiceCategory.TYPE
) -> List[RichChoice]:
"""
Create type/classification choices.
Args:
types: Dictionary mapping type value to config dict
category: Choice category (defaults to TYPE)
Returns:
List of RichChoice objects for types
"""
choices = []
for value, config in types.items():
choice = RichChoice(
value=value,
label=config['label'],
description=config.get('description', ''),
metadata=config.get('metadata', {}),
deprecated=config.get('deprecated', False),
category=category
)
choices.append(choice)
return choices
def merge_choice_metadata(
base_metadata: Dict[str, Any],
override_metadata: Dict[str, Any]
) -> Dict[str, Any]:
"""
Merge choice metadata dictionaries.
Args:
base_metadata: Base metadata dictionary
override_metadata: Override metadata dictionary
Returns:
Merged metadata dictionary
"""
merged = base_metadata.copy()
merged.update(override_metadata)
return merged
def filter_choices_by_category(
choices: List[RichChoice],
category: ChoiceCategory
) -> List[RichChoice]:
"""
Filter choices by category.
Args:
choices: List of RichChoice objects
category: Category to filter by
Returns:
Filtered list of choices
"""
return [choice for choice in choices if choice.category == category]
def sort_choices(
choices: List[RichChoice],
sort_by: str = "sort_order"
) -> List[RichChoice]:
"""
Sort choices by specified criteria.
Args:
choices: List of RichChoice objects
sort_by: Sort criteria ("sort_order", "label", "value")
Returns:
Sorted list of choices
"""
if sort_by == "sort_order":
return sorted(choices, key=lambda x: (x.sort_order, x.label))
elif sort_by == "label":
return sorted(choices, key=lambda x: x.label)
elif sort_by == "value":
return sorted(choices, key=lambda x: x.value)
else:
return choices
def get_choice_colors(
choice_group: str,
domain: str = "core"
) -> Dict[str, str]:
"""
Get a mapping of choice values to their colors.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
Returns:
Dictionary mapping choice values to colors
"""
choices = registry.get_choices(choice_group, domain)
return {
choice.value: choice.color
for choice in choices
if choice.color
}
def validate_choice_group_data(
name: str,
choices: List[RichChoice],
domain: str = "core"
) -> List[str]:
"""
Validate choice group data and return list of errors.
Args:
name: Choice group name
choices: List of RichChoice objects
domain: Domain namespace
Returns:
List of validation error messages
"""
errors = []
if not name:
errors.append("Choice group name cannot be empty")
if not choices:
errors.append("Choice group must contain at least one choice")
return errors
# Check for duplicate values
values = [choice.value for choice in choices]
if len(values) != len(set(values)):
duplicates = [v for v in values if values.count(v) > 1]
errors.append(f"Duplicate choice values found: {', '.join(set(duplicates))}")
# Validate individual choices
for i, choice in enumerate(choices):
try:
# This will trigger __post_init__ validation
RichChoice(
value=choice.value,
label=choice.label,
description=choice.description,
metadata=choice.metadata,
deprecated=choice.deprecated,
category=choice.category
)
except ValueError as e:
errors.append(f"Choice {i}: {str(e)}")
return errors
def create_choice_from_config(config: Dict[str, Any]) -> RichChoice:
"""
Create a RichChoice from a configuration dictionary.
Args:
config: Configuration dictionary with choice data
Returns:
RichChoice object
"""
return RichChoice(
value=config['value'],
label=config['label'],
description=config.get('description', ''),
metadata=config.get('metadata', {}),
deprecated=config.get('deprecated', False),
category=ChoiceCategory(config.get('category', 'other'))
)
def export_choices_to_dict(
choice_group: str,
domain: str = "core"
) -> Dict[str, Any]:
"""
Export a choice group to a dictionary format.
Args:
choice_group: Name of the choice group in the registry
domain: Domain namespace for the choice group
Returns:
Dictionary representation of the choice group
"""
group = registry.get(choice_group, domain)
if not group:
return {}
return group.to_dict()

View File

@@ -2,7 +2,7 @@
Django management command to calculate new content.
This replaces the Celery task for calculating new content.
Run with: python manage.py calculate_new_content
Run with: uv run manage.py calculate_new_content
"""
import logging

View File

@@ -2,7 +2,7 @@
Django management command to calculate trending content.
This replaces the Celery task for calculating trending content.
Run with: python manage.py calculate_trending
Run with: uv run manage.py calculate_trending
"""
import logging

View File

@@ -94,7 +94,7 @@ class Command(BaseCommand):
try:
# Check if migrations are up to date
result = subprocess.run(
[sys.executable, "manage.py", "migrate", "--check"],
["uv", "run", "manage.py", "migrate", "--check"],
capture_output=True,
text=True,
)
@@ -106,7 +106,7 @@ class Command(BaseCommand):
else:
self.stdout.write("🔄 Running database migrations...")
subprocess.run(
[sys.executable, "manage.py", "migrate", "--noinput"], check=True
["uv", "run", "manage.py", "migrate", "--noinput"], check=True
)
self.stdout.write(
self.style.SUCCESS("✅ Database migrations completed")
@@ -123,7 +123,7 @@ class Command(BaseCommand):
try:
subprocess.run(
[sys.executable, "manage.py", "seed_sample_data"], check=True
["uv", "run", "manage.py", "seed_sample_data"], check=True
)
self.stdout.write(self.style.SUCCESS("✅ Sample data seeded"))
except subprocess.CalledProcessError:
@@ -163,7 +163,7 @@ class Command(BaseCommand):
try:
subprocess.run(
[sys.executable, "manage.py", "collectstatic", "--noinput", "--clear"],
["uv", "run", "manage.py", "collectstatic", "--noinput", "--clear"],
check=True,
)
self.stdout.write(self.style.SUCCESS("✅ Static files collected"))
@@ -182,7 +182,7 @@ class Command(BaseCommand):
# Build Tailwind CSS
subprocess.run(
[sys.executable, "manage.py", "tailwind", "build"], check=True
["uv", "run", "manage.py", "tailwind", "build"], check=True
)
self.stdout.write(self.style.SUCCESS("✅ Tailwind CSS built"))
@@ -198,7 +198,7 @@ class Command(BaseCommand):
self.stdout.write("🔍 Running system checks...")
try:
subprocess.run([sys.executable, "manage.py", "check"], check=True)
subprocess.run(["uv", "run", "manage.py", "check"], check=True)
self.stdout.write(self.style.SUCCESS("✅ System checks passed"))
except subprocess.CalledProcessError:
self.stdout.write(
@@ -220,5 +220,5 @@ class Command(BaseCommand):
self.stdout.write(" - API Documentation: http://localhost:8000/api/docs/")
self.stdout.write("")
self.stdout.write("🌟 Ready to start development server with:")
self.stdout.write(" python manage.py runserver")
self.stdout.write(" uv run manage.py runserver_plus")
self.stdout.write("")