forked from openedx/tutor-contrib-aspects
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
181 lines (152 loc) · 6.73 KB
/
setup.py
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
"""Package metadata for tutor-contrib-aspects."""
import io
import os
import re
from setuptools import find_packages, setup
HERE = os.path.abspath(os.path.dirname(__file__))
class MultipleConstraintException(BaseException):
"""
Exception raised when multiple constraints are provided.
"""
def load_requirements(*requirements_paths):
"""
Load all requirements from the specified requirements files.
Requirements will include any constraints from files specified
with -c in the requirements files.
Returns a list of requirement strings.
"""
# Removed the automated comment that was because it fails linting
# similarly had to update other code below for lint fails.
# e.g. {"django": "Django", "confluent-kafka": "confluent_kafka[avro]"}
by_canonical_name = {}
def check_name_consistent(package):
"""
Raise exception if package is named different ways.
This ensures that packages are named consistently so we can match
constraints to packages. It also ensures that if we require a package
with extras we don't constrain it without mentioning the extras (since
that too would interfere with matching constraints.)
"""
canonical = package.lower().replace("_", "-").split("[")[0]
seen_spelling = by_canonical_name.get(canonical)
if seen_spelling is None:
by_canonical_name[canonical] = package
elif seen_spelling != package:
raise Exception( # pylint: disable=broad-exception-raised
f'Encountered both "{seen_spelling}" and "{package}" in requirements '
"and constraints files; please use just one or the other."
)
requirements = {}
constraint_files = set()
# groups "pkg<=x.y.z,..." into ("pkg", "<=x.y.z,...")
re_package_name_base_chars = r"a-zA-Z0-9\-_." # chars allowed in base package name
# Two groups: name[maybe,extras], and optionally a constraint
requirement_line_regex = re.compile(
r"([%s]+(?:\[[%s,\s]+\])?)([<>=][^#\s]+)?" # pylint: disable=consider-using-f-string
% (re_package_name_base_chars, re_package_name_base_chars)
)
def add_version_constraint_or_raise(
current_line, current_requirements, add_if_not_present
):
regex_match = requirement_line_regex.match(current_line)
if regex_match:
package = regex_match.group(1)
version_constraints = regex_match.group(2)
check_name_consistent(package)
existing_version_constraints = current_requirements.get(package, None)
# It's fine to add constraints to an unconstrained package,
# but raise an error if there are already constraints in place.
if (
existing_version_constraints
and existing_version_constraints != version_constraints
):
raise MultipleConstraintException(
f"Multiple constraint definitions found for {package}:"
f' "{existing_version_constraints}" and "{version_constraints}".'
f"Combine constraints into one location with {package}"
f"{existing_version_constraints},{version_constraints}."
)
if add_if_not_present or package in current_requirements:
current_requirements[package] = version_constraints
# Read requirements from .in files and store the path to any
# constraint files that are pulled in.
for path in requirements_paths:
with open(path, encoding="utf8") as reqs:
for line in reqs:
if is_requirement(line):
add_version_constraint_or_raise(line, requirements, True)
if line and line.startswith("-c") and not line.startswith("-c http"):
constraint_files.add(
os.path.dirname(path)
+ "/"
+ line.split("#")[0].replace("-c", "").strip()
)
# process constraint files: add constraints to existing requirements
for constraint_file in constraint_files:
with open(constraint_file, encoding="utf8") as reader:
for line in reader:
if is_requirement(line):
add_version_constraint_or_raise(line, requirements, False)
# process back into list of pkg><=constraints strings
constrained_requirements = [
f'{pkg}{version or ""}' for (pkg, version) in sorted(requirements.items())
]
return constrained_requirements
def is_requirement(line):
"""
Return True if the requirement line is a package requirement.
Returns:
bool: True if the line is not blank, a comment,
a URL, or an included file
"""
# Removed the automated comment that was because it fails linting
# similarly had to update other code below for lint fails.
return (
line and line.strip() and not line.startswith(("-r", "#", "-e", "git+", "-c"))
)
def load_readme():
"""Load README file which populates long_description field."""
with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as file:
return file.read()
def load_about():
"""Load about file which stores the package version."""
about = {}
with io.open(
os.path.join(HERE, "tutoraspects", "__about__.py"),
"rt",
encoding="utf-8",
) as file:
exec(file.read(), about) # pylint: disable=exec-used
return about
ABOUT = load_about()
setup(
name="tutor-contrib-aspects",
version=ABOUT["__version__"],
url="https://github.com/openedx/tutor-contrib-aspects",
project_urls={
"Code": "https://github.com/openedx/tutor-contrib-aspects",
"Issue tracker": "https://github.com/openedx/tutor-contrib-aspects/issues",
},
license="Apache 2.0",
author="The Open edX Community",
description="Aspects plugin for Tutor",
long_description_content_type="text/x-rst",
long_description=load_readme(),
packages=find_packages(exclude=["tests*"]),
include_package_data=True,
python_requires=">=3.7",
install_requires=load_requirements("requirements/base.in"),
entry_points={"tutor.plugin.v1": ["aspects = tutoraspects.plugin"]},
classifiers=[
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
],
)