ahriman.web package

Subpackages

• ahriman.web.middlewares package
  • Submodules
  • ahriman.web.middlewares.auth_handler module
    • setup_auth()
  • ahriman.web.middlewares.exception_handler module
    • exception_handler()
  • Module contents
• ahriman.web.schemas package
  • Submodules
  • ahriman.web.schemas.aur_package_schema module
    • AURPackageSchema
  • ahriman.web.schemas.auth_schema module
    • AuthSchema
  • ahriman.web.schemas.build_options_schema module
    • BuildOptionsSchema
  • ahriman.web.schemas.changes_schema module
    • ChangesSchema
  • ahriman.web.schemas.counters_schema module
    • CountersSchema
  • ahriman.web.schemas.error_schema module
    • ErrorSchema
  • ahriman.web.schemas.file_schema module
    • FileSchema
  • ahriman.web.schemas.info_schema module
    • InfoSchema
  • ahriman.web.schemas.internal_status_schema module
    • InternalStatusSchema
  • ahriman.web.schemas.log_schema module
    • LogSchema
  • ahriman.web.schemas.login_schema module
    • LoginSchema
  • ahriman.web.schemas.logs_schema module
    • LogsSchema
  • ahriman.web.schemas.oauth2_schema module
    • OAuth2Schema
  • ahriman.web.schemas.package_name_schema module
    • PackageNameSchema
  • ahriman.web.schemas.package_names_schema module
    • PackageNamesSchema
  • ahriman.web.schemas.package_patch_schema module
    • PackagePatchSchema
  • ahriman.web.schemas.package_properties_schema module
    • PackagePropertiesSchema
  • ahriman.web.schemas.package_schema module
    • PackageSchema
  • ahriman.web.schemas.package_status_schema module
    • PackageStatusSchema
    • PackageStatusSimplifiedSchema
  • ahriman.web.schemas.pagination_schema module
    • PaginationSchema
  • ahriman.web.schemas.patch_name_schema module
    • PatchNameSchema
  • ahriman.web.schemas.patch_schema module
    • PatchSchema
  • ahriman.web.schemas.pgp_key_id_schema module
    • PGPKeyIdSchema
  • ahriman.web.schemas.pgp_key_schema module
    • PGPKeySchema
  • ahriman.web.schemas.process_id_schema module
    • ProcessIdSchema
  • ahriman.web.schemas.process_schema module
    • ProcessSchema
  • ahriman.web.schemas.remote_schema module
    • RemoteSchema
  • ahriman.web.schemas.repository_id_schema module
    • RepositoryIdSchema
  • ahriman.web.schemas.search_schema module
    • SearchSchema
  • ahriman.web.schemas.status_schema module
    • StatusSchema
  • ahriman.web.schemas.update_flags_schema module
    • UpdateFlagsSchema
  • ahriman.web.schemas.versioned_log_schema module
    • VersionedLogSchema
  • ahriman.web.schemas.worker_schema module
    • WorkerSchema
  • Module contents
• ahriman.web.views package
  • Subpackages
    • ahriman.web.views.api package
      • Submodules
      • ahriman.web.views.api.docs module
      • ahriman.web.views.api.swagger module
      • Module contents
    • ahriman.web.views.v1 package
      • Subpackages
      • Module contents
    • ahriman.web.views.v2 package
      • Subpackages
      • Module contents
  • Submodules
  • ahriman.web.views.base module
    • BaseView
      • BaseView.OPTIONS_PERMISSION
      • BaseView.ROUTES
      • BaseView.get_non_empty()
      • BaseView.get_permission()
      • BaseView.head()
      • BaseView.page()
      • BaseView.repository_id()
      • BaseView.routes()
      • BaseView.service()
      • BaseView.username()
      • BaseView.configuration
      • BaseView.services
      • BaseView.sign
      • BaseView.spawner
      • BaseView.validator
      • BaseView.workers
  • ahriman.web.views.index module
    • IndexView
      • IndexView.GET_PERMISSION
      • IndexView.get()
  • ahriman.web.views.static module
    • StaticView
      • StaticView.GET_PERMISSION
      • StaticView.get()
  • ahriman.web.views.status_view_guard module
    • StatusViewGuard
      • StatusViewGuard.routes()
  • Module contents

Submodules

ahriman.web.apispec module

setup_apispec(application: Application) → AiohttpApiSpec

setup swagger api specification

Parameters:

application (Application) – web application instance

Returns:

created specification instance

Return type:

aiohttp_apispec.AiohttpApiSpec

ahriman.web.cors module

setup_cors(application: Application) → CorsConfig

setup CORS for the web application

Parameters:

application (Application) – web application instance

Returns:

generated CORS configuration

Return type:

aiohttp_cors.CorsConfig

ahriman.web.keys module

ahriman.web.routes module

setup_routes(application: Application, configuration: Configuration) → None

setup all defined routes

Parameters:

• application (Application) – web application instance

• configuration (Configuration) – configuration instance

ahriman.web.web module

run_server(application: Application) → None

run web application

Parameters:

application (Application) – web application instance

setup_server(configuration: Configuration, spawner: Spawn, repositories: list[RepositoryId]) → Application

create web application

Parameters:

• configuration (Configuration) – configuration instance

• spawner (Spawn) – spawner thread

• repositories (list[RepositoryId]) – list of known repositories

Returns:

web application instance

Return type:

Application

Raises:

InitializeError – if no repositories set

Module contents