Class swarmauri_middleware_session.SessionMiddleware.SessionMiddleware
swarmauri_middleware_session.SessionMiddleware.SessionMiddleware
SessionMiddleware(
session_storage=None,
session_header="X-Session-ID",
session_cookie="session_id",
max_age=3600,
**kwargs,
)
Bases: MiddlewareBase
, ComponentBase
Session middleware for maintaining session state across requests.
This middleware tracks sessions using headers or cookies. It ensures that session state is maintained across multiple requests from the same client.
ATTRIBUTE | DESCRIPTION |
---|---|
session_storage |
Dict[str, Dict] = {} # Storage for session data
TYPE:
|
session_header |
str = "X-Session-ID" # Header name for session ID
TYPE:
|
session_cookie |
str = "session_id" # Cookie name for session ID
TYPE:
|
max_age |
int = 3600 # Default session expiration in seconds
TYPE:
|
METHOD | DESCRIPTION |
---|---|
dispatch |
Implements the core middleware dispatch logic |
Source code in swarmauri_middleware_session/SessionMiddleware.py
34 35 36 37 38 39 40 41 42 43 44 45 46 |
|
session_storage
class-attribute
instance-attribute
session_storage = (
session_storage if session_storage is not None else {}
)
session_header
class-attribute
instance-attribute
session_header = session_header or 'X-Session-ID'
session_cookie
class-attribute
instance-attribute
session_cookie = session_cookie or 'session_id'
max_age
class-attribute
instance-attribute
max_age = max_age
type
class-attribute
instance-attribute
type = 'ComponentBase'
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
name
class-attribute
instance-attribute
name = None
version
class-attribute
instance-attribute
version = '0.1.0'
app
property
app
dispatch
async
dispatch(request, call_next)
Dispatches the request to the next middleware in the chain while maintaining session state.
This method processes the request to check for an existing session or create a new one. It ensures that session state is maintained across requests by setting appropriate headers or cookies.
PARAMETER | DESCRIPTION |
---|---|
request
|
The incoming request object
TYPE:
|
call_next
|
A callable that invokes the next middleware in the chain
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Any
|
The response object after processing the request |
Source code in swarmauri_middleware_session/SessionMiddleware.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|
on_scope
async
on_scope(scope)
Hook executed when the middleware receives a scope.
Source code in swarmauri_base/middlewares/MiddlewareBase.py
52 53 54 55 |
|
on_receive
async
on_receive(scope, message)
Hook executed for every message received from the client.
Source code in swarmauri_base/middlewares/MiddlewareBase.py
57 58 59 60 |
|
on_send
async
on_send(scope, message)
Hook executed before messages are sent to the client.
Source code in swarmauri_base/middlewares/MiddlewareBase.py
62 63 64 65 |
|
bind
bind(app)
Bind the downstream ASGI application to the middleware.
Source code in swarmauri_base/middlewares/MiddlewareBase.py
36 37 38 39 |
|
call_next
async
call_next(scope, receive, send)
Invoke the next ASGI application in the chain.
Source code in swarmauri_base/middlewares/MiddlewareBase.py
45 46 47 48 49 50 |
|