Extract-catalog#

Description#

Given a package name and a version plus a repository location, extract and return the Catalog object.

For use with diff, create-patch, and apply-patch commands, we have the ability to extract a catalog out of a package version.

By default, this will produce the list of files within the package itself only. To get a full, flattened catalog of all files within a package including its subpackages, specify the --recursive option.

For CLI options, run wrapp extract-catalog --help.

Python API Reference#

async wrapp.extract_catalog(
package: str,
version: str,
repo: str,
recursive: bool,
*,
context: CommandParameters = CommandParameters(debug=False, verbose=False, dry_run=False, log_file=None, hash_cache_file=None),
scheduler: SchedulerContext | None = None,
) → Catalog#

Given a package name and a version plus a repository location, extract and return the Catalog object.

Parameters:

  • package – Name of the package

  • version – Version of the package

  • repo – The URL of the repository where the package is located

  • recursive – Flag indicating whether to recursively traverse the subpackage structure, and to include all subpackages’ items

  • context – Global configuration parameters

  • scheduler – Optionally pre-constructed SchedulerContext. When calling many functions in a row make sure to pre-construct the scheduler.

Raises:

  • FailedCommand – When prerequisites not matched

  • StorageOperationError – Raised when network or file operations fail