DownloadPlan#

class scikitplot.corpus.DownloadPlan(index, input_url, url_kind, downloader, output_path, timeout, max_bytes, verify_ssl, block_private_ips, max_redirects, youtube_mode=None, youtube_language=None, youtube_include_auto=None, github_token_configured=False, headers_configured=False, max_retries=None, retry_backoff=None)[source]#

Side-effect-free dispatch plan for one URL.

The plan contains only non-secret policy/provenance data. It does not resolve DNS, probe content type, allocate a temporary directory, import a remote SDK, or contact the network. Credential/header presence is visible without serializing their contents.

Parameters:
  • index (int)

  • input_url (str)

  • url_kind (str)

  • downloader (str)

  • output_path (str | None)

  • timeout (float)

  • max_bytes (int)

  • verify_ssl (bool)

  • block_private_ips (bool)

  • max_redirects (int)

  • youtube_mode (str | None)

  • youtube_language (str | None)

  • youtube_include_auto (bool | None)

  • github_token_configured (bool)

  • headers_configured (bool)

  • max_retries (int | None)

  • retry_backoff (float | None)

block_private_ips: bool[source]#
downloader: str[source]#
github_token_configured: bool = False#
headers_configured: bool = False#
index: int[source]#
input_url: str[source]#
max_bytes: int[source]#
max_redirects: int[source]#
max_retries: int | None = None#
output_path: str | None[source]#
retry_backoff: float | None = None#
timeout: float[source]#
to_dict()[source]#

Return a JSON-compatible representation without secret values.

Return type:

dict[str, object]

url_kind: str[source]#
verify_ssl: bool[source]#
youtube_include_auto: bool | None = None#
youtube_language: str | None = None#
youtube_mode: str | None = None#