Proxy

Abstract classes

Classes from which proxies will inherit.

AbstractCRUDableEntityTypeProxy

pydantic model crudcreator.proxy.AbstractCRUDableEntityTypeProxy.AbstractCRUDableEntityTypeProxy[source]

Transforms a CRUDable entity type. This class must be inherited.

field base: AbstractCRUDableEntityType [Required][source]

The type of entity to which the proxy plugs in and modifies behavior.

field params: AbstractProxyParams [Required][source]

Parameters for customizing a proxy. It’s up to the AbstractProxyParams implementations to build as they should.

classmethod build(
proxy_params: AbstractProxyParams,
base: AbstractCRUDableEntityType,
) AbstractCRUDableEntityTypeProxy[source]

Method to call to instantiate a Proxy.

Parameters:
Return type:

AbstractCRUDableEntityTypeProxy

async create(
params: CreateParams,
)[source]

Overload if you want to change the create behavior.

Parameters:

params (CreateParams) –

async delete(
params: DeleteParams,
)[source]

Overload if you want to change the delete behavior.

Parameters:

params (DeleteParams) –

async read(
params: ReadParams,
) list[dict[str, Any]][source]

Overload if you want to change the read behavior.

Parameters:

params (ReadParams) –

Return type:

list[dict[str, Any]]

async update(
params: UpdateParams,
)[source]

Overload if you want to change the update behavior.

Parameters:

params (UpdateParams) –

AbstractProxyParams

pydantic model crudcreator.proxy.AbstractProxyParams.AbstractProxyParams[source]

Parameters for customizing a proxy. It’s up to the AbstractProxyParams implementations to build as they should.

Proxies already implemented by CRUDCreator