swh.storage.api.server module

swh.storage.api.server.get_storage()[source]
class swh.storage.api.server.StorageServerApp(*args, backend_class=None, backend_factory=None, **kwargs)[source]

Bases: swh.core.api.RPCServerApp

extra_type_decoders: Dict[str, Callable] = {'model': <function <lambda>>, 'model_enum': <function _decode_model_enum>, 'storage_enum': <function _decode_storage_enum>, 'swhid': <function parse_swhid>}
extra_type_encoders: List[Tuple[type, str, Callable]] = [(<class 'swh.model.model.BaseModel'>, 'model', <function _encode_model_object>), (<class 'swh.model.identifiers.SWHID'>, 'swhid', <class 'str'>), (<enum 'MetadataTargetType'>, 'model_enum', <function _encode_enum>), (<enum 'MetadataAuthorityType'>, 'model_enum', <function _encode_enum>), (<enum 'ListOrder'>, 'storage_enum', <function _encode_enum>)]
swh.storage.api.server.argument_error_handler(exception)[source]
swh.storage.api.server.my_error_handler(exception)[source]
swh.storage.api.server.index()[source]
swh.storage.api.server.stat_counters()[source]
swh.storage.api.server.refresh_stat_counters()[source]
swh.storage.api.server.load_and_check_config(config_file, type='local')[source]
Check the minimal configuration is set to run the api or raise an

error explanation.

Parameters
  • config_file (str) – Path to the configuration file to load

  • type (str) – configuration type. For ‘local’ type, more checks are done.

Raises

Error if the setup is not as expected

Returns

configuration as a dict

swh.storage.api.server.make_app_from_configfile()[source]

Run the WSGI app from the webserver, loading the configuration from a configuration file.

SWH_CONFIG_FILENAME environment variable defines the configuration path to load.