acapy_agent.admin package

Submodules

acapy_agent.admin.base_server module

Abstract admin server interface.

class acapy_agent.admin.base_server.BaseAdminServer[source]

Bases: ABC

Admin HTTP server class.

abstractmethod async start() → None[source]

Start the webserver.

Raises:

AdminSetupError – If there was an error starting the webserver

abstractmethod async stop() → None[source]

Stop the webserver.

acapy_agent.admin.error module

Admin error classes.

exception acapy_agent.admin.error.AdminError(*args, error_code: str | None = None, **kwargs)[source]

Bases: BaseError

Base class for Admin-related errors.

exception acapy_agent.admin.error.AdminSetupError(*args, error_code: str | None = None, **kwargs)[source]

Bases: AdminError

Admin server setup or configuration error.

acapy_agent.admin.request_context module

Admin request context class.

A request context provided by the admin server to admin route handlers.

class acapy_agent.admin.request_context.AdminRequestContext(profile: Profile, *, context: InjectionContext | None = None, settings: Mapping[str, object] | None = None, root_profile: Profile | None = None, metadata: dict | None = None)[source]

Bases: object

Context established by the Conductor and passed into message handlers.

inject(base_cls: Type[InjectType], settings: Mapping[str, object] | None = None) → InjectType[source]

Get the provided instance of a given class identifier.

Parameters:

  • cls – The base class to retrieve an instance of

  • base_cls – The base class to retrieve an instance of

  • settings – An optional mapping providing configuration to the provider

Returns:

An instance of the base class, or None

inject_or(base_cls: Type[InjectType], settings: Mapping[str, object] | None = None, default: InjectType | None = None) → InjectType | None[source]

Get the provided instance of a given class identifier or default if not found.

Parameters:

  • base_cls – The base class to retrieve an instance of

  • settings – An optional dict providing configuration to the provider

  • default – default return value if no instance is found

Returns:

An instance of the base class, or None

property injector: Injector

Accessor for the associated Injector instance.

property metadata: dict

Accessor for the associated metadata.

property profile: Profile

Accessor for the associated Profile instance.

property root_profile: Profile | None

Accessor for the associated root_profile instance.

session() → ProfileSession[source]

Start a new interactive session with no transaction support requested.

property settings: Settings

Accessor for the context settings.

classmethod test_context(session_inject: dict, profile: Profile) → AdminRequestContext[source]

Quickly set up a new admin request context for tests.

transaction() → ProfileSession[source]

Start a new interactive session with commit and rollback support.

If the current backend does not support transactions, then commit and rollback operations of the session will not have any effect.

update_settings(settings: Mapping[str, object])[source]

Update the current scope with additional settings.

acapy_agent.admin.routes module

acapy_agent.admin.server module