Linting.

Author: domdfcoding

__pkginfo__.py

@@ -31,7 +31,7 @@
 repo_root = pathlib.Path(__file__).parent
 install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
 extras_require = {
-		'dates': ['pytz>=2019.1'],
-		'testing': ['pytest>=6.0.0', 'pytest-regressions>=2.0.2'],
-		'all': ['pytest-regressions>=2.0.2', 'pytest>=6.0.0', 'pytz>=2019.1']
+		"dates": ["pytz>=2019.1"],
+		"testing": ["pytest>=6.0.0", "pytest-regressions>=2.0.2"],
+		"all": ["pytest-regressions>=2.0.2", "pytest>=6.0.0", "pytz>=2019.1"]
 		}

doc-source/Source.rst

@@ -3,7 +3,7 @@ Downloading source code
 =========================
 
 The ``domdf_python_tools`` source code is available on GitHub,
-and can be accessed from the following URL: https://github.com/domdfcoding/domdf_python_tools"
+and can be accessed from the following URL: https://github.com/domdfcoding/domdf_python_tools
 
 If you have ``git`` installed, you can clone the repository with the following command:
 

doc-source/conf.py

@@ -8,7 +8,7 @@
 import sys
 
 sys.path.append(os.path.abspath('.'))
-sys.path.append(os.path.abspath('..'))
+sys.path.append(os.path.abspath(".."))
 
 # 3rd party
 import domdf_python_tools
@@ -32,69 +32,66 @@
 slug = re.sub(r'\W+', '-', project.lower())
 release = version = __version__
 copyright = "2019-2020 Dominic Davis-Foster"  # pylint: disable=redefined-builtin
-language = 'en'
+language = "en"
 package_root = "domdf_python_tools"
 
 extensions = [
-		'sphinx_toolbox',
-		'sphinx_toolbox.more_autodoc',
-		'sphinx_toolbox.more_autosummary',
-		'sphinx_toolbox.tweaks.param_dash',
-		'sphinx.ext.intersphinx',
-		'sphinx.ext.mathjax',
-		'sphinxcontrib.httpdomain',
-		'sphinxcontrib.extras_require',
-		'sphinx.ext.todo',
-		'sphinxemoji.sphinxemoji',
-		'notfound.extension',
-		'sphinx_copybutton',
-		'sphinxcontrib.default_values',
-		'sphinxcontrib.toctree_plus',
-		'seed_intersphinx_mapping',
-		'sphinx_autofixture',
+		"sphinx_toolbox",
+		"sphinx_toolbox.more_autodoc",
+		"sphinx_toolbox.more_autosummary",
+		"sphinx_toolbox.tweaks.param_dash",
+		"sphinx.ext.intersphinx",
+		"sphinx.ext.mathjax",
+		"sphinxcontrib.httpdomain",
+		"sphinxcontrib.extras_require",
+		"sphinx.ext.todo",
+		"sphinxemoji.sphinxemoji",
+		"notfound.extension",
+		"sphinx_copybutton",
+		"sphinxcontrib.default_values",
+		"sphinxcontrib.toctree_plus",
+		"seed_intersphinx_mapping",
+		"sphinx_autofixture",
 		]
 
-sphinxemoji_style = 'twemoji'
+sphinxemoji_style = "twemoji"
 todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
 gitstamp_fmt = "%d %b %Y"
 
-templates_path = ['_templates']
-html_static_path = ['_static']
-source_suffix = '.rst'
+templates_path = ["_templates"]
+html_static_path = ["_static"]
+source_suffix = ".rst"
 exclude_patterns = []
 
-master_doc = 'index'
-suppress_warnings = ['image.nonlocal_uri']
-pygments_style = 'default'
+master_doc = "index"
+suppress_warnings = ["image.nonlocal_uri"]
+pygments_style = "default"
 
 intersphinx_mapping = {
-		'python': ('https://docs.python.org/3/', None),
-		'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
-		'pandas': ('https://pandas.pydata.org/docs/', None),
-		'consolekit': ('https://consolekit.readthedocs.io/en/latest/', None),
-		'pytest': ('https://docs.pytest.org/en/stable', None),
+		"python": ("https://docs.python.org/3/", None),
+		"sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
+		"pandas": ("https://pandas.pydata.org/docs/", None),
+		"consolekit": ("https://consolekit.readthedocs.io/en/latest/", None),
+		"pytest": ("https://docs.pytest.org/en/stable", None),
 		}
 
-html_theme = 'domdf_sphinx_theme'
-html_theme_options = {
-		'logo_only': False,
-		}
+html_theme = "domdf_sphinx_theme"
+html_theme_options = {"logo_only": False}
 html_theme_path = ["../.."]
 html_show_sourcelink = True  # True will show link to source
 
 html_context = {
-		'display_github': True,
-		'github_user': 'domdfcoding',
-		'github_repo': 'domdf_python_tools',
-		'github_version': 'master',
-		'conf_py_path': '/doc-source/',
+		"display_github": True,
+		"github_user": "domdfcoding",
+		"github_repo": "domdf_python_tools",
+		"github_version": "master",
+		"conf_py_path": "/doc-source/",
 		}
-
 htmlhelp_basename = slug
 
-latex_documents = [('index', f'{slug}.tex', project, author, 'manual')]
-man_pages = [('index', slug, project, [author], 1)]
-texinfo_documents = [('index', slug, project, author, slug, project, 'Miscellaneous')]
+latex_documents = [("index", f'{slug}.tex', project, author, "manual")]
+man_pages = [("index", slug, project, [author], 1)]
+texinfo_documents = [("index", slug, project, author, slug, project, "Miscellaneous")]
 
 toctree_plus_types = {
 		"class",
@@ -138,11 +135,11 @@
 		"__hash__",
 		]
 autodoc_default_options = {
-		'members': None,  # Include all members (methods).
-		'special-members': None,
+		"members": None,  # Include all members (methods).
+		"special-members": None,
 		"autosummary": None,
 		"show-inheritance": None,
-		'exclude-members': ','.join(autodoc_exclude_members),
+		"exclude-members": ','.join(autodoc_exclude_members),
 		}
 
 manpages_url = "https://manpages.debian.org/{path}"

domdf_python_tools/dates.py

@@ -296,19 +296,25 @@ def get_timezone(tz: str, date: Optional[datetime.datetime] = None) -> Optional[
 
 	if __name__ == "__main__":
 
+		# stdlib
 		import warnings
+
+		# this package
 		from domdf_python_tools.words import word_join
 
-		warnings.warn(f"""\
+		warnings.warn(
+				f"""\
 		'{word_join(_pytz_functions)}' require pytz (https://pypi.org/project/pytz/), but it could not be imported.
 
 		The error was: {e}.
-		""")
+		"""
+				)
 
 	else:
 		_actual_module = sys.modules[__name__]
 
 		class SelfWrapper(ModuleType):
+
 			def __getattr__(self, name):
 				if name in _pytz_functions:
 					raise ImportError(

setup.py

@@ -13,7 +13,7 @@
 from __pkginfo__ import *  # pylint: disable=wildcard-import
 
 setup(
-		description='Helpful functions for Python\u2002🐍\u2002🛠️',
+		description="Helpful functions for Python 🐍 🛠️",
 		extras_require=extras_require,
 		install_requires=install_requires,
 		py_modules=[],

tests/test_dates.py

@@ -18,12 +18,11 @@
 from domdf_python_tools.dates import calc_easter
 from domdf_python_tools.testing import count
 
-
 # TODO: travis matrix to test without pytz installed
 # TODO: test get_timezone
 
-
 try:
+	# 3rd party
 	import pytz
 
 	test_date = datetime.datetime(1996, 10, 13, 2, 20).replace(tzinfo=pytz.utc)
@@ -58,7 +57,6 @@ def test_utc_offset():
 				}
 		assert dates.get_utc_offset("Africa/Algiers") == datetime.timedelta(0, 3600)
 
-
 	def test_converting_timezone():
 		# No matter what timezone we convert to the timestamp should be the same
 		for tz in pytz.all_timezones:
@@ -73,7 +71,6 @@ def test_converting_timezone():
 			if dates.get_utc_offset(tz, today):  # otherwise the timezone stayed as UTC
 				assert today.astimezone(dates.get_timezone(tz, today)).hour != today.hour
 
-
 	def test_utc_timestamp_to_datetime():
 		# Going from a datetime object to timezone and back should give us the same object
 		for tz in pytz.all_timezones:
@@ -86,7 +83,6 @@ def test_utc_timestamp_to_datetime():
 			dt = today.astimezone(tzinfo)
 			assert dates.utc_timestamp_to_datetime(dt.timestamp(), tzinfo) == dt
 
-
 	def test_set_timezone():
 		# Setting the timezone should change the timestamp
 		for tz in pytz.all_timezones:
@@ -142,20 +138,25 @@ def test_set_timezone():
 				as_seconds = dates.set_timezone(test_date, target_tz).timestamp() + offset.total_seconds()
 				assert as_seconds == test_date.timestamp()
 
-
 except ImportError:
 
 	def test_utc_offset_no_pytz():
-		with pytest.raises(ImportError, match="'get_utc_offset' requires pytz \(.*\), but it could not be imported"):
+		with pytest.raises(
+				ImportError,
+				match=r"'get_utc_offset' requires pytz \(.*\), but it could not be imported",
+				):
 			dates.get_utc_offset
 
-		with pytest.raises(ImportError, match="'get_utc_offset' requires pytz \(.*\), but it could not be imported"):
+		with pytest.raises(
+				ImportError,
+				match=r"'get_utc_offset' requires pytz \(.*\), but it could not be imported",
+				):
+			# this package
 			from domdf_python_tools.dates import get_utc_offset
 
 
 # TODO: Finish
 
-
 months = [
 		"January",
 		"February",

tox.ini

@@ -38,15 +38,17 @@ python =
 
 [gh-actions]
 python =
-    3.6: py36, build
+    3.6: py36, build, mypy
     3.7: py37, build
     3.8: py38, build
     pypy3: pypy3, build
     3.9: py39, build
     3.10-dev: py310-dev, build
 
 [testenv:docs]
-setenv = SHOW_TODOS = 1
+setenv =
+    SHOW_TODOS = 1
+    PIP_USE_FEATURE = 2020-resolver
 basepython = python3.8
 changedir = {toxinidir}/doc-source
 extras = all
@@ -129,7 +131,7 @@ commands =
 [flake8]
 max-line-length = 120
 select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 W292 E265 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 SXL001  PT001 PT002 PT003 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q001 Q002 Q003 A001 A002 A003 TYP001 TYP002 TYP003 TYP004 TYP005 TYP006 Y001,Y002 Y003 Y004 Y005 Y006 Y007 Y008 Y009 Y010 Y011 Y012 Y013 Y014 Y015 Y090 Y091 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
-exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py
+exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py,.tox,venv
 rst-directives =
     TODO
     envvar