HomeSoftware Heritage

identifiers: Rename some functions and types related to SWHIDs

Description

identifiers: Rename some functions and types related to SWHIDs

When Software Heritage persistent identifiers were introduced, they were not
yet abbreviated as SWHIDs.

Now that abbreviation is growing adoption, rename some functions and types in
swh.model.identifiers for consistency:

  • PersistentId -> SWHID
  • persistent_identifier -> swhid
  • parse_persistent_identifier -> parse_swhid

Backward compatibility with previous naming is maintained but deprecation
warnings are introduced to encourage the use of the new names.

Numerous variables in swh.model codebase have also been renamed accordingly.

Also rework and improve documentation.

Details

Provenance
anlambertAuthored on Jul 3 2020, 12:18 PM
anlambertPushed on Jul 3 2020, 4:07 PM
Differential Revision
D3412: identifiers: Rename some functions and types related to SWHIDs
Parents
rDMOD8863b5c186dd: Refactor common loader behavior within from_disk.iter_directory
Branches
Unknown
Tags
Unknown
References
tag: v0.3.8
Build Status
Buildable 13329
Build 20366: test-and-buildJenkins console · Jenkins