zabgrab.model.names

Validation of user-defined names and server references.

zabgrab.model.names.NAME_PATTERN

What template and server names must match.

Type:

re.Pattern

zabgrab.model.names.NAME_RULE

The rule, for error messages.

Type:

str

Name, Url, ServerRef

Annotated string types that validate a name, an HTTP(S) URL, or either.

Type:

type

Functions

frontend_url(url)	Get the web frontend's base URL.
is_url(value)	Whether value is an absolute HTTP(S) URL.
is_valid_name(name)	Whether name is allowed as a template or server name.
validate_name(name)	Check a template or server name.
validate_server_ref(value)	Check a server reference: a server's name or a URL.
validate_url(value)	Check a server URL.

zabgrab.model.names.is_valid_name(name)

Whether name is allowed as a template or server name.

Parameters:

name (str)

Return type:

bool

zabgrab.model.names.validate_name(name)

Check a template or server name.

Parameters:

name (str) – The name.

Returns:

str – name, unchanged.

Raises:

ValueError – If it isn’t a valid name.

Return type:

str

zabgrab.model.names.is_url(value)

Whether value is an absolute HTTP(S) URL.

Parameters:

value (str)

Return type:

bool

zabgrab.model.names.validate_url(value)

Check a server URL.

Parameters:

value (str) – The URL.

Returns:

str – value, unchanged.

Raises:

ValueError – If it isn’t an absolute HTTP(S) URL.

Return type:

str

zabgrab.model.names.frontend_url(url)

Get the web frontend’s base URL.

Parameters:

url (str) – The frontend URL, or its API URL (.../api_jsonrpc.php).

Returns:

str – The URL without the API script, trailing slash, query or fragment.

Return type:

str

zabgrab.model.names.validate_server_ref(value)

Check a server reference: a server’s name or a URL.

Parameters:

value (str) – The reference.

Returns:

str – value, unchanged.

Raises:

ValueError – If it’s neither a valid name nor an absolute HTTP(S) URL.

Return type:

str