ahriman.web.views.v1.service package

Submodules

ahriman.web.views.v1.service.add module

class AddView(request: None)

Bases: BaseView

add package web view

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → Response

add new package

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.pgp module

class PGPView(request: None)

Bases: BaseView

pgp key management web view

GET_PERMISSION

(class attribute) get permissions of self

Type:

UserAccess

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async get() → Response

retrieve key from the key server

Returns:

200 with key body on success

Return type:

Response

Raises:

  • HTTPBadRequest – if bad data is supplied

  • HTTPNotFound – if key wasn’t found or service was unable to fetch it

async post() → Response

store key to the local service environment

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.process module

class ProcessView(request: None)

Bases: BaseView

Process information web view

GET_PERMISSION

(class attribute) get permissions of self

Type:

UserAccess

async get() → Response

get spawned process status

Returns:

200 with process information

Return type:

Response

Raises:

HTTPNotFound – if no process found

ahriman.web.views.v1.service.rebuild module

class RebuildView(request: None)

Bases: BaseView

rebuild packages web view

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → Response

rebuild packages based on their dependency

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.remove module

class RemoveView(request: None)

Bases: BaseView

remove package web view

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → Response

remove existing packages

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.request module

class RequestView(request: None)

Bases: BaseView

request package web view. It is actually the same as AddView, but without now

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → Response

request to add new package

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.search module

class SearchView(request: None)

Bases: BaseView

AUR search web view

GET_PERMISSION

(class attribute) get permissions of self

Type:

UserAccess

async get() → Response

search packages in AUR

Returns:

200 with found package bases and descriptions sorted by base

Return type:

Response

Raises:

  • HTTPBadRequest – in case if bad data is supplied

  • HTTPNotFound – if no packages found

ahriman.web.views.v1.service.update module

class UpdateView(request: None)

Bases: BaseView

update repository web view

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → Response

run repository update. No parameters supported here

Returns:

200 with spawned process id

Return type:

Response

Raises:

HTTPBadRequest – if bad data is supplied

ahriman.web.views.v1.service.upload module

class UploadView(request: None)

Bases: BaseView

upload file to repository

POST_PERMISSION

(class attribute) post permissions of self

Type:

UserAccess

async post() → None

upload file from another instance to the server

Raises:

  • HTTPBadRequest – if bad data is supplied

  • HTTPCreated – on success response

  • HTTPNotFound – method is disabled by configuration

async static save_file(part: BodyPartReader, target: Path, *, max_body_size: int | None = None) → tuple[str, Path]

save file to local cache

Parameters:

  • part (BodyPartReader) – multipart part to be saved

  • target (Path) – path to directory to which file should be saved

  • max_body_size (int | None, optional) – max body size in bytes (Default value = None)

Returns:

map of received filename to its local path

Return type:

tuple[str, Path]

Raises:

HTTPBadRequest – if bad data is supplied

Module contents