ensure_yaml

ensure_yaml(key: str, *subkeys: str, url: str, name: str | None = None, force: bool = False, download_kwargs: DownloadKwargs | None = None, open_kwargs: Mapping[str, Any] | None = None, yaml_load_kwargs: Mapping[str, Any] | None = None) → Any[source]

Download YAML and open with yaml.

Parameters:

  • key – The module name

  • subkeys – A sequence of additional strings to join. If none are given, returns the directory for this module.

  • url – The URL to download.

  • name – Overrides the name of the file at the end of the URL, if given. Also useful for URLs that don’t have proper filenames with extensions.

  • force – Should the download be done again, even if the path already exists? Defaults to false.

  • download_kwargs – Keyword arguments to pass through to pystow.utils.download().

  • open_kwargs – Additional keyword arguments passed to open()

  • yaml_load_kwargs – Keyword arguments to pass through to yaml.safe_load().

Returns:

A JSON object (list, dict, etc.)