Update default doc requirements for projects.

domdfcoding · domdfcoding · commit 61386b646426 · 2021-01-20T17:12:42.000Z
diff --git a/repo_helper/files/testing.py b/repo_helper/files/testing.py
@@ -679,6 +679,8 @@ def compile_target_requirements(self) -> None:
 			self.target_requirements.add(ComparableRequirement("coverage-pyver-pragma>=0.0.6"))
 		if self._globals["pypi_name"] != "domdf_python_tools":
 			self.target_requirements.add(ComparableRequirement("domdf-python-tools[testing]>=2.0.1"))
+		if self._globals["pypi_name"] != "coincidence":
+			self.target_requirements.add(ComparableRequirement("coincidence>=0.1.0"))
 
 	def merge_requirements(self) -> List[str]:
 		current_requirements, comments, invalid_lines = read_requirements(self.req_file, include_invalid=True)
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -29,7 +29,7 @@
 # this package
 from repo_helper.configuration import metadata
 
-pytest_plugins = ("domdf_python_tools.testing", "repo_helper.testing")
+pytest_plugins = ("domdf_python_tools.testing", "repo_helper.testing", "coincidence")
 
 
 @pytest.fixture()
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -1,3 +1,4 @@
+coincidence>=0.1.0
 coverage>=5.1
 coverage-pyver-pragma>=0.0.6
 domdf-python-tools[testing]>=2.0.1
diff --git a/tests/test_blocks.py b/tests/test_blocks.py
@@ -23,7 +23,7 @@
 # 3rd party
 import lorem  # type: ignore
 import pytest
-from domdf_python_tools.testing import check_file_regression
+from coincidence import check_file_regression
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_cli/test_builder.py b/tests/test_cli/test_builder.py
@@ -5,8 +5,8 @@
 
 # 3rd party
 import pytest
+from coincidence import check_file_output
 from domdf_python_tools.paths import PathPlus
-from domdf_python_tools.testing import check_file_output
 from pytest_regressions.data_regression import DataRegressionFixture
 from pytest_regressions.file_regression import FileRegressionFixture
 
diff --git a/tests/test_cli/test_conda_recipe.py b/tests/test_cli/test_conda_recipe.py
@@ -4,8 +4,8 @@
 
 # 3rd party
 from click.testing import CliRunner, Result
+from coincidence import check_file_output
 from domdf_python_tools.paths import in_directory
-from domdf_python_tools.testing import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_cli/test_release.py b/tests/test_cli/test_release.py
@@ -4,8 +4,8 @@
 
 # 3rd party
 from click.testing import CliRunner, Result
+from coincidence import check_file_output
 from domdf_python_tools.paths import in_directory
-from domdf_python_tools.testing import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 from southwark import get_tags
 from southwark.repo import Repo
diff --git a/tests/test_cli/test_show.py b/tests/test_cli/test_show.py
@@ -4,8 +4,8 @@
 # 3rd party
 import pytest
 from click.testing import CliRunner, Result
+from coincidence import check_file_regression, min_version, not_pypy, not_windows
 from domdf_python_tools.paths import PathPlus, in_directory
-from domdf_python_tools.testing import check_file_regression, min_version, not_pypy, not_windows
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_cli/test_show_requirements_win.py b/tests/test_cli/test_show_requirements_win.py
@@ -1,5 +1,5 @@
 # 3rd party
-from domdf_python_tools.testing import not_pypy, only_windows
+from coincidence import not_pypy, only_windows
 
 # this package
 from tests.test_cli.test_show import ShowRequirementsTest
diff --git a/tests/test_cli/test_suggest.py b/tests/test_cli/test_suggest.py
@@ -1,8 +1,8 @@
 # 3rd party
 import pytest
 from click.testing import CliRunner, Result
+from coincidence import check_file_output
 from domdf_python_tools.paths import in_directory
-from domdf_python_tools.testing import check_file_output
 from pytest_regressions.data_regression import DataRegressionFixture
 from pytest_regressions.file_regression import FileRegressionFixture
 
diff --git a/tests/test_cli/test_wizard.py b/tests/test_cli/test_wizard.py
@@ -6,8 +6,8 @@
 # 3rd party
 import pytest
 from click.testing import CliRunner, Result
+from coincidence import check_file_output
 from domdf_python_tools.paths import in_directory
-from domdf_python_tools.testing import check_file_output
 from dulwich.config import StackedConfig
 
 # this package
diff --git a/tests/test_core.py b/tests/test_core.py
@@ -5,8 +5,8 @@
 # 3rd party
 import pytest
 from click import Abort
+from coincidence import check_file_regression
 from domdf_python_tools.paths import in_directory
-from domdf_python_tools.testing import check_file_regression
 from pytest_regressions.data_regression import DataRegressionFixture
 from pytest_regressions.file_regression import FileRegressionFixture
 from southwark import status
diff --git a/tests/test_files/test_bots.py b/tests/test_files/test_bots.py
@@ -22,7 +22,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_files/test_ci_cd.py b/tests/test_files/test_ci_cd.py
@@ -25,7 +25,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.data_regression import DataRegressionFixture
 from pytest_regressions.file_regression import FileRegressionFixture
 
diff --git a/tests/test_files/test_contributing.py b/tests/test_files/test_contributing.py
@@ -25,7 +25,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output, check_file_regression
+from coincidence import check_file_output, check_file_regression
 from pytest_regressions.file_regression import FileRegressionFixture
 from readme_renderer.rst import render  # type: ignore
 
diff --git a/tests/test_files/test_docs.py b/tests/test_files/test_docs.py
@@ -22,7 +22,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output, check_file_regression
+from coincidence import check_file_output, check_file_regression
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_files/test_gitignore.py b/tests/test_files/test_gitignore.py
@@ -21,7 +21,7 @@
 #
 
 # 3rd party
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_files/test_linting.py b/tests/test_files/test_linting.py
@@ -1,5 +1,5 @@
 # 3rd party
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_files/test_packaging.py b/tests/test_files/test_packaging.py
@@ -25,7 +25,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
diff --git a/tests/test_files/test_readme.py b/tests/test_files/test_readme.py
@@ -25,9 +25,9 @@
 
 # 3rd party
 import pytest
+from coincidence import check_file_output, check_file_regression
 from domdf_python_tools.compat import importlib_resources
 from domdf_python_tools.paths import PathPlus
-from domdf_python_tools.testing import check_file_output, check_file_regression
 from pytest_regressions.file_regression import FileRegressionFixture
 from readme_renderer.rst import render  # type: ignore
 
diff --git a/tests/test_files/test_testing.py b/tests/test_files/test_testing.py
@@ -25,7 +25,7 @@
 
 # 3rd party
 import pytest
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
@@ -114,13 +114,13 @@ def test_make_isort_case_1(tmp_pathplus, demo_environment, file_regression):
 	(tmp_pathplus / "tests").mkdir()
 	(tmp_pathplus / "tests" / "requirements.txt").write_text('')
 
-	(tmp_pathplus / "requirements.txt").write_text("""
-tox
-isort
-black
-wheel
-setuptools_rust
-""")
+	(tmp_pathplus / "requirements.txt").write_lines([
+			"tox",
+			"isort",
+			"black",
+			"wheel",
+			"setuptools_rust",
+			])
 	ensure_tests_requirements(tmp_pathplus, demo_environment)
 
 	managed_files = make_isort(tmp_pathplus, demo_environment)
@@ -132,18 +132,16 @@ def test_make_isort_case_2(tmp_pathplus, demo_environment, file_regression):
 	(tmp_pathplus / "tests").mkdir()
 	(tmp_pathplus / "tests" / "requirements.txt").write_text('')
 
-	(tmp_pathplus / "requirements.txt").write_text("""
-tox
-isort
-black
-wheel
-setuptools_rust
-""")
+	(tmp_pathplus / "requirements.txt").write_lines([
+			"tox",
+			"isort",
+			"black",
+			"wheel",
+			"setuptools_rust",
+			])
 	ensure_tests_requirements(tmp_pathplus, demo_environment)
 
-	(tmp_pathplus / ".isort.cfg").write_text("""[settings]
-known_third_party=awesome_package
-""")
+	(tmp_pathplus / ".isort.cfg").write_lines(["[settings]", "known_third_party=awesome_package"])
 
 	managed_files = make_isort(tmp_pathplus, demo_environment)
 	assert managed_files == [".isort.cfg"]
@@ -158,38 +156,38 @@ def test_ensure_tests_requirements(tmp_pathplus, demo_environment):
 	managed_files = ensure_tests_requirements(tmp_pathplus, demo_environment)
 	assert managed_files == [posixpath.join("tests", "requirements.txt")]
 
-	assert (tmp_pathplus / managed_files[0]).read_text(
-			encoding="UTF-8"
-			) == """\
-coverage>=5.1
-coverage-pyver-pragma>=0.0.6
-domdf-python-tools[testing]>=2.0.1
-iniconfig!=1.1.0,>=1.0.1
-pytest>=6.0.0
-pytest-cov>=2.8.1
-pytest-randomly>=3.3.1
-pytest-timeout>=1.4.2
-"""
+	assert (tmp_pathplus / managed_files[0]).read_lines() == [
+			"coincidence>=0.1.0",
+			"coverage>=5.1",
+			"coverage-pyver-pragma>=0.0.6",
+			"domdf-python-tools[testing]>=2.0.1",
+			"iniconfig!=1.1.0,>=1.0.1",
+			"pytest>=6.0.0",
+			"pytest-cov>=2.8.1",
+			"pytest-randomly>=3.3.1",
+			"pytest-timeout>=1.4.2",
+			'',
+			]
 
 	with (tmp_pathplus / managed_files[0]).open('a', encoding="UTF-8") as fp:
 		fp.write("lorem>=0.1.1")
 
 	managed_files = ensure_tests_requirements(tmp_pathplus, demo_environment)
 	assert managed_files == ["tests/requirements.txt"]
 
-	assert (tmp_pathplus / managed_files[0]).read_text(
-			encoding="UTF-8"
-			) == """\
-coverage>=5.1
-coverage-pyver-pragma>=0.0.6
-domdf-python-tools[testing]>=2.0.1
-iniconfig!=1.1.0,>=1.0.1
-lorem>=0.1.1
-pytest>=6.0.0
-pytest-cov>=2.8.1
-pytest-randomly>=3.3.1
-pytest-timeout>=1.4.2
-"""
+	assert (tmp_pathplus / managed_files[0]).read_lines() == [
+			"coincidence>=0.1.0",
+			"coverage>=5.1",
+			"coverage-pyver-pragma>=0.0.6",
+			"domdf-python-tools[testing]>=2.0.1",
+			"iniconfig!=1.1.0,>=1.0.1",
+			"lorem>=0.1.1",
+			"pytest>=6.0.0",
+			"pytest-cov>=2.8.1",
+			"pytest-randomly>=3.3.1",
+			"pytest-timeout>=1.4.2",
+			'',
+			]
 
 
 def test_ensure_tests_requirements_extras(tmp_pathplus, demo_environment):
@@ -200,19 +198,19 @@ def test_ensure_tests_requirements_extras(tmp_pathplus, demo_environment):
 	managed_files = ensure_tests_requirements(tmp_pathplus, demo_environment)
 	assert managed_files == [posixpath.join("tests", "requirements.txt")]
 
-	assert (tmp_pathplus / managed_files[0]).read_text(
-			encoding="UTF-8"
-			) == """\
-coverage>=5.1
-coverage-pyver-pragma>=0.0.6
-domdf-python-tools[testing]>=2.0.1
-iniconfig!=1.1.0,>=1.0.1
-pytest>=6.0.0
-pytest-cov>=2.8.1
-pytest-randomly>=3.3.1
-pytest-timeout>=1.4.2
-some-package[extra]>=1.5.0
-"""
+	assert (tmp_pathplus / managed_files[0]).read_lines() == [
+			"coincidence>=0.1.0",
+			"coverage>=5.1",
+			"coverage-pyver-pragma>=0.0.6",
+			"domdf-python-tools[testing]>=2.0.1",
+			"iniconfig!=1.1.0,>=1.0.1",
+			"pytest>=6.0.0",
+			"pytest-cov>=2.8.1",
+			"pytest-randomly>=3.3.1",
+			"pytest-timeout>=1.4.2",
+			"some-package[extra]>=1.5.0",
+			'',
+			]
 
 
 def test_make_pre_commit(tmp_pathplus, demo_environment, file_regression):
diff --git a/tests/test_files/test_testing_/test_make_isort_case_1.cfg b/tests/test_files/test_testing_/test_make_isort_case_1.cfg
@@ -14,6 +14,7 @@ remove_redundant_aliases = True
 default_section = THIRDPARTY
 known_third_party =
     black
+    coincidence
     coverage
     coverage_pyver_pragma
     domdf_python_tools
diff --git a/tests/test_files/test_testing_/test_make_isort_case_2.cfg b/tests/test_files/test_testing_/test_make_isort_case_2.cfg
@@ -2,6 +2,7 @@
 known_third_party =
     awesome_package
     black
+    coincidence
     coverage
     coverage_pyver_pragma
     domdf_python_tools
diff --git a/tests/test_init_repo.py b/tests/test_init_repo.py
@@ -2,7 +2,7 @@
 import pytest
 import requests.exceptions
 from apeye.requests_url import RequestsURL
-from domdf_python_tools.testing import check_file_output
+from coincidence import check_file_output
 
 # this package
 from repo_helper.cli.commands.init import init_repo
diff --git a/tests/test_requirements_tools.py b/tests/test_requirements_tools.py
@@ -21,7 +21,7 @@
 #
 
 # 3rd party
-from domdf_python_tools.testing import check_file_regression
+from coincidence import check_file_regression
 from pytest_regressions.file_regression import FileRegressionFixture
 from shippinglabel.requirements import read_requirements
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+coincidence>=0.1.0`
`1`	`2`	`coverage>=5.1`
`2`	`3`	`coverage-pyver-pragma>=0.0.6`
`3`	`4`	`domdf-python-tools[testing]>=2.0.1`