Convenience methods#

Convenience methods for rconf.

rconf.build_loader(*handlers, fallback=None, mime_types=None, opener=None, decoder=None)#

Parameters:

handlers (type[BaseHandler | UrlHandler] | BaseHandler | UrlHandler) – rconf.decode.BaseHandler s and urllib.request.UrlHandler s to choose from.
fallback (type[BaseHandler] | BaseHandler | str | None) – The fallback rconf.decode.BaseHandler. If missing, rconf.decode.JSONHandler will be the fallback handler.
mime_types (MimeTypes | None) – mimetypes.MimeTypes object used to guess a configuration’s media type from a URL.
opener (OpenerDirector | None) – The urllib.request.OpenerDirector. Overrides handlers.
decoder (DecoderDirector | None) – The rconf.decode.DecoderDirector. Overrides handlers.

Return type:

Loader

rconf.install_loader(loader)#

Install a default rconf.Loader.

This loader is used by

rconf.load(fp, media_type=None, url=None, *, ptr=None, **kwargs)#

Decode a read-supporting binary file with references and patches.

This uses the default rconf.Loader.

Parameters:

fp (BinaryIO) – read-supporting binary file.
media_type (str | None) – Assumed media type, overrides URL-derived media type. It can also be a filename extension.
url (str | pathlib.Path | None) – Assumed document URL or path for media type, fragment and relative reference resolution.
ptr (str | None) – Fragment pointer, overrides URL fragment.
kwargs – Forwarded to rconf.decode.DecoderDirector.

Raises:

Return type:

Value

rconf.loads(s, media_type=None, url=None, *, ptr=None, **kwargs)#

Decode a str configuration document with references and patches.

This uses the default rconf.Loader.

Parameters:

s (str) – Configuration document.
media_type (str | None) – Assumed media type, overrides URL-derived media type. It can also be a filename extension.
url (str | pathlib.Path | None) – Assumed document URL or path for media type, fragment and relative reference resolution.
ptr (str | None) – Fragment pointer, overrides URL fragment.
kwargs – Forwarded to rconf.decode.DecoderDirector.

Raises:

Return type:

Value

rconf.loadc(config, media_type=None, url=None, *, ptr=None, **kwargs)#

Decode a configuration document with references and patches.

This uses the default rconf.Loader.

Parameters:

config (Value) – Configuration rconf.Value.
media_type (str | None) – Assumed media type, overrides URL-derived media type. It can also be a filename extension.
url (str | pathlib.Path | None) – Assumed document URL or path for media type, fragment and relative reference resolution.
ptr (str | None) – Fragment pointer, overrides URL fragment.
kwargs – Forwarded to rconf.decode.DecoderDirector.

Raises:

Return type:

Value

rconf.loadu(url, media_type=None, *, base_url=None, ptr=None, **kwargs)#

Decode a configuration document at a URL or path with references and patches.

This uses the default rconf.Loader.

Parameters:

url (str | pathlib.Path) – Document URL or path, optionally with a language-specific pointer as URL fragment.
media_type (str | None) – Assumed media type, overrides URL-derived media type and content-type from urllib.request.OpenerDirector.open(). It can also be a filename extension.
base_url (str | pathlib.Path | None) – Assumed document URL or path for relative reference resolution, overrides URL base.
ptr (str | None) – Fragment pointer, overrides URL fragment.
kwargs – Forwarded to rconf.decode.DecoderDirector.

Raises:

Return type:

Value