Code Samples

Python code samples and examples displayed on the homepage.

Module Contents

Code Samples domain.

class CodeSample

Bases: AuditBase, SlugMixin

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

code: Mapped[str]

created_at: Mapped[datetime.datetime]

Date/time of instance creation.

creator_id: Mapped[UUID]

description: Mapped[str]

id: Mapped[UUID]

UUID Primary key column.

is_published: Mapped[bool]

slug: Mapped[str]

updated_at: Mapped[datetime.datetime]

Date/time of instance last update.

class CodeSampleController

Bases: Controller

Controller for CodeSample CRUD operations.

after_request: AfterRequestHookHandler | None

A sync or async function executed before a Request is passed to any route handler.

If this function returns a value, the request will not reach the route handler, and instead this value will be used.

after_response: AfterResponseHookHandler | None

A sync or async function called after the response has been awaited.

It receives the Request instance and should not return any values.

before_request: BeforeRequestHookHandler | None

A sync or async function called immediately before calling the route handler.

It receives the Request instance and any non-None return value is used for the response, bypassing the route handler.

cache_control: CacheControlHeader | None

A CacheControlHeader header to add to route handlers of this controller.

Can be overridden by route handlers.

dependencies: Dependencies | None

A string keyed dictionary of dependency Provider instances.

dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for (de)serializing and validation of request data.

etag: ETag | None

An etag header of type ETag to add to route handlers of this controller.

Can be overridden by route handlers.

exception_handlers: ExceptionHandlersMap | None

A map of handler functions to status codes and/or exception types.

guards: Sequence[Guard] | None

A sequence of Guard callables.

include_in_schema: bool | EmptyType

A boolean flag dictating whether the route handler should be documented in the OpenAPI schema

middleware: Sequence[Middleware] | None

A sequence of Middleware.

opt: Mapping[str, Any] | None

A string key mapping of arbitrary values that can be accessed in Guards or wherever you have access to Request or ASGI Scope.

owner: Router

The Router or Litestar app that owns the controller.

This value is set internally by Litestar and it should not be set when subclassing the controller.

parameters: ParametersMap | None

A mapping of Parameter definitions available to all application paths.

path: str

A path fragment for the controller.

All route handlers under the controller will have the fragment appended to them. If not set it defaults to /.

request_class: type[Request] | None

A custom subclass of Request to be used as the default request for all route handlers under the controller.

request_max_body_size: int | None | EmptyType

Maximum allowed size of the request body in bytes. If this size is exceeded, a ‘413 - Request Entity Too Large’ error response is returned.

response_class: type[Response] | None

A custom subclass of Response to be used as the default response for all route handlers under the controller.

response_cookies: ResponseCookies | None

A list of Cookie instances.

response_headers: ResponseHeaders | None

A string keyed dictionary mapping ResponseHeader instances.

return_dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for serializing outbound response data.

security: Sequence[SecurityRequirement] | None

A sequence of dictionaries that to the schema of all route handlers under the controller.

signature_namespace: dict[str, Any]

A mapping of names to types for use in forward reference resolution during signature modelling.

signature_types: Sequence[Any]

A sequence of types for use in forward reference resolution during signature modelling.

These types will be added to the signature namespace using their __name__ attribute.

tags: Sequence[str] | None

A sequence of string tags that will be appended to the schema of all route handlers under the controller.

type_decoders: TypeDecodersSequence | None

A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.

type_encoders: TypeEncodersMap | None

A mapping of types to callables that transform them into types supported for serialization.

websocket_class: type[WebSocket] | None

A custom subclass of WebSocket to be used as the default websocket for all route handlers under the controller.

create_code_sample(fn) = <litestar.handlers.http_handlers.decorators.post object>

delete_code_sample(fn) = <litestar.handlers.http_handlers.decorators.delete object>

get_code_sample(fn) = <litestar.handlers.http_handlers.decorators.get object>

get_code_sample_by_slug(fn) = <litestar.handlers.http_handlers.decorators.get object>

list_code_samples(fn) = <litestar.handlers.http_handlers.decorators.get object>

list_published_code_samples(fn) = <litestar.handlers.http_handlers.decorators.get object>

update_code_sample(fn) = <litestar.handlers.http_handlers.decorators.put object>

class CodeSampleCreate

Bases: CodeSampleBase

Schema for creating a new CodeSample.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

creator_id: UUID

class CodeSampleList

Bases: BaseModel

Schema for CodeSample list items.

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

id: UUID

slug: str

description: str

is_published: bool

created_at: datetime.datetime

class CodeSampleRead

Bases: CodeSampleBase

Schema for reading CodeSample data.

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

id: UUID

slug: str

creator_id: UUID

created_at: datetime.datetime

updated_at: datetime.datetime

class CodeSampleRepository

Bases: SQLAlchemyAsyncRepository[CodeSample]

Repository for CodeSample database operations.

async get_by_slug(slug)

Get a code sample by slug.

Parameters:

slug (str) – The slug to search for.

Return type:

CodeSample | None

Returns:

The code sample if found, None otherwise.

async get_published_samples(limit=100, offset=0)

Get published code samples.

Parameters:

• limit (int) – Maximum number of samples to return.

• offset (int) – Number of samples to skip.

Return type:

list[CodeSample]

Returns:

List of published code samples ordered by created_at descending.

model_type

alias of CodeSample

class CodeSampleService

Bases: SQLAlchemyAsyncRepositoryService[CodeSample, Any]

Service for CodeSample business logic.

async get_by_slug(slug)

Get a code sample by slug.

Parameters:

slug (str) – The slug to search for.

Return type:

CodeSample | None

Returns:

The code sample if found, None otherwise.

async get_published_samples(limit=100, offset=0)

Get published code samples.

Parameters:

• limit (int) – Maximum number of samples to return.

• offset (int) – Number of samples to skip.

Return type:

list[CodeSample]

Returns:

List of published code samples.

match_fields: ClassVar[Optional[Union[list[str], str]]] = ['slug']

List of dialects that prefer to use field.id = ANY(:1) instead of field.id IN (...).

repository_type

alias of CodeSampleRepository

class CodeSampleUpdate

Bases: BaseModel

Schema for updating a CodeSample.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

code: str | None

description: str | None

is_published: bool | None

class CodeSamplesPageController

Bases: Controller

Controller for code samples HTML pages.

after_request: AfterRequestHookHandler | None

A sync or async function executed before a Request is passed to any route handler.

If this function returns a value, the request will not reach the route handler, and instead this value will be used.

after_response: AfterResponseHookHandler | None

A sync or async function called after the response has been awaited.

It receives the Request instance and should not return any values.

before_request: BeforeRequestHookHandler | None

A sync or async function called immediately before calling the route handler.

It receives the Request instance and any non-None return value is used for the response, bypassing the route handler.

cache_control: CacheControlHeader | None

A CacheControlHeader header to add to route handlers of this controller.

Can be overridden by route handlers.

dependencies: Dependencies | None

A string keyed dictionary of dependency Provider instances.

dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for (de)serializing and validation of request data.

etag: ETag | None

An etag header of type ETag to add to route handlers of this controller.

Can be overridden by route handlers.

exception_handlers: ExceptionHandlersMap | None

A map of handler functions to status codes and/or exception types.

guards: Sequence[Guard] | None

A sequence of Guard callables.

include_in_schema: bool | EmptyType

A boolean flag dictating whether the route handler should be documented in the OpenAPI schema

middleware: Sequence[Middleware] | None

A sequence of Middleware.

opt: Mapping[str, Any] | None

A string key mapping of arbitrary values that can be accessed in Guards or wherever you have access to Request or ASGI Scope.

owner: Router

The Router or Litestar app that owns the controller.

This value is set internally by Litestar and it should not be set when subclassing the controller.

parameters: ParametersMap | None

A mapping of Parameter definitions available to all application paths.

path: str

A path fragment for the controller.

All route handlers under the controller will have the fragment appended to them. If not set it defaults to /.

request_class: type[Request] | None

A custom subclass of Request to be used as the default request for all route handlers under the controller.

request_max_body_size: int | None | EmptyType

Maximum allowed size of the request body in bytes. If this size is exceeded, a ‘413 - Request Entity Too Large’ error response is returned.

response_class: type[Response] | None

A custom subclass of Response to be used as the default response for all route handlers under the controller.

response_cookies: ResponseCookies | None

A list of Cookie instances.

response_headers: ResponseHeaders | None

A string keyed dictionary mapping ResponseHeader instances.

return_dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for serializing outbound response data.

security: Sequence[SecurityRequirement] | None

A sequence of dictionaries that to the schema of all route handlers under the controller.

signature_namespace: dict[str, Any]

A mapping of names to types for use in forward reference resolution during signature modelling.

signature_types: Sequence[Any]

A sequence of types for use in forward reference resolution during signature modelling.

These types will be added to the signature namespace using their __name__ attribute.

tags: Sequence[str] | None

A sequence of string tags that will be appended to the schema of all route handlers under the controller.

type_decoders: TypeDecodersSequence | None

A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.

type_encoders: TypeEncodersMap | None

A mapping of types to callables that transform them into types supported for serialization.

websocket_class: type[WebSocket] | None

A custom subclass of WebSocket to be used as the default websocket for all route handlers under the controller.

code_sample_detail(fn) = <litestar.handlers.http_handlers.decorators.get object>

code_samples_index(fn) = <litestar.handlers.http_handlers.decorators.get object>

get_codesamples_dependencies()

Get all code samples domain dependency providers.

Return type:

dict

Models

Code Samples domain models.

class CodeSample

Bases: AuditBase, SlugMixin

code: Mapped[str]

description: Mapped[str]

is_published: Mapped[bool]

creator_id: Mapped[UUID]

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

created_at: Mapped[datetime.datetime]

Date/time of instance creation.

id: Mapped[UUID]

UUID Primary key column.

slug: Mapped[str]

updated_at: Mapped[datetime.datetime]

Date/time of instance last update.

Schemas

Code Samples domain Pydantic schemas.

class CodeSampleBase

Bases: BaseModel

Base CodeSample schema with common fields.

code: str

description: str

is_published: bool

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CodeSampleCreate

Bases: CodeSampleBase

Schema for creating a new CodeSample.

creator_id: UUID

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

code: str

description: str

is_published: bool

class CodeSampleUpdate

Bases: BaseModel

Schema for updating a CodeSample.

code: str | None

description: str | None

is_published: bool | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CodeSampleRead

Bases: CodeSampleBase

Schema for reading CodeSample data.

id: UUID

slug: str

creator_id: UUID

created_at: datetime.datetime

updated_at: datetime.datetime

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

code: str

description: str

is_published: bool

class CodeSampleList

Bases: BaseModel

Schema for CodeSample list items.

id: UUID

slug: str

description: str

is_published: bool

created_at: datetime.datetime

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Repositories

Code Samples domain repositories for database access.

class CodeSampleRepository

Bases: SQLAlchemyAsyncRepository[CodeSample]

Repository for CodeSample database operations.

model_type

alias of CodeSample

async get_by_slug(slug)

Get a code sample by slug.

Parameters:

slug (str) – The slug to search for.

Return type:

CodeSample | None

Returns:

The code sample if found, None otherwise.

async get_published_samples(limit=100, offset=0)

Get published code samples.

Parameters:

• limit (int) – Maximum number of samples to return.

• offset (int) – Number of samples to skip.

Return type:

list[CodeSample]

Returns:

List of published code samples ordered by created_at descending.

Services

Code Samples domain services for business logic.

class CodeSampleService

Bases: SQLAlchemyAsyncRepositoryService[CodeSample, Any]

Service for CodeSample business logic.

repository_type

alias of CodeSampleRepository

match_fields: ClassVar[Optional[Union[list[str], str]]] = ['slug']

List of dialects that prefer to use field.id = ANY(:1) instead of field.id IN (...).

async get_by_slug(slug)

Get a code sample by slug.

Parameters:

slug (str) – The slug to search for.

Return type:

CodeSample | None

Returns:

The code sample if found, None otherwise.

async get_published_samples(limit=100, offset=0)

Get published code samples.

Parameters:

• limit (int) – Maximum number of samples to return.

• offset (int) – Number of samples to skip.

Return type:

list[CodeSample]

Returns:

List of published code samples.

Controllers

Code Samples domain API and page controllers.

class CodeSampleController

Bases: Controller

Controller for CodeSample CRUD operations.

path: str

A path fragment for the controller.

All route handlers under the controller will have the fragment appended to them. If not set it defaults to /.

tags: Sequence[str] | None

A sequence of string tags that will be appended to the schema of all route handlers under the controller.

list_code_samples(fn) = <litestar.handlers.http_handlers.decorators.get object>

get_code_sample(fn) = <litestar.handlers.http_handlers.decorators.get object>

get_code_sample_by_slug(fn) = <litestar.handlers.http_handlers.decorators.get object>

list_published_code_samples(fn) = <litestar.handlers.http_handlers.decorators.get object>

create_code_sample(fn) = <litestar.handlers.http_handlers.decorators.post object>

update_code_sample(fn) = <litestar.handlers.http_handlers.decorators.put object>

delete_code_sample(fn) = <litestar.handlers.http_handlers.decorators.delete object>

after_request: AfterRequestHookHandler | None

A sync or async function executed before a Request is passed to any route handler.

If this function returns a value, the request will not reach the route handler, and instead this value will be used.

after_response: AfterResponseHookHandler | None

A sync or async function called after the response has been awaited.

It receives the Request instance and should not return any values.

before_request: BeforeRequestHookHandler | None

A sync or async function called immediately before calling the route handler.

It receives the Request instance and any non-None return value is used for the response, bypassing the route handler.

cache_control: CacheControlHeader | None

A CacheControlHeader header to add to route handlers of this controller.

Can be overridden by route handlers.

dependencies: Dependencies | None

A string keyed dictionary of dependency Provider instances.

dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for (de)serializing and validation of request data.

etag: ETag | None

An etag header of type ETag to add to route handlers of this controller.

Can be overridden by route handlers.

exception_handlers: ExceptionHandlersMap | None

A map of handler functions to status codes and/or exception types.

guards: Sequence[Guard] | None

A sequence of Guard callables.

include_in_schema: bool | EmptyType

A boolean flag dictating whether the route handler should be documented in the OpenAPI schema

middleware: Sequence[Middleware] | None

A sequence of Middleware.

opt: Mapping[str, Any] | None

A string key mapping of arbitrary values that can be accessed in Guards or wherever you have access to Request or ASGI Scope.

owner: Router

The Router or Litestar app that owns the controller.

This value is set internally by Litestar and it should not be set when subclassing the controller.

parameters: ParametersMap | None

A mapping of Parameter definitions available to all application paths.

request_class: type[Request] | None

A custom subclass of Request to be used as the default request for all route handlers under the controller.

request_max_body_size: int | None | EmptyType

Maximum allowed size of the request body in bytes. If this size is exceeded, a ‘413 - Request Entity Too Large’ error response is returned.

response_class: type[Response] | None

A custom subclass of Response to be used as the default response for all route handlers under the controller.

response_cookies: ResponseCookies | None

A list of Cookie instances.

response_headers: ResponseHeaders | None

A string keyed dictionary mapping ResponseHeader instances.

return_dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for serializing outbound response data.

security: Sequence[SecurityRequirement] | None

A sequence of dictionaries that to the schema of all route handlers under the controller.

signature_namespace: dict[str, Any]

A mapping of names to types for use in forward reference resolution during signature modelling.

signature_types: Sequence[Any]

A sequence of types for use in forward reference resolution during signature modelling.

These types will be added to the signature namespace using their __name__ attribute.

type_decoders: TypeDecodersSequence | None

A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.

type_encoders: TypeEncodersMap | None

A mapping of types to callables that transform them into types supported for serialization.

websocket_class: type[WebSocket] | None

A custom subclass of WebSocket to be used as the default websocket for all route handlers under the controller.

class CodeSamplesPageController

Bases: Controller

Controller for code samples HTML pages.

path: str

A path fragment for the controller.

All route handlers under the controller will have the fragment appended to them. If not set it defaults to /.

include_in_schema: bool | EmptyType

A boolean flag dictating whether the route handler should be documented in the OpenAPI schema

code_samples_index(fn) = <litestar.handlers.http_handlers.decorators.get object>

code_sample_detail(fn) = <litestar.handlers.http_handlers.decorators.get object>

after_request: AfterRequestHookHandler | None

A sync or async function executed before a Request is passed to any route handler.

If this function returns a value, the request will not reach the route handler, and instead this value will be used.

after_response: AfterResponseHookHandler | None

A sync or async function called after the response has been awaited.

It receives the Request instance and should not return any values.

before_request: BeforeRequestHookHandler | None

A sync or async function called immediately before calling the route handler.

It receives the Request instance and any non-None return value is used for the response, bypassing the route handler.

cache_control: CacheControlHeader | None

A CacheControlHeader header to add to route handlers of this controller.

Can be overridden by route handlers.

dependencies: Dependencies | None

A string keyed dictionary of dependency Provider instances.

dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for (de)serializing and validation of request data.

etag: ETag | None

An etag header of type ETag to add to route handlers of this controller.

Can be overridden by route handlers.

exception_handlers: ExceptionHandlersMap | None

A map of handler functions to status codes and/or exception types.

guards: Sequence[Guard] | None

A sequence of Guard callables.

middleware: Sequence[Middleware] | None

A sequence of Middleware.

opt: Mapping[str, Any] | None

A string key mapping of arbitrary values that can be accessed in Guards or wherever you have access to Request or ASGI Scope.

owner: Router

The Router or Litestar app that owns the controller.

This value is set internally by Litestar and it should not be set when subclassing the controller.

parameters: ParametersMap | None

A mapping of Parameter definitions available to all application paths.

request_class: type[Request] | None

A custom subclass of Request to be used as the default request for all route handlers under the controller.

request_max_body_size: int | None | EmptyType

Maximum allowed size of the request body in bytes. If this size is exceeded, a ‘413 - Request Entity Too Large’ error response is returned.

response_class: type[Response] | None

A custom subclass of Response to be used as the default response for all route handlers under the controller.

response_cookies: ResponseCookies | None

A list of Cookie instances.

response_headers: ResponseHeaders | None

A string keyed dictionary mapping ResponseHeader instances.

return_dto: type[AbstractDTO] | None | EmptyType

AbstractDTO to use for serializing outbound response data.

security: Sequence[SecurityRequirement] | None

A sequence of dictionaries that to the schema of all route handlers under the controller.

signature_namespace: dict[str, Any]

A mapping of names to types for use in forward reference resolution during signature modelling.

signature_types: Sequence[Any]

A sequence of types for use in forward reference resolution during signature modelling.

These types will be added to the signature namespace using their __name__ attribute.

tags: Sequence[str] | None

A sequence of string tags that will be appended to the schema of all route handlers under the controller.

type_decoders: TypeDecodersSequence | None

A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.

type_encoders: TypeEncodersMap | None

A mapping of types to callables that transform them into types supported for serialization.

websocket_class: type[WebSocket] | None

A custom subclass of WebSocket to be used as the default websocket for all route handlers under the controller.

Dependencies

Code Samples domain dependency injection providers.

async provide_code_sample_repository(db_session)

Provide a CodeSampleRepository instance.

Return type:

CodeSampleRepository

async provide_code_sample_service(db_session)

Provide a CodeSampleService instance.

Return type:

CodeSampleService

get_codesamples_dependencies()

Get all code samples domain dependency providers.

Return type:

dict