Skip to content

Commit f7302f2

Browse files
committed
Fix type hints.
1 parent 8833dce commit f7302f2

File tree

3 files changed

+32
-29
lines changed

3 files changed

+32
-29
lines changed

repo_helper/files/docs.py

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import os.path
3232
import pathlib
3333
import shutil
34-
from typing import Dict, List, Sequence, Set, Union
34+
from typing import Dict, List, Sequence, Union
3535

3636
# 3rd party
3737
import css_parser # type: ignore
@@ -42,9 +42,13 @@
4242
from domdf_python_tools.paths import PathPlus
4343
from domdf_python_tools.typing import PathLike
4444
from domdf_python_tools.utils import enquote_value
45-
from packaging.requirements import Requirement
4645
from shippinglabel import normalize
47-
from shippinglabel.requirements import RequirementsManager, combine_requirements, read_requirements
46+
from shippinglabel.requirements import (
47+
ComparableRequirement,
48+
RequirementsManager,
49+
combine_requirements,
50+
read_requirements
51+
)
4852

4953
# this package
5054
import repo_helper
@@ -88,17 +92,17 @@
8892

8993
class DocRequirementsManager(RequirementsManager):
9094
target_requirements = {
91-
Requirement("sphinxcontrib-httpdomain>=1.7.0"),
92-
Requirement("sphinxemoji>=0.1.6"),
93-
Requirement("sphinx-notfound-page>=0.5"),
94-
Requirement("sphinx-tabs>=1.1.13"),
95-
Requirement("autodocsumm>=0.2.0"),
96-
# Requirement("sphinx-gitstamp"),
97-
# Requirement("gitpython"),
98-
# Requirement("sphinx_autodoc_typehints>=1.11.0"),
99-
Requirement("sphinx-copybutton>=0.2.12"),
100-
Requirement("sphinx-prompt>=1.1.0"),
101-
Requirement("sphinx>=3.0.3"),
95+
ComparableRequirement("sphinxcontrib-httpdomain>=1.7.0"),
96+
ComparableRequirement("sphinxemoji>=0.1.6"),
97+
ComparableRequirement("sphinx-notfound-page>=0.5"),
98+
ComparableRequirement("sphinx-tabs>=1.1.13"),
99+
ComparableRequirement("autodocsumm>=0.2.0"),
100+
# ComparableRequirement("sphinx-gitstamp"),
101+
# ComparableRequirement("gitpython"),
102+
# ComparableRequirement("sphinx_autodoc_typehints>=1.11.0"),
103+
ComparableRequirement("sphinx-copybutton>=0.2.12"),
104+
ComparableRequirement("sphinx-prompt>=1.1.0"),
105+
ComparableRequirement("sphinx>=3.0.3"),
102106
}
103107

104108
def __init__(self, repo_path: PathLike, templates: jinja2.Environment):
@@ -117,10 +121,10 @@ def compile_target_requirements(self) -> None:
117121

118122
for name, specifier in theme_versions.items():
119123
if name == self._globals["sphinx_html_theme"]:
120-
self.target_requirements.add(Requirement(f"{name}{specifier}"))
124+
self.target_requirements.add(ComparableRequirement(f"{name}{specifier}"))
121125
break
122126
else:
123-
self.target_requirements.add(Requirement(self._globals["sphinx_html_theme"]))
127+
self.target_requirements.add(ComparableRequirement(self._globals["sphinx_html_theme"]))
124128

125129
# Mapping of pypi_name to version specifier
126130
my_sphinx_extensions = {
@@ -133,7 +137,7 @@ def compile_target_requirements(self) -> None:
133137

134138
for name, specifier in my_sphinx_extensions.items():
135139
if name != self._globals["pypi_name"]:
136-
self.target_requirements.add(Requirement(f"{name}{specifier}"))
140+
self.target_requirements.add(ComparableRequirement(f"{name}{specifier}"))
137141

138142
def merge_requirements(self) -> List[str]:
139143
current_requirements, comments = read_requirements(self.req_file)
@@ -142,7 +146,7 @@ def merge_requirements(self) -> List[str]:
142146
req.name = normalize(req.name)
143147
if req.name not in self.get_target_requirement_names():
144148
if req.name == "sphinx-rtd-theme" and self._globals["sphinx_html_theme"] == "domdf_sphinx_theme":
145-
self.target_requirements.add(Requirement("domdf-sphinx-theme>=0.1.0"))
149+
self.target_requirements.add(ComparableRequirement("domdf-sphinx-theme>=0.1.0"))
146150
elif req.name == "sphinx-autodoc-typehints":
147151
continue
148152
else:

repo_helper/files/testing.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@
3434
import jinja2
3535
from domdf_python_tools.paths import PathPlus
3636
from domdf_python_tools.typing import PathLike
37-
from packaging.requirements import Requirement
3837
from shippinglabel import normalize
39-
from shippinglabel.requirements import RequirementsManager, read_requirements
38+
from shippinglabel.requirements import ComparableRequirement, RequirementsManager, read_requirements
4039

4140
# this package
4241
from repo_helper.configupdater2 import ConfigUpdater
@@ -595,12 +594,12 @@ def make_isort(repo_path: pathlib.Path, templates: jinja2.Environment) -> List[s
595594

596595
class TestsRequirementsManager(RequirementsManager):
597596
target_requirements = {
598-
Requirement("coverage>=5.1"),
599-
Requirement("pytest>=6.0.0"),
600-
Requirement("pytest-cov>=2.8.1"),
601-
Requirement("pytest-randomly>=3.3.1"),
602-
Requirement("pytest-timeout>=1.4.2"), # Requirement("pytest-rerunfailures>=9.0"),
603-
Requirement("iniconfig!=1.1.0,>=1.0.1"),
597+
ComparableRequirement("coverage>=5.1"),
598+
ComparableRequirement("pytest>=6.0.0"),
599+
ComparableRequirement("pytest-cov>=2.8.1"),
600+
ComparableRequirement("pytest-randomly>=3.3.1"),
601+
ComparableRequirement("pytest-timeout>=1.4.2"), # ComparableRequirement("pytest-rerunfailures>=9.0"),
602+
ComparableRequirement("iniconfig!=1.1.0,>=1.0.1"),
604603
}
605604

606605
def __init__(self, repo_path: PathLike, templates: jinja2.Environment):
@@ -610,9 +609,9 @@ def __init__(self, repo_path: PathLike, templates: jinja2.Environment):
610609

611610
def compile_target_requirements(self) -> None:
612611
if self._globals["pypi_name"] != "coverage_pyver_pragma":
613-
self.target_requirements.add(Requirement("coverage-pyver-pragma>=0.0.6"))
612+
self.target_requirements.add(ComparableRequirement("coverage-pyver-pragma>=0.0.6"))
614613
if self._globals["pypi_name"] != "domdf_python_tools":
615-
self.target_requirements.add(Requirement("domdf-python-tools[testing]>=1.5.0"))
614+
self.target_requirements.add(ComparableRequirement("domdf-python-tools[testing]>=1.5.0"))
616615

617616

618617
@management.register("test_requirements", ["enable_tests"])

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jinja2>=2.11.2
1313
packaging>=20.4
1414
pre-commit>=2.7.1
1515
ruamel-yaml>=0.16.12
16-
shippinglabel>=0.3.2
16+
shippinglabel>=0.4.0
1717
southwark>=0.4.0
1818
tomlkit>=0.7.0
1919
typing-extensions>=3.7.4.3

0 commit comments

Comments
 (0)