swh.loader.package.npm.loader module

class swh.loader.package.npm.loader.NpmPackageInfo(url: str, filename: Optional[str], raw_info: Dict[str, Any], date: Optional[str], shasum: str, version: str, *, directory_extrinsic_metadata: List[swh.loader.package.loader.RawExtrinsicMetadataCore] = [])

Bases: swh.loader.package.loader.BasePackageInfo

Method generated by attrs for class NpmPackageInfo.

shasum

sha1 checksum

classmethod from_metadata(project_metadata: Dict[str, Any], version: str) → swh.loader.package.npm.loader.NpmPackageInfo

extid() → Tuple[str, bytes]

Returns a unique intrinsic identifier of this package info, or None if this package info is not ‘deduplicatable’ (meaning that we will always load it, instead of checking the ExtID storage to see if we already did)

class swh.loader.package.npm.loader.NpmLoader(storage: swh.storage.interface.StorageInterface, url: str, max_content_size: Optional[int] = None)

Bases: swh.loader.package.loader.PackageLoader[swh.loader.package.npm.loader.NpmPackageInfo]

Load npm origin’s artifact releases into swh archive.

Constructor

Args

str: origin url (e.g. https://www.npmjs.com/package/<package-name>)

visit_type: Optional[str] = 'npm'

info() → Dict

Return the project metadata information (fetched from npm registry)

get_versions() → Sequence[str]

Return the list of all published package versions.

Raises

class – swh.loader.exception.NotFound error when failing to read the published package versions.

Returns

Sequence of published versions

get_default_version() → str

Retrieve the latest release version if any.

Returns

Latest version

get_metadata_authority()

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

get_package_info(version: str) → Iterator[Tuple[str, swh.loader.package.npm.loader.NpmPackageInfo]]

Given a release version of a package, retrieve the associated

package information for such version.

Parameters

version – Package version

Returns

(branch name, package metadata)

build_revision(p_info: swh.loader.package.npm.loader.NpmPackageInfo, uncompressed_path: str, directory: bytes) → Optional[swh.model.model.Revision]

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

Parameters

• p_info – Package information

• uncompressed_path – Artifact uncompressed path on disk

Returns

Revision object

visit_date: datetime.datetime

origin: Optional[Origin]

origin_metadata: Dict[str, Any]

loaded_snapshot_id: Optional[Sha1Git]

swh.loader.package.npm.loader.extract_npm_package_author(package_json: Dict[str, Any]) → swh.model.model.Person

Extract package author from a package.json file content and return it in swh format.

Parameters

package_json – Dict holding the content of parsed package.json file

Returns

Person

swh.loader.package.npm.loader.load_json(json_bytes)

Try to load JSON from bytes and return a dictionary.

First try to decode from utf-8. If the decoding failed, try to detect the encoding and decode again with replace error handling.

If JSON is malformed, an empty dictionary will be returned.

Parameters

json_bytes (bytes) – binary content of a JSON file

Returns

JSON data loaded in a dictionary

Return type

dict

swh.loader.package.npm.loader.extract_intrinsic_metadata(dir_path: str) → Dict

Given an uncompressed path holding the pkginfo file, returns a

pkginfo parsed structure as a dict.

The release artifact contains at their root one folder. For example: $ tar tvf zprint-0.0.6.tar.gz drwxr-xr-x root/root 0 2018-08-22 11:01 zprint-0.0.6/ …

Parameters

dir_path (str) – Path to the uncompressed directory representing a release artifact from npm.

Returns

the pkginfo parsed structure as a dict if any or None if none was present.