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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
# SPDX-License-Identifier: Apache-2.0
# Copyright © 2022-2024 Intel Corporation
"""Type definitions for cargo manifest files."""
from __future__ import annotations
import typing as T
from typing_extensions import Literal, TypedDict, Required
EDITION = Literal['2015', '2018', '2021']
CRATE_TYPE = Literal['bin', 'lib', 'dylib', 'staticlib', 'cdylib', 'rlib', 'proc-macro']
LINT_LEVEL = Literal['allow', 'deny', 'forbid', 'warn']
class FromWorkspace(TypedDict):
"""An entry or section that is copied from the workspace."""
workspace: bool
Package = TypedDict(
'Package',
{
'name': Required[str],
'version': Required[T.Union[FromWorkspace, str]],
'authors': T.Union[FromWorkspace, T.List[str]],
'edition': T.Union[FromWorkspace, EDITION],
'rust-version': T.Union[FromWorkspace, str],
'description': T.Union[FromWorkspace, str],
'readme': T.Union[FromWorkspace, str],
'license': T.Union[FromWorkspace, str],
'license-file': T.Union[FromWorkspace, str],
'keywords': T.Union[FromWorkspace, T.List[str]],
'categories': T.Union[FromWorkspace, T.List[str]],
'homepage': T.Union[FromWorkspace, str],
'repository': T.Union[FromWorkspace, str],
'documentation': T.Union[FromWorkspace, str],
'workspace': str,
'build': str,
'links': str,
'include': T.Union[FromWorkspace, T.List[str]],
'exclude': T.Union[FromWorkspace, T.List[str]],
'publish': T.Union[FromWorkspace, bool],
'metadata': T.Dict[str, T.Dict[str, str]],
'default-run': str,
'autolib': bool,
'autobins': bool,
'autoexamples': bool,
'autotests': bool,
'autobenches': bool,
},
total=False,
)
"""A description of the Package Dictionary."""
class Badge(TypedDict):
"""An entry in the badge section."""
status: Literal['actively-developed', 'passively-developed', 'as-is', 'experimental', 'deprecated', 'none']
repository: str
Dependency = TypedDict(
'Dependency',
{
'version': str,
'registry': str,
'git': str,
'branch': str,
'rev': str,
'path': str,
'optional': bool,
'package': str,
'default-features': bool,
'features': T.List[str],
},
total=False,
)
"""An entry in the *dependencies sections."""
DependencyV = T.Union[Dependency, str]
"""A Dependency entry, either a string or a Dependency Dict."""
_BaseBuildTarget = TypedDict(
'_BaseBuildTarget',
{
'path': str,
'test': bool,
'doctest': bool,
'bench': bool,
'doc': bool,
'plugin': bool,
'proc-macro': bool,
'harness': bool,
'edition': EDITION,
'crate-type': T.List[CRATE_TYPE],
'required-features': T.List[str],
},
total=False,
)
class BuildTarget(_BaseBuildTarget, total=False):
name: Required[str]
class LibTarget(_BaseBuildTarget, total=False):
name: str
class Target(TypedDict):
"""Target entry in the Manifest File."""
dependencies: T.Dict[str, T.Union[FromWorkspace, DependencyV]]
Lint = TypedDict(
'Lint',
{
'level': Required[LINT_LEVEL],
'priority': int,
'check-cfg': T.List[str],
},
total=True,
)
"""The representation of a linter setting.
This does not include the name or tool, since those are the keys of the
dictionaries that point to Lint.
"""
LintV = T.Union[Lint, str]
"""A Lint entry, either a string or a Lint Dict."""
class Workspace(TypedDict):
"""The representation of a workspace.
In a vritual manifest the :attribute:`members` is always present, but in a
project manifest, an empty workspace may be provided, in which case the
workspace is implicitly filled in by values from the path based dependencies.
the :attribute:`exclude` is always optional
"""
members: T.List[str]
exclude: T.List[str]
package: Package
dependencies: T.Dict[str, DependencyV]
Manifest = TypedDict(
'Manifest',
{
'package': Package,
'badges': T.Dict[str, Badge],
'dependencies': T.Dict[str, T.Union[FromWorkspace, DependencyV]],
'dev-dependencies': T.Dict[str, T.Union[FromWorkspace, DependencyV]],
'build-dependencies': T.Dict[str, T.Union[FromWorkspace, DependencyV]],
'lib': LibTarget,
'bin': T.List[BuildTarget],
'test': T.List[BuildTarget],
'bench': T.List[BuildTarget],
'example': T.List[BuildTarget],
'features': T.Dict[str, T.List[str]],
'target': T.Dict[str, Target],
'workspace': Workspace,
'lints': T.Union[FromWorkspace, T.Dict[str, T.Dict[str, LintV]]],
# TODO: patch?
# TODO: replace?
},
total=False,
)
"""The Cargo Manifest format."""
class CargoLockPackage(TypedDict, total=False):
"""A description of a package in the Cargo.lock file format."""
name: str
version: str
source: str
checksum: str
class CargoLock(TypedDict, total=False):
"""A description of the Cargo.lock file format."""
version: int
package: T.List[CargoLockPackage]
metadata: T.Dict[str, str]
|
