Actions¶

Classes¶

ActionAddVarCgi¶

ActionAddVarCgi(name, val)

RouteAction

Add the specified CGI (environment) variable to the request.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionAddVarLog¶

ActionAddVarLog(name, val)

RouteAction

Add the specified logvar.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionAlarm¶

ActionAlarm(name, message)

RouteAction

Triggers an alarm.

http://uwsgi.readthedocs.io/en/latest/Changelog-1.9.6.html#the-alarm-routing-action

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionAuthBasic¶

ActionAuthBasic(
    realm, 
    user=None, 
    password=None, 
    do_next=False
)

RouteAction

Use Basic HTTP Auth.

alias ¶

.alias: str = ''

Alias to address this value.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionChunked¶

1	`ActionChunked()`

RouteAction

Encodes the output in HTTP chunked.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionDirChange¶

ActionDirChange(dir)

RouteAction

Changes a directory.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionDoBreak¶

ActionDoBreak(code, return_body=False)

RouteAction

Stop scanning the internal routing table and close the request.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionDoContinue¶

1	`ActionDoContinue()`

RouteAction

Stop scanning the internal routing table and continue to the selected request handler.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionDoGoto¶

ActionDoGoto(where)

RouteAction

Make a forward jump to the specified label or rule position.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionFixContentLen¶

ActionFixContentLen(add_header=False)

RouteAction

Fixes Content-length header.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionFixVarPathInfo¶

1	`ActionFixVarPathInfo()`

RouteAction

Fixes PATH_INFO taking into account script name.

This action allows you to set SCRIPT_NAME in nginx without bothering to rewrite the PATH_INFO (something nginx cannot afford).

http://uwsgi.readthedocs.io/en/latest/Changelog-2.0.11.html#fixpathinfo-routing-action

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionFlush¶

1	`ActionFlush()`

RouteAction

Send the current contents of the transformation buffer to the client (without clearing the buffer).

http://uwsgi.readthedocs.io/en/latest/Transformations.html#flushing-magic

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionGzip¶

1	`ActionGzip()`

RouteAction

Encodes the response buffer to gzip.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionHeaderAdd¶

ActionHeaderAdd(name, val)

RouteAction

Add the specified HTTP header to the response.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionHeaderRemove¶

ActionHeaderRemove(name)

RouteAction

Remove the specified HTTP header from the response.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionHeadersOff¶

1	`ActionHeadersOff()`

RouteAction

Disable headers.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionHeadersReset¶

ActionHeadersReset(code)

RouteAction

Clear the response headers, setting a new HTTP status code, useful for resetting a response.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionLog¶

ActionLog(message)

RouteAction

Print the specified message in the logs or do not log a request is message is None.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionOffloadOff¶

1	`ActionOffloadOff()`

RouteAction

Do not use offloading.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionRedirect¶

ActionRedirect(url, permanent=False)

RouteAction

Return a HTTP 301/302 Redirect to the specified URL.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionRewrite¶

ActionRewrite(rule, do_continue=False)

RouteAction

A rewriting engine inspired by Apache mod_rewrite.

Rebuild PATH_INFO and QUERY_STRING according to the specified rules before the request is dispatched to the request handler.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionRouteExternal¶

ActionRouteExternal(address, host_header=None)

RouteAction

Route the request to an external HTTP server.

alias ¶

.alias: str = ''

Alias to address this value.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionRouteUwsgi¶

ActionRouteUwsgi(external_address='', modifier='', app='')

RouteAction

Rewrite the modifier1, modifier2 and optionally UWSGI_APPID values of a request or route the request to an external uwsgi server.

alias ¶

.alias: str = ''

Alias to address this value.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionSend¶

ActionSend(data, crnl: bool = False)

RouteAction

Extremely advanced (and dangerous) function allowing you to add raw data to the response.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionServeStatic¶

ActionServeStatic(fpath: Strpath)

RouteAction

Serve a static file from the specified physical path.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionSetHarakiri¶

ActionSetHarakiri(timeout)

RouteAction

Set harakiri timeout for the current request.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetScriptFile¶

ActionSetScriptFile(fpath: Strpath)

RouteAction

Set script file.

http://uwsgi.readthedocs.io/en/latest/Changelog-1.9.6.html#configuring-dynamic-apps-with-internal-routing

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetUwsgiProcessName¶

ActionSetUwsgiProcessName(name)

RouteAction

Set uWSGI process name.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarDocumentRoot¶

ActionSetVarDocumentRoot(value)

RouteAction

Set DOCUMENT_ROOT

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarPathInfo¶

ActionSetVarPathInfo(value)

RouteAction

Set PATH_INFO

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarRemoteAddr¶

ActionSetVarRemoteAddr(value)

RouteAction

Set REMOTE_ADDR

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarRemoteUser¶

ActionSetVarRemoteUser(user)

RouteAction

Set REMOTE_USER

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarRequestMethod¶

ActionSetVarRequestMethod(name)

RouteAction

Set REQUEST_METHOD

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarRequestUri¶

ActionSetVarRequestUri(value)

RouteAction

Set REQUEST_URI

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarScriptName¶

ActionSetVarScriptName(name)

RouteAction

Set SCRIPT_NAME

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarUwsgiAppid¶

ActionSetVarUwsgiAppid(app)

RouteAction

Set UWSGI_APPID.

Bypass SCRIPT_NAME and VirtualHosting to let the user choose the mountpoint without limitations (or headaches).

The concept is very generic: UWSGI_APPID is the identifier of an application. If it is not found in the internal list of apps, it will be loaded.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarUwsgiHome¶

ActionSetVarUwsgiHome(dir)

RouteAction

Set UWSGI_HOME

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSetVarUwsgiScheme¶

ActionSetVarUwsgiScheme(value)

RouteAction

Set UWSGI_SCHEME.

Set the URL scheme when it cannot be reliably determined. This may be used to force HTTPS (with the value https), for instance.

http://uwsgi.readthedocs.io/en/latest/Changelog-1.9.6.html#configuring-dynamic-apps-with-internal-routing

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionSignal¶

ActionSignal(num)

RouteAction

Raise the specified uwsgi signal.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionTemplate¶

1	`ActionTemplate()`

RouteAction

Allows using a template file to expose everything from internal routing system into it.

http://uwsgi.readthedocs.io/en/latest/Changelog-1.9.19.html#the-template-transformation

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

plugin ¶

.plugin: bool | str = False

Indication this option group belongs to a plugin.

ActionToFile¶

ActionToFile(filename, mode=None)

RouteAction

Used for caching a response buffer into a static file.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

ActionUpper¶

1	`ActionUpper()`

RouteAction

Transforms each character in uppercase.

Mainly as an example of transformation plugin.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.

AuthLdap¶

AuthLdap(
    realm, 
    address, 
    base_dn=None, 
    bind_dn=None, 
    bind_password=None, 
    filter=None, 
    login_attr=None, 
    log_level=None, 
    do_next=False
)

RouteAction

Use Basic HTTP Auth.

alias ¶

.alias: str = ''

Alias to address this value.

name_separator ¶

.name_separator: str = ':'

Separator to add after name portion.

name_separator_strip ¶

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.

opt_key ¶

.opt_key: str | None = None

Allows swapping default option key with custom value.