1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
Lock Files
==========
.. currentmodule:: packaging.pylock
Parse and validate `pylock.toml files <https://packaging.python.org/en/latest/specifications/pylock-toml/>`_.
Usage
-----
.. code-block:: python
import tomllib
from pathlib import Path
from packaging.pylock import Package, PackageWheel, Pylock
from packaging.utils import NormalizedName
from packaging.version import Version
# validate a pylock file name
assert is_valid_pylock_path(Path("pylock.example.toml"))
# parse and validate pylock file
toml_dict = tomllib.loads(Path("pylock.toml").read_text(encoding="utf-8"))
pylock = PyLock.from_dict(toml_dict)
# the resulting pylock object is validated against the specification,
# else a PylockValidationError is raised
# generate a pylock file
pylock = Pylock(
lock_version=Version("1.0"),
created_by="some_tool",
packages=[
Package(
name=NormalizedName("example-package"),
version=Version("1.0.0"),
wheels=[
PackageWheel(
url="https://example.com/example_package-1.0.0-py3-none-any.whl",
hashes={"sha256": "0fd.."},
)
],
)
],
)
toml_dict = pylock.to_dict()
# use a third-party library to serialize to TOML
# you can validate a manually constructed Pylock class
pylock.validate()
Reference
---------
.. autofunction:: is_valid_pylock_path
The following frozen keyword-only dataclasses are used to represent the
structure of a pylock file. The attributes correspond to the fields in the
pylock file specification.
.. autoclass:: Pylock
:members: from_dict, to_dict, validate
:exclude-members: __init__, __new__
.. class:: Package
.. class:: PackageWheel
.. class:: PackageSdist
.. class:: PackageArchive
.. class:: PackageVcs
.. class:: PackageDirectory
The following exception may be raised by this module:
.. autoexception:: PylockValidationError
:exclude-members: __init__, __new__
.. autoexception:: PylockUnsupportedVersionError
:exclude-members: __init__, __new__
|
