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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
import os
import ast
import textwrap
import re
from typing import Dict, List, Tuple
# Assumes the presence of setuptools
from pkg_resources import (
parse_version,
parse_requirements,
Requirement,
WorkingSet,
working_set,
)
# this assumes the presence of "packaging"
from packaging.specifiers import SpecifierSet
NEW_REQ_PACKAGES = ["azure-core", "azure-mgmt-core"]
class ParsedSetup:
"""
Python version
"""
def __init__(
self,
name: str,
version: str,
python_requires: List[str],
requires: List[str],
is_new_sdk: bool,
setup_filename: str,
name_space: str,
package_data: Dict,
include_package_data: bool,
):
self.name: str = name
self.version: str = version
self.python_requires: List[str] = python_requires
self.requires: List[str] = requires
self.is_new_sdk: bool = is_new_sdk
self.setup_filename: str = setup_filename
self.namespace = name_space
self.package_data = package_data
self.include_package_data = include_package_data
self.folder = os.path.dirname(self.setup_filename)
@classmethod
def from_path(cls, parse_directory_or_file: str):
(
name,
version,
python_requires,
requires,
is_new_sdk,
setup_filename,
name_space,
package_data,
include_package_data,
) = parse_setup(parse_directory_or_file)
return cls(
name,
version,
python_requires,
requires,
is_new_sdk,
setup_filename,
name_space,
package_data,
include_package_data,
)
def read_setup_py_content(setup_filename: str) -> str:
"""
Get setup.py content, returns a string.
"""
with open(setup_filename, "r", encoding="utf-8-sig") as setup_file:
content = setup_file.read()
return content
def parse_setup(setup_filename: str) -> Tuple[str, str, List[str], List[str], bool, str]:
"""
Used to evaluate a setup.py (or a directory containing a setup.py) and return a tuple containing:
(
<package-name>,
<package_version>,
<python_requires>,
<requires>,
<boolean indicating track1 vs track2>,
<parsed setup.py location>,
<namespace>,
<package_data dict>,
<include_package_data bool>
)
"""
if not setup_filename.endswith("setup.py"):
setup_filename = os.path.join(setup_filename, "setup.py")
mock_setup = textwrap.dedent(
"""\
def setup(*args, **kwargs):
__setup_calls__.append((args, kwargs))
"""
)
parsed_mock_setup = ast.parse(mock_setup, filename=setup_filename)
content = read_setup_py_content(setup_filename)
parsed = ast.parse(content)
for index, node in enumerate(parsed.body[:]):
if (
not isinstance(node, ast.Expr)
or not isinstance(node.value, ast.Call)
or not hasattr(node.value.func, "id")
or node.value.func.id != "setup"
):
continue
parsed.body[index:index] = parsed_mock_setup.body
break
fixed = ast.fix_missing_locations(parsed)
codeobj = compile(fixed, setup_filename, "exec")
local_vars = {}
kwargs = {}
global_vars = {"__setup_calls__": []}
current_dir = os.getcwd()
working_dir = os.path.dirname(setup_filename)
os.chdir(working_dir)
try:
exec(codeobj, global_vars, local_vars)
_, kwargs = global_vars["__setup_calls__"][0]
finally:
os.chdir(current_dir)
try:
python_requires = kwargs["python_requires"]
# most do not define this, fall back to what we define as universal
except KeyError as e:
python_requires = ">=2.7"
version = kwargs["version"]
name = kwargs["name"]
name_space = name.replace("-", ".")
if "packages" in kwargs.keys():
packages = kwargs["packages"]
if packages:
name_space = packages[0]
requires = []
if "install_requires" in kwargs:
requires = kwargs["install_requires"]
package_data = None
if "package_data" in kwargs:
package_data = kwargs["package_data"]
include_package_data = None
if "include_package_data" in kwargs:
include_package_data = kwargs["include_package_data"]
is_new_sdk = name in NEW_REQ_PACKAGES or any(map(lambda x: (parse_require(x)[0] in NEW_REQ_PACKAGES), requires))
return (
name,
version,
python_requires,
requires,
is_new_sdk,
setup_filename,
name_space,
package_data,
include_package_data,
)
def get_install_requires(setup_path: str) -> List[str]:
"""
Simple helper function to just directly get the installation requirements given a python package.
"""
return ParsedSetup.from_path(setup_path).requires
def parse_require(req: str) -> Tuple[str, SpecifierSet]:
"""
Parses the incoming version specification and returns a tuple of the requirement name and specifier.
"azure-core<2.0.0,>=1.11.0" -> [azure-core, <2.0.0,>=1.11.0]
"""
req_object = Requirement.parse(req.split(";")[0].lower())
pkg_name = req_object.key
# we were not passed a full requirement. Instead we were passed a value of "readme-renderer" or another string without a version.
if not req_object.specifier:
return [pkg_name, None]
# regex details ripped from https://peps.python.org/pep-0508/
isolated_spec = re.sub(r"^([a-zA-Z0-9\-\_\.]+)(\[[a-zA-Z0-9\-\_\.\,]*\])?", "", str(req_object))
spec = SpecifierSet(isolated_spec)
return (pkg_name, spec)
def parse_requirements_file(file_location: str) -> Dict[str, str]:
"""
Takes a python requirements file and returns a dictionary representing the contents.
"""
with open(file_location, "r") as f:
reqs = f.read()
return dict((req.name, req) for req in parse_requirements(reqs))
def get_name_from_specifier(version: str) -> str:
"""
Given a specifier string of format of <package-name><comparison><versionNumber>, returns the package name.
"azure-core<2.0.0,>=1.11.0" -> azure-core
"""
return re.split(r"[><=]", version)[0]
|
