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
|
#!/usr/bin/env python3
#
# __init__.py
"""
Extension to whey to support .pth files.
"""
#
# Copyright © 2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from typing import Dict, List
# 3rd party
import dom_toml
from dom_toml.parser import TOML_TYPES, AbstractConfigParser, BadConfigError
from whey import additional_files
from whey.builder import WheelBuilder
__author__: str = "Dominic Davis-Foster"
__copyright__: str = "2021 Dominic Davis-Foster"
__license__: str = "MIT License"
__version__: str = "0.0.6"
__email__: str = "dominic@davis-foster.co.uk"
__all__ = ["PthWheelBuilder", "WheyPthParser"]
class PthWheelBuilder(WheelBuilder):
"""
Builds wheel binary distributions using metadata read from ``pyproject.toml``.
This builder has added support for creating ``.pth`` files.
:param project_dir: The project to build the distribution for.
:param build_dir: The (temporary) build directory.
:default build_dir: :file:`{<project_dir>}/build/wheel`
:param out_dir: The output directory.
:default out_dir: :file:`{<project_dir>}/dist`
:param verbose: Enable verbose output.
.. autosummary-widths:: 5/16
"""
def write_pth_files(self):
"""
Write ``.pth`` files, and their associated files, into the build directory.
.. latex:clearpage::
"""
config = dom_toml.load(self.project_dir / "pyproject.toml")
if "whey-pth" not in config.get("tool", {}):
return
parsed_config = WheyPthParser().parse(config["tool"]["whey-pth"], set_defaults=True)
pth_filename = self.build_dir / parsed_config["name"]
if not pth_filename.suffix == ".pth":
pth_filename = pth_filename.with_suffix(".pth")
pth_filename.write_clean(parsed_config["pth-content"])
self.report_written(pth_filename)
self.parse_additional_files(*parsed_config["additional-wheel-files"])
call_additional_hooks = write_pth_files
class WheyPthParser(AbstractConfigParser):
"""
Parser for the ``[tool.whey-pth]`` table from ``pyproject.toml``.
.. autosummary-widths:: 1/2
"""
factories = {"additional-wheel-files": list}
def parse_name(self, config: Dict[str, TOML_TYPES]) -> str:
"""
Parse the ``name`` key, giving the desired name of the ``.pth`` file.
:param config: The unparsed TOML config for the ``[tool.whey-pth]`` table.
"""
name = config["name"]
self.assert_type(name, str, ["tool", "whey-pth", "name"])
return name
def parse_pth_content(self, config: Dict[str, TOML_TYPES]) -> str:
"""
Parse the ``pth-content`` key, giving the content of the ``.pth`` file.
:param config: The unparsed TOML config for the ``[tool.whey-pth]`` table.
"""
pth_content = config["pth-content"]
self.assert_type(pth_content, str, ["tool", "whey-pth", "pth-content"])
return pth_content
def parse_additional_wheel_files(
self,
config: Dict[str, TOML_TYPES],
) -> List[additional_files.AdditionalFilesEntry]:
"""
Parse the ``additional-wheel-files`` key.
The value is a list of `MANIFEST.in <https://packaging.python.org/guides/using-manifest-in/>`_-style
entries for additional files to include in the wheel.
:param config: The unparsed TOML config for the ``[tool.whey-pth]`` table.
"""
entries = config["additional-wheel-files"]
for idx, file in enumerate(entries):
self.assert_indexed_type(file, str, ["tool", "whey", "additional-wheel-files"], idx=idx)
parsed_additional_files = []
for entry in entries:
parsed_entry = additional_files.from_entry(entry)
if parsed_entry is not None:
parsed_additional_files.append(parsed_entry)
return parsed_additional_files
@property
def keys(self) -> List[str]:
"""
The keys to parse from the TOML file.
"""
return [
"name",
"pth-content",
"additional-wheel-files",
]
def parse(
self,
config: Dict[str, TOML_TYPES],
set_defaults: bool = False,
) -> Dict[str, TOML_TYPES]:
"""
Parse the TOML configuration.
:param config:
:param set_defaults: If :py:obj:`True`, the values in
:attr:`self.defaults <dom_toml.parser.AbstractConfigParser.defaults>`
and :attr:`self.factories <dom_toml.parser.AbstractConfigParser.factories>`
will be set as defaults for the returned mapping.
"""
if "name" not in config:
raise BadConfigError("The [tool.whey-pth.name] key is required.")
if "pth-content" not in config:
raise BadConfigError("The [tool.whey-pth.pth-content] key is required.")
parsed_config = super().parse(config, set_defaults=set_defaults)
return parsed_config
|
