Class swarmauri_middleware_cors.CustomCORSMiddleware.CustomCORSMiddleware

swarmauri_middleware_cors.CustomCORSMiddleware.CustomCORSMiddleware

CustomCORSMiddleware(
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
    expose_headers=[],
    max_age=600,
    **kwargs,
)

Bases: MiddlewareBase

Custom CORS Middleware implementation.

This middleware provides custom CORS handling for incoming requests. It allows for flexible configuration of CORS policies while maintaining the core functionality required for secure CORS handling.

ATTRIBUTE	DESCRIPTION
allow_origins	List[str] = ["*"] # Allowed origins TYPE: List[str]
allow_credentials	bool = True # Whether to allow credentials TYPE: bool
allow_methods	List[str] = ["*"] # Allowed HTTP methods TYPE: List[str]
allow_headers	List[str] = ["*"] # Allowed request headers TYPE: List[str]
expose_headers	List[str] = [] # Headers to expose in responses TYPE: List[str]
max_age	int = 600 # Maximum age for CORS configuration TYPE: int

Initialize the CustomCORSMiddleware with CORS configuration.

PARAMETER	DESCRIPTION
allow_origins	List of allowed origins. Defaults to ["*"]. TYPE: List[str] DEFAULT: ['*']
allow_credentials	Whether to allow credentials. Defaults to True. TYPE: bool DEFAULT: True
allow_methods	List of allowed HTTP methods. Defaults to ["*"]. TYPE: List[str] DEFAULT: ['*']
allow_headers	List of allowed request headers. Defaults to ["*"]. TYPE: List[str] DEFAULT: ['*']
expose_headers	List of headers to expose in responses. Defaults to []. TYPE: List[str] DEFAULT: []
max_age	Maximum age for CORS configuration. Defaults to 600. TYPE: int DEFAULT: 600

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

def __init__(
    self,
    allow_origins: List[str] = ["*"],
    allow_credentials: bool = True,
    allow_methods: List[str] = ["*"],
    allow_headers: List[str] = ["*"],
    expose_headers: List[str] = [],
    max_age: int = 600,
    **kwargs: Any,
):
    """Initialize the CustomCORSMiddleware with CORS configuration.

    Args:
        allow_origins: List of allowed origins. Defaults to ["*"].
        allow_credentials: Whether to allow credentials. Defaults to True.
        allow_methods: List of allowed HTTP methods. Defaults to ["*"].
        allow_headers: List of allowed request headers. Defaults to ["*"].
        expose_headers: List of headers to expose in responses. Defaults to [].
        max_age: Maximum age for CORS configuration. Defaults to 600.
    """
    super().__init__(**kwargs)
    self.allow_origins = allow_origins
    self.allow_credentials = allow_credentials
    self.allow_methods = allow_methods
    self.allow_headers = allow_headers
    self.expose_headers = expose_headers
    self.max_age = max_age

allow_origins class-attribute instance-attribute

allow_origins = allow_origins

allow_credentials class-attribute instance-attribute

allow_credentials = allow_credentials

allow_methods class-attribute instance-attribute

allow_methods = allow_methods

allow_headers class-attribute instance-attribute

allow_headers = allow_headers

expose_headers class-attribute instance-attribute

expose_headers = expose_headers

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

resource class-attribute instance-attribute

resource = MIDDLEWARE.value

version class-attribute instance-attribute

version = '0.1.0'

app property

app

dispatch async

dispatch(request, call_next)

Dispatch the request to the next middleware in the chain.

This method processes the incoming request, performs CORS checks, and either allows or denies the request based on the configured CORS policy. It then calls the next middleware in the chain.

PARAMETER	DESCRIPTION
request	The incoming request object. TYPE: Request
call_next	A callable that invokes the next middleware. TYPE: Callable[[Request], Any]

RETURNS	DESCRIPTION
Any	The response object after processing by all middlewares.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

async def dispatch(
    self, request: Request, call_next: Callable[[Request], Any]
) -> Any:
    """Dispatch the request to the next middleware in the chain.

    This method processes the incoming request, performs CORS checks,
    and either allows or denies the request based on the configured
    CORS policy. It then calls the next middleware in the chain.

    Args:
        request: The incoming request object.
        call_next: A callable that invokes the next middleware.

    Returns:
        The response object after processing by all middlewares.
    """
    try:
        if await self.is_options_request(request):
            return await self.handle_options_request(request)

        origin = request.headers.get("Origin", "")
        if not await self.check_cors_origin(origin):
            return self.get_cors_error_response("Invalid origin")

        response = await call_next(request)
        response = await self.add_cors_headers(response)
        return response

    except Exception as e:
        logger.error(f"CORS middleware error: {str(e)}")
        return self.get_cors_error_response("Internal server error")

is_options_request async

is_options_request(request)

Check if the request is an OPTIONS request.

PARAMETER	DESCRIPTION
request	The incoming request object. TYPE: Request

RETURNS	DESCRIPTION
bool	True if the request method is OPTIONS, False otherwise.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

async def is_options_request(self, request: Request) -> bool:
    """Check if the request is an OPTIONS request.

    Args:
        request: The incoming request object.

    Returns:
        True if the request method is OPTIONS, False otherwise.
    """
    return request.method == "OPTIONS"

check_cors_origin async

check_cors_origin(origin)

Check if the request origin is allowed.

PARAMETER	DESCRIPTION
origin	The request origin to check. TYPE: str

RETURNS	DESCRIPTION
bool	True if the origin is allowed, False otherwise.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

async def check_cors_origin(self, origin: str) -> bool:
    """Check if the request origin is allowed.

    Args:
        origin: The request origin to check.

    Returns:
        True if the origin is allowed, False otherwise.
    """
    if not origin:
        return False
    if origin in self.allow_origins:
        return True
    return False

handle_options_request async

handle_options_request(request)

Handle an OPTIONS request.

This method sets the appropriate CORS headers for OPTIONS requests and returns an empty response with status code 200.

PARAMETER	DESCRIPTION
request	The incoming OPTIONS request. TYPE: Request

RETURNS	DESCRIPTION
Response	A response object with CORS headers.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

async def handle_options_request(self, request: Request) -> Response:
    """Handle an OPTIONS request.

    This method sets the appropriate CORS headers for OPTIONS requests
    and returns an empty response with status code 200.

    Args:
        request: The incoming OPTIONS request.

    Returns:
        A response object with CORS headers.
    """
    response = Response()
    response = await self.add_cors_headers(response)
    return response

add_cors_headers async

add_cors_headers(response)

Add CORS headers to the response.

This method adds the configured CORS headers to the response object and returns the modified response.

PARAMETER	DESCRIPTION
response	The response object to modify. TYPE: Response

RETURNS	DESCRIPTION
Response	The response object with CORS headers added.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

async def add_cors_headers(self, response: Response) -> Response:
    """Add CORS headers to the response.

    This method adds the configured CORS headers to the response
    object and returns the modified response.

    Args:
        response: The response object to modify.

    Returns:
        The response object with CORS headers added.
    """
    response.headers["Access-Control-Allow-Origin"] = ",".join(self.allow_origins)
    response.headers["Access-Control-Allow-Methods"] = ",".join(self.allow_methods)
    response.headers["Access-Control-Allow-Headers"] = ",".join(self.allow_headers)
    response.headers["Access-Control-Expose-Headers"] = ",".join(
        self.expose_headers
    )
    response.headers["Access-Control-Allow-Credentials"] = str(
        self.allow_credentials
    ).lower()
    response.headers["Access-Control-Max-Age"] = str(self.max_age)
    return response

get_cors_error_response

get_cors_error_response(message)

Generate a CORS error response.

PARAMETER	DESCRIPTION
message	The error message to include in the response. TYPE: str

RETURNS	DESCRIPTION
Response	A response object with the error message and appropriate status code.

Source code in swarmauri_middleware_cors/CustomCORSMiddleware.py

def get_cors_error_response(self, message: str) -> Response:
    """Generate a CORS error response.

    Args:
        message: The error message to include in the response.

    Returns:
        A response object with the error message and appropriate status code.
    """
    response = Response(content=message, status_code=403)
    return response

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: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

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: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

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

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

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

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger

on_scope async

on_scope(scope)

Hook executed when the middleware receives a scope.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_scope(self, scope: Scope) -> Scope:
    """Hook executed when the middleware receives a scope."""

    return scope

on_receive async

on_receive(scope, message)

Hook executed for every message received from the client.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_receive(self, scope: Scope, message: Message) -> Message:
    """Hook executed for every message received from the client."""

    return message

on_send async

on_send(scope, message)

Hook executed before messages are sent to the client.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def on_send(self, scope: Scope, message: Message) -> Message:
    """Hook executed before messages are sent to the client."""

    return message

bind

bind(app)

Bind the downstream ASGI application to the middleware.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

def bind(self, app: ASGIApp) -> None:
    """Bind the downstream ASGI application to the middleware."""

    self._app = app

call_next async

call_next(scope, receive, send)

Invoke the next ASGI application in the chain.

Source code in swarmauri_base/middlewares/MiddlewareBase.py

async def call_next(
    self, scope: Scope, receive: ReceiveCallable, send: SendCallable
) -> None:
    """Invoke the next ASGI application in the chain."""

    await self.app(scope, receive, send)