Skip to main content

Browse the archive

Revision 1ff05161e795a71bf823f55c7d043cf9eaaa1d01 authored by Antoine Lambert on 03 July 2020, 10:18:38 UTC, committed by Antoine Lambert on 03 July 2020, 12:11:32 UTC 
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.
1 parent 8863b5c
Raw File
.pre-commit-config.yaml 
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v2.4.0
  hooks:
  - id: trailing-whitespace
  - id: flake8
  - id: check-json
  - id: check-yaml

- repo: https://github.com/codespell-project/codespell
  rev: v1.16.0
  hooks:
  - id: codespell

- repo: local
  hooks:
  - id: mypy
    name: mypy
    entry: mypy
    args: [swh]
    pass_filenames: false
    language: system
    types: [python]

- repo: https://github.com/python/black
  rev: 19.10b0
  hooks:
  - id: black

# unfortunately, we are far from being able to enable this...
# - repo: https://github.com/PyCQA/pydocstyle.git
#   rev: 4.0.0
#   hooks:
#   - id: pydocstyle
#     name: pydocstyle
#     description: pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.
#     entry: pydocstyle --convention=google
#     language: python
#     types: [python]
back to top