Ryth Azhur
b4c7e783bd
@client now handles both RPC and view functions based on return type:
@client(affects=UserContext)
def update_name(request, user_id: int, name: str) -> dict:
... # RPC path: JSON response with invalidate key
@client(affects=UserContext)
def update_profile(request, user_id: int) -> HttpResponse:
... # View path: HttpResponse with X-Mizan-Invalidate header
Detection: isinstance(result, HttpResponseBase) after execution.
RPC path (data return):
- Serialized via Pydantic model_dump()
- Wrapped in {"result": ..., "invalidate": [...]}
- Invalidation in JSON body + X-Mizan-Invalidate header
View path (HttpResponse return):
- Response passed through directly (redirect, HTML, etc.)
- X-Mizan-Invalidate header added automatically
- Cache-Control: no-store added
- No codegen (view_path=True in _meta)
- Registered in invalidation graph (for Edge manifest)
Auto-scoping works on both paths: if mutation args overlap
with context params, invalidation is scoped automatically.
308 Django tests pass.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
mizan (Python)
Django server functions framework. See the monorepo root for full documentation.
Install
uv add "mizan[channels,allauth] @ git+https://git.impactsoundworks.com/isw/mizan.git#subdirectory=django"
Setup
# settings.py
INSTALLED_APPS = ["mizan", ...]
# urls.py
path("api/mizan/", include("mizan.urls"))
# asgi.py (optional, for WebSocket)
from mizan import wrap_asgi
application = wrap_asgi(get_asgi_application())
Define Functions
from mizan.client import client
from mizan.setup.registry import register
from pydantic import BaseModel
class Output(BaseModel):
message: str
@client
def echo(request, text: str) -> Output:
return Output(message=text)
register(echo, "echo")
Register in apps.py:
def ready(self):
import myapp.mizan_clients
Auth
@client(auth=True) # requires authentication
@client(auth='staff') # requires is_staff
@client(auth='superuser') # requires is_superuser
@client(auth=my_callable) # custom check
Contexts
@client(context='global') # fetched once, SSR-hydrated, becomes useCurrentUser()
@client(context='local') # fetched with params, becomes <GreetProvider>
Forms
from mizan.forms import mizanFormMixin, mizanFormMeta
class ContactForm(mizanFormMixin, forms.Form):
mizan = mizanFormMeta(name="contact", title="Contact Us")
name = forms.CharField()
email = forms.EmailField()
def on_submit_success(self, request):
return {"sent": True}
Auto-registers contact.schema, contact.validate, contact.submit. Generates useContactForm() with Zod validation.
Channels
from mizan.channels import ReactChannel
class ChatChannel(ReactChannel):
class Params(BaseModel):
room: str
class DjangoMessage(BaseModel):
text: str
def authorize(self, params):
return self.user.is_authenticated
def group(self, params):
return f"chat_{params.room}"
Generates useChatChannel({ room }).
Running Tests
uv sync --extra dev --extra channels
uv run pytest