Variables and Functions¶

Classes¶

FuncBase64¶

FuncBase64(name: str)

Func

Encodes the specified var in base64

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

FuncHex¶

FuncHex(name: str)

Func

Encodes the specified var in hex.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

FuncLower¶

FuncLower(name: str)

Func

Lowercase the specified var.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

FuncMath¶

FuncMath(name: str)

Func

Perform a math operation. Example: CONTENT_LENGTH+1

Supported operations: + - * /

Warning

Requires matheval support.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

FuncMime¶

FuncMime(name: str)

Func

Returns mime type of a variable.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

FuncUpper¶

FuncUpper(name: str)

Func

Uppercase the specified var.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarCookie¶

VarCookie(name: str)

Var

Returns cookie variable

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarGeoip¶

VarGeoip(name: str)

Var

Returns Geoip data.

http://uwsgi.readthedocs.io/en/latest/GeoIP.html

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

vars_city¶

.vars_city: ClassVar = [
    CONTINENT,
    COUNTRY_CODE,
    COUNTRY_CODE3,
    COUNTRY_NAME,
    REGION,
    REGION_NAME,
    CITY,
    POSTAL_CODE,
    LATITUDE,
    LONGITUDE,
    DMA,
    AREA,
]

Keys avaiable for city database.

vars_country¶

.vars_country: ClassVar = [
    COUNTRY_CODE,
    COUNTRY_CODE3,
    COUNTRY_NAME,
]

Keys avaiable for country database.

VarHttptime¶

VarHttptime(name: str)

Var

Returns http date adding the numeric argument (if specified) to the current time (use empty arg for current server time).

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarMetric¶

VarMetric(name: str)

Var

Returns metric (see monitoring) variable.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarQuery¶

VarQuery(name: str)

Var

Returns query string variable.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarRequest¶

VarRequest(name: str)

Var

Returns request variable. Examples: PATH_INFO, SCRIPT_NAME, REQUEST_METHOD.

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarTime¶

VarTime(name: str)

Var

Returns time/date in various forms.

Supported variables: * unix

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.

VarUwsgi¶

VarUwsgi(name: str)

Var

Returns internal uWSGI information.

Supported variables: * wid * pid * uuid * status

alias ¶

.alias: str = ''

Alias to address this value.

args_joiner ¶

.args_joiner: str = ' '

Symbol to join arguments with.

name ¶

.name: str = ''

Name to represent the group.

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.