ocrd_network.resource_manager_server module

class ocrd_network.resource_manager_server.ResourceManagerServer(host: str, port: int)[source]

Bases: FastAPI

Initializes the application.

Parameters:
  • debug – Boolean indicating if debug tracebacks should be returned on errors.

  • routes – A list of routes to serve incoming HTTP and WebSocket requests.

  • middleware – A list of middleware to run for every request. A starlette application will always automatically include two middleware classes. ServerErrorMiddleware is added as the very outermost middleware, to handle any uncaught errors occurring anywhere in the entire stack. ExceptionMiddleware is added as the very innermost middleware, to deal with handled exception cases occurring in the routing or endpoints.

  • exception_handlers – A mapping of either integer status codes, or exception class types onto callables which handle the exceptions. Exception handler callables should be of the form handler(request, exc) -> response and may be either standard functions, or async functions.

  • on_startup – A list of callables to run on application startup. Startup handler callables do not take any arguments, and may be either standard functions, or async functions.

  • on_shutdown – A list of callables to run on application shutdown. Shutdown handler callables do not take any arguments, and may be either standard functions, or async functions.

  • lifespan – A lifespan context function, which can be used to perform startup and shutdown tasks. This is a newer style that replaces the on_startup and on_shutdown handlers. Use one or the other, not both.

start()[source]
async on_startup()[source]
async on_shutdown() None[source]
add_api_routes()[source]
async home_page()[source]
async list_available_resources(executable: Any = 'ocrd-dummy', dynamic: bool = True, name: Any = None, database: Any = None, url: Any = None)[source]
async list_installed_resources(executable: Any = None)[source]
async download_resource(executable: str = 'ocrd-dummy', name: Any = None, location: Any = None, any_url: str = '', no_dynamic: bool = False, resource_type: str = 'file', path_in_archive: str = '.', allow_uninstalled: bool = True, overwrite: bool = True)[source]