swh.loader.package.puppet.loader module

class swh.loader.package.puppet.loader.PuppetPackageInfo(url: str, name: str, filename: str, version: str, last_modified: datetime, sha256_checksum: str, *, directory_extrinsic_metadata: List[RawExtrinsicMetadataCore] = [], checksums: Dict[str, str] = {})

Bases: BasePackageInfo

Method generated by attrs for class PuppetPackageInfo.

name

Name of the package

filename

Archive (tar.gz) file name

version

Current version

last_modified

Module last update date as release date

EXTID_TYPE: str = 'puppet-module-sha256'

MANIFEST_FORMAT: Template | None = <string.Template object>

If not None, used by the default extid() implementation to format a manifest, before hashing it to produce an ExtID.

classmethod from_metadata(url: str, module_name: str, filename: str, version: str, last_modified: datetime, extrinsic_metadata: Dict[str, Any]) → PuppetPackageInfo

swh.loader.package.puppet.loader.extract_intrinsic_metadata(dir_path: Path) → Dict[str, Any]

Extract intrinsic metadata from metadata.json file at dir_path.

Each Puppet module version has a metadata.json file at the root of the archive.

See https://puppet.com/docs/puppet/7/modules_metadata.html for metadata specifications.

Parameters:

dir_path – A directory on disk where a puppet package was unpacked

Returns:

A dict mapping from json parser

class swh.loader.package.puppet.loader.PuppetLoader(storage: StorageInterface, url: str, artifacts: List[Dict[str, Any]], **kwargs)

Bases: PackageLoader[PuppetPackageInfo]

Loader’s constructor. This raises exception if the minimal required

configuration is missing (cf. fn:check method).

Parameters:

• storage – Storage instance

• url – Origin url to load data from

visit_type: str = 'puppet'

FORGEAPI_BASE_URL = 'https://forgeapi.puppet.com'

METADATA_URL = 'https://forgeapi.puppet.com/v3/releases?module={module}'

extrinsic_metadata() → Dict

Return the project metadata information (fetched from Puppet forge API)

get_metadata_authority()

For package loaders that get extrinsic metadata, returns the authority the metadata are coming from.

get_versions() → Sequence[str]

Get all released versions of a Puppet module

Returns:

A sequence of versions

Example:

["0.1.1", "0.10.2"]

get_package_info(version: str) → Iterator[Tuple[str, PuppetPackageInfo]]

Get release name and package information from version

Parameters:

version – Package version (e.g: “0.1.0”)

Returns:

Iterator of tuple (release_name, p_info)

build_release(p_info: PuppetPackageInfo, uncompressed_path: str, directory: bytes) → Release | None

Build the release from the archive metadata (extrinsic artifact metadata) and the intrinsic metadata.

Parameters:

• p_info – Package information

• uncompressed_path – Artifact uncompressed path on disk