Skip to content

Commit

Permalink
Fix type hints.
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Nov 16, 2020
1 parent 8833dce commit f7302f2
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 29 deletions.
40 changes: 22 additions & 18 deletions repo_helper/files/docs.py
Expand Up @@ -31,7 +31,7 @@
import os.path
import pathlib
import shutil
from typing import Dict, List, Sequence, Set, Union
from typing import Dict, List, Sequence, Union

# 3rd party
import css_parser # type: ignore
Expand All @@ -42,9 +42,13 @@
from domdf_python_tools.paths import PathPlus
from domdf_python_tools.typing import PathLike
from domdf_python_tools.utils import enquote_value
from packaging.requirements import Requirement
from shippinglabel import normalize
from shippinglabel.requirements import RequirementsManager, combine_requirements, read_requirements
from shippinglabel.requirements import (
ComparableRequirement,
RequirementsManager,
combine_requirements,
read_requirements
)

# this package
import repo_helper
Expand Down Expand Up @@ -88,17 +92,17 @@

class DocRequirementsManager(RequirementsManager):
target_requirements = {
Requirement("sphinxcontrib-httpdomain>=1.7.0"),
Requirement("sphinxemoji>=0.1.6"),
Requirement("sphinx-notfound-page>=0.5"),
Requirement("sphinx-tabs>=1.1.13"),
Requirement("autodocsumm>=0.2.0"),
# Requirement("sphinx-gitstamp"),
# Requirement("gitpython"),
# Requirement("sphinx_autodoc_typehints>=1.11.0"),
Requirement("sphinx-copybutton>=0.2.12"),
Requirement("sphinx-prompt>=1.1.0"),
Requirement("sphinx>=3.0.3"),
ComparableRequirement("sphinxcontrib-httpdomain>=1.7.0"),
ComparableRequirement("sphinxemoji>=0.1.6"),
ComparableRequirement("sphinx-notfound-page>=0.5"),
ComparableRequirement("sphinx-tabs>=1.1.13"),
ComparableRequirement("autodocsumm>=0.2.0"),
# ComparableRequirement("sphinx-gitstamp"),
# ComparableRequirement("gitpython"),
# ComparableRequirement("sphinx_autodoc_typehints>=1.11.0"),
ComparableRequirement("sphinx-copybutton>=0.2.12"),
ComparableRequirement("sphinx-prompt>=1.1.0"),
ComparableRequirement("sphinx>=3.0.3"),
}

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

for name, specifier in theme_versions.items():
if name == self._globals["sphinx_html_theme"]:
self.target_requirements.add(Requirement(f"{name}{specifier}"))
self.target_requirements.add(ComparableRequirement(f"{name}{specifier}"))
break
else:
self.target_requirements.add(Requirement(self._globals["sphinx_html_theme"]))
self.target_requirements.add(ComparableRequirement(self._globals["sphinx_html_theme"]))

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

for name, specifier in my_sphinx_extensions.items():
if name != self._globals["pypi_name"]:
self.target_requirements.add(Requirement(f"{name}{specifier}"))
self.target_requirements.add(ComparableRequirement(f"{name}{specifier}"))

def merge_requirements(self) -> List[str]:
current_requirements, comments = read_requirements(self.req_file)
Expand All @@ -142,7 +146,7 @@ def merge_requirements(self) -> List[str]:
req.name = normalize(req.name)
if req.name not in self.get_target_requirement_names():
if req.name == "sphinx-rtd-theme" and self._globals["sphinx_html_theme"] == "domdf_sphinx_theme":
self.target_requirements.add(Requirement("domdf-sphinx-theme>=0.1.0"))
self.target_requirements.add(ComparableRequirement("domdf-sphinx-theme>=0.1.0"))
elif req.name == "sphinx-autodoc-typehints":
continue
else:
Expand Down
19 changes: 9 additions & 10 deletions repo_helper/files/testing.py
Expand Up @@ -34,9 +34,8 @@
import jinja2
from domdf_python_tools.paths import PathPlus
from domdf_python_tools.typing import PathLike
from packaging.requirements import Requirement
from shippinglabel import normalize
from shippinglabel.requirements import RequirementsManager, read_requirements
from shippinglabel.requirements import ComparableRequirement, RequirementsManager, read_requirements

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

class TestsRequirementsManager(RequirementsManager):
target_requirements = {
Requirement("coverage>=5.1"),
Requirement("pytest>=6.0.0"),
Requirement("pytest-cov>=2.8.1"),
Requirement("pytest-randomly>=3.3.1"),
Requirement("pytest-timeout>=1.4.2"), # Requirement("pytest-rerunfailures>=9.0"),
Requirement("iniconfig!=1.1.0,>=1.0.1"),
ComparableRequirement("coverage>=5.1"),
ComparableRequirement("pytest>=6.0.0"),
ComparableRequirement("pytest-cov>=2.8.1"),
ComparableRequirement("pytest-randomly>=3.3.1"),
ComparableRequirement("pytest-timeout>=1.4.2"), # ComparableRequirement("pytest-rerunfailures>=9.0"),
ComparableRequirement("iniconfig!=1.1.0,>=1.0.1"),
}

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

def compile_target_requirements(self) -> None:
if self._globals["pypi_name"] != "coverage_pyver_pragma":
self.target_requirements.add(Requirement("coverage-pyver-pragma>=0.0.6"))
self.target_requirements.add(ComparableRequirement("coverage-pyver-pragma>=0.0.6"))
if self._globals["pypi_name"] != "domdf_python_tools":
self.target_requirements.add(Requirement("domdf-python-tools[testing]>=1.5.0"))
self.target_requirements.add(ComparableRequirement("domdf-python-tools[testing]>=1.5.0"))


@management.register("test_requirements", ["enable_tests"])
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Expand Up @@ -13,7 +13,7 @@ jinja2>=2.11.2
packaging>=20.4
pre-commit>=2.7.1
ruamel-yaml>=0.16.12
shippinglabel>=0.3.2
shippinglabel>=0.4.0
southwark>=0.4.0
tomlkit>=0.7.0
typing-extensions>=3.7.4.3
Expand Down

0 comments on commit f7302f2

Please sign in to comment.