Improve docs layout, and add example to itertools.count

Author: domdfcoding

doc-source/api/count_demo.py

@@ -0,0 +1,12 @@
+# stdlib
+import itertools
+
+# this package
+import domdf_python_tools.iterative
+
+print(domdf_python_tools.iterative.count(14.5, 0.1))
+
+for val in zip(domdf_python_tools.iterative.count(14.5, 0.1), itertools.count(14.5, 0.1)):
+	print(val)
+	print(val[0] % 0.1, val[1] % 0.1)
+	input(">>>")

doc-source/api/utils.rst

@@ -2,7 +2,7 @@
 :mod:`~domdf_python_tools.utils`
 =================================
 
-.. autosummary-widths:: 7/16
+.. autosummary-widths:: 1/2
 	:html: 35/100
 
 .. automodule:: domdf_python_tools.utils

doc-source/latex_unicode.py

@@ -258,7 +258,6 @@ def run(self) -> List[Node]:
 		return nodes
 
 
-
 class AutoUnitDirective(SphinxDirective):
 	required_arguments = 1
 

doc-source/requirements.txt

@@ -1,6 +1,6 @@
 git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental.git
 autodocsumm>=0.2.0
-default-values>=0.4.2
+default-values>=0.5.0
 domdf-sphinx-theme>=0.3.0
 extras-require>=0.2.0
 pandas>=1.1.2
@@ -17,7 +17,7 @@ sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=2.10.0
+sphinx-toolbox>=2.13.0b3
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
-toctree-plus>=0.1.0
+toctree-plus>=0.5.0

domdf_python_tools/iterative.py

@@ -447,7 +447,12 @@ def count(start: AnyNum = 0, step: AnyNum = 1) -> Iterator[AnyNum]:
 
 		:func:`itertools.count`.
 
-		The difference is that this returns more exact floats, whereas the values from :func:`itertools.count` drift.
+		The difference is that this returns more exact floats,
+		whereas the values from :func:`itertools.count` drift.
+
+		.. only:: html
+
+			A demonstration of the drift can be seen in this file: :download:`count_demo.py`.
 
 	.. latex:clearpage::
 	"""

domdf_python_tools/paths.py

@@ -150,11 +150,13 @@ def copytree(
 	"""
 	Alternative to :func:`shutil.copytree` to support copying to a directory that already exists.
 
-	Based on https://stackoverflow.com/a/12514470/3092681 by https://stackoverflow.com/users/23252/atzz
+	Based on https://stackoverflow.com/a/12514470 by https://stackoverflow.com/users/23252/atzz
 
 	In Python 3.8 and above :func:`shutil.copytree` takes a ``dirs_exist_ok`` argument,
 	which has the same result.
 
+	.. latex:clearpage::
+
 	:param src: Source file to copy
 	:param dst: Destination to copy file to
 	:param symlinks: Whether to represent symbolic links in the source as symbolic

domdf_python_tools/secrets.py

@@ -52,7 +52,9 @@ class Secret(str):
 		True
 
 	.. versionadded:: 0.4.6
+
 	.. autosummary-widths:: 1/2
+		:html: 2/10
 	"""
 
 	__slots__ = ("value", )

tests/test_dates.py

@@ -13,11 +13,10 @@
 
 # 3rd party
 import pytest
-from coincidence import count
+from coincidence.params import count
 
 # this package
 from domdf_python_tools import dates
-from domdf_python_tools.dates import calc_easter, month_full_names
 
 # TODO: test get_timezone
 
@@ -159,25 +158,68 @@ def test_utc_offset_no_pytz():
 
 # TODO: Finish
 
+# import sys
+# from importlib.abc import MetaPathFinder
+#
+# class NoPytzPath(MetaPathFinder):
+#
+# 	def find_spec(self, fullname, path, target=None):
+# 		if fullname == "pytz":
+# 			raise ModuleNotFoundError(f"No module named '{fullname}'")
+#
+#
+# class TestDatesNoPytz:
+#
+# 	def test_import_pytz(self, fake_no_pytz):
+# 		with pytest.raises(ImportError):
+# 			import pytz
+# 		# this package
+# 		from domdf_python_tools import dates
+#
+# 		with pytest.raises(ImportError):
+# 			# 3rd party
+# 			import pytz
+#
+# 	def test_utc_offset_no_pytz(self, fake_no_pytz):
+# 		# this package
+# 		from domdf_python_tools import dates
+#
+# 		print(sys.modules.keys())
+#
+# 		with pytest.raises(
+# 				ImportError,
+# 				match=r"'get_utc_offset' requires pytz \(.*\), but it could not be imported",
+# 				):
+# 			dates.get_utc_offset  # pylint: disable=pointless-statement
+#
+# 		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  # noqa: F401
+
+
+@pytest.mark.parametrize("month_idx, month", enumerate(dates.month_full_names))
+def test_parse_month(month_idx: int, month: str):
+	month_idx += 1  # to make 1-indexed
 
-def test_parse_month():
-	for month_idx, month in enumerate(month_full_names):
-
-		month_idx += 1  # to make 1-indexed
+	for i in range(3, len(month)):
+		assert dates.parse_month(month.lower()[:i]) == month
+		assert dates.parse_month(month.upper()[:i]) == month
+		assert dates.parse_month(month.capitalize()[:i]) == month
 
-		for i in range(3, len(month)):
-			assert dates.parse_month(month.lower()[:i]) == month
-			assert dates.parse_month(month.upper()[:i]) == month
-			assert dates.parse_month(month.capitalize()[:i]) == month
+	assert dates.parse_month(month_idx) == month
 
-		assert dates.parse_month(month_idx) == month
 
+def test_parse_month_errors():
 	for value in ["abc", 0, '0', -1, "-1", 13, "13"]:
 		with pytest.raises(ValueError, match=fr"The given month \({value!r}\) is not recognised."):
 			dates.parse_month(value)  # type: ignore
 
 
-@pytest.mark.parametrize("month_idx, month", enumerate(month_full_names))
+@pytest.mark.parametrize("month_idx, month", enumerate(dates.month_full_names))
 def test_get_month_number_from_name(month_idx: int, month: str):
 	month_idx += 1  # to make 1-indexed
 
@@ -212,7 +254,7 @@ def test_get_month_number_errors(value: Union[str, int], match: str):
 
 
 def test_check_date():
-	for month_idx, month in enumerate(month_full_names):
+	for month_idx, month in enumerate(dates.month_full_names):
 
 		month_idx += 1  # to make 1-indexed
 
@@ -282,4 +324,4 @@ def test_check_date():
 				]
 		)
 def test_calc_easter(date):
-	assert calc_easter(date.year) == date
+	assert dates.calc_easter(date.year) == date