aria2_server.app.server

__all__ module-attribute

__all__ = (
    "RunKwargs",
    "RunWithKwargs",
    "app",
    "build_run_kwargs",
    "build_run_with_kwargs",
    "get_server",
    "run",
    "run_with",
    "utils",
)

run module-attribute

run = _LogSSLError()(run)

run_with module-attribute

run_with = run_with

app module-attribute

app = app

RunWithKwargs

Bases: _BaseUiKwargs

title instance-attribute

title: str

favicon instance-attribute

favicon: Optional[Union[str, Path]]

dark instance-attribute

dark: Union[bool, None]

language instance-attribute

language: LanguageType

storage_secret instance-attribute

storage_secret: str

app instance-attribute

app: FastAPI

RunKwargs

Bases: _UvicornKwargs, _BaseUiKwargs

title instance-attribute

title: str

favicon instance-attribute

favicon: Optional[Union[str, Path]]

dark instance-attribute

dark: Union[bool, None]

language instance-attribute

language: LanguageType

storage_secret instance-attribute

storage_secret: str

ssl_keyfile instance-attribute

ssl_keyfile: Optional[str]

ssl_certfile instance-attribute

ssl_certfile: Optional[Path]

ssl_keyfile_password instance-attribute

ssl_keyfile_password: Optional[str]

root_path instance-attribute

root_path: str

host instance-attribute

host: IpvAnyHostType

port instance-attribute

port: int

show instance-attribute

show: bool

reload instance-attribute

reload: Literal[False]

uvicorn_logging_level instance-attribute

uvicorn_logging_level: UvicornLoggingLevelType

endpoint_documentation instance-attribute

endpoint_documentation: EndpointDocumentationType

build_run_kwargs

build_run_kwargs(storage_secret: str) -> RunKwargs

Source code in src/aria2_server/app/server/__init__.py

def build_run_kwargs(storage_secret: str) -> RunKwargs:
    reload = False
    run_kwargs = RunKwargs(
        host=GLOBAL_CONFIG.server.host,
        port=GLOBAL_CONFIG.server.port,
        uvicorn_logging_level=GLOBAL_CONFIG.server.uvicorn_logging_level,
        reload=reload,
        show=GLOBAL_CONFIG.server.show,
        endpoint_documentation=GLOBAL_CONFIG.server.endpoint_documentation,
        **_build_base_ui_kwargs(storage_secret),
        **_build_uvivorn_kwargs(),
    )

    return run_kwargs

build_run_with_kwargs

build_run_with_kwargs(
    app: FastAPI, storage_secret: str
) -> RunWithKwargs

Source code in src/aria2_server/app/server/__init__.py

def build_run_with_kwargs(app: FastAPI, storage_secret: str) -> RunWithKwargs:
    run_with_kwargs = RunWithKwargs(app=app, **_build_base_ui_kwargs(storage_secret))

    return run_with_kwargs

get_server

get_server() -> Server

Accessible only after startup.

Source code in src/aria2_server/app/server/__init__.py

def get_server() -> nicegui.server.Server:
    """Accessible only after startup."""
    try:
        return nicegui.server.Server.instance
    except AttributeError:
        raise RuntimeError("Accessible only after startup.") from None