Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

harp.config.config

Factory configuration, does nothing but can be used to instanciate a server.

class Config[source]

Bases: object

__init__(settings=None, /, applications=None)[source]
add_application(name, /, *, debug=False)[source]
add_defaults()[source]
classmethod deserialize(settings)[source]
get_application_type(name)[source]
Parameters:

name (str)

Return type:

Type[Application]

read_env(options, /)[source]

Parses sys.argv-like arguments.

Parameters:
  • args

  • files – list of filenames to load in order. Will happen after defaults env and files.

  • options (CommonServerOptions)

Returns:

argparse.Namespace

register_events(dispatcher)[source]
Parameters:

dispatcher (IAsyncEventDispatcher)

register_services(container)[source]
Parameters:

container (Container)

remove_application(name)[source]
reset()[source]
serialize()[source]
set(key, value)[source]
validate(*, allow_extraneous_settings=False, secure=False)[source]
DEFAULT_APPLICATIONS = ['http_client', 'proxy', 'dashboard', 'sqlalchemy_storage', 'telemetry', 'janitor', 'harp_apps.contrib.sentry']
property applications
property settings
get_application_class_name(name)[source]