Add support for reading the requirements from pyproject.toml

Author: domdfcoding

dep_checker/__init__.py

@@ -39,6 +39,7 @@
 from consolekit.terminal_colours import Fore, resolve_color_default
 from domdf_python_tools.paths import PathPlus, in_directory
 from domdf_python_tools.typing import PathLike
+from packaging.requirements import Requirement
 from shippinglabel.requirements import read_requirements
 
 # this package
@@ -315,18 +316,18 @@ def iter_files_to_check(basepath: PathLike, pkg_name: str) -> Iterator[PathPlus]
 
 def check_imports(
 		pkg_name: str,
-		req_file: PathLike = "requirements.txt",
+		*requirements: Requirement,
 		allowed_unused: Optional[List[str]] = None,
 		colour: Optional[bool] = None,
 		name_mapping: Optional[Dict[str, str]] = None,
 		namespace_packages: Optional[List[str]] = None,
 		work_dir: PathLike = '.',
 		) -> int:
-	"""
+	r"""
 	Check imports for the given package, against the given requirements file.
 
 	:param pkg_name:
-	:param req_file:
+	:param \*requirements:
 	:param allowed_unused: List of requirements which are allowed to be unused in the source code.
 	:default allowed_unused: ``[]``
 	:param colour: Whether to use coloured output.
@@ -346,6 +347,10 @@ def check_imports(
 
 		* Added the ``name_mapping`` option.
 		* Added the ``work_dir`` option.
+
+	.. versionchanged:: 0.7.0 Replaced the ``req_file`` argument with the ``*requirements`` argument.
+		Use :func:`shippinglabel.requirements.read_requirements(req_file)[0] <shippinglabel.requirements.read_requirements>`
+		 to get the original bevhaviour.
 	"""
 
 	ret = 0
@@ -362,17 +367,11 @@ def check_imports(
 		namespace_packages = NamespacePackages.get(config)
 
 	work_dir = PathPlus(work_dir)
-	req_file = PathPlus(req_file)
-
-	if not req_file.is_absolute():
-		req_file = work_dir / req_file
-
-	req_file = req_file.abspath()
 	work_dir = work_dir.abspath()
 
 	checker = DepChecker(
 			pkg_name,
-			requirements=map(attrgetter("name"), read_requirements(req_file)[0]),
+			requirements=map(attrgetter("name"), requirements),
 			allowed_unused=allowed_unused,
 			name_mapping=name_mapping,
 			namespace_packages=namespace_packages,

dep_checker/__main__.py

@@ -32,11 +32,15 @@
 
 # 3rd party
 import click
+import dom_toml
 from consolekit import click_command
-from consolekit.options import colour_option
+from consolekit.options import auto_default_option, colour_option, flag_option
 from consolekit.utils import abort
 
 # this package
+from domdf_python_tools.paths import PathPlus
+from shippinglabel.requirements import parse_pyproject_dependencies, read_requirements
+
 from dep_checker import check_imports
 
 __all__ = ("main", )
@@ -57,12 +61,16 @@
 		multiple=True,
 		help="Requirements which are allowed to be unused in the source code.",
 		)
-@click.option(
+@auto_default_option(
 		"--req-file",
 		type=click.STRING,
 		metavar="FILENAME",
-		default="requirements.txt",
-		help="The requirements file.",
+		help="Parse the requirements from the given requirements file.",
+		)
+@flag_option(
+		"-P", "--pyproject",
+		type=click.STRING,
+		help="Parse the requirements from 'pyproject.toml'.",
 		)
 @click.argument(
 		"pkg-name",
@@ -71,10 +79,11 @@
 @click_command()
 def main(
 		pkg_name: str,
-		req_file: str,
 		allowed_unused: Optional[List[str]],
-		colour: Optional[bool],
+		colour: Optional[bool] = None,
+		req_file: str = "requirements.txt",
 		work_dir: str = '.',
+		pyproject: bool = False
 		) -> None:
 	"""
 	Tool to check all requirements are actually required.
@@ -83,10 +92,32 @@ def main(
 	if allowed_unused == ():
 		allowed_unused = None
 
+	work_dir = PathPlus(work_dir)
+
+	def read_req_file(req_file):
+		req_file = PathPlus(req_file)
+
+		if not req_file.is_absolute():
+			req_file = work_dir / req_file
+
+		return read_requirements(req_file)[0]
+
+	if pyproject:
+		pyproject_file = work_dir / "pyproject.toml"
+		dynamic = dom_toml.load(pyproject_file)["project"].get("dynamic", ())
+
+		if "requirements" in dynamic:
+			requirements = read_req_file(work_dir / "requirements.txt")
+		else:
+			requirements = parse_pyproject_dependencies(pyproject_file, flavour="pep621")
+
+	else:
+		requirements = read_req_file(req_file)
+
 	try:
 		ret = check_imports(
 				pkg_name,
-				req_file=req_file,
+				*requirements,
 				allowed_unused=allowed_unused,
 				colour=colour,
 				work_dir=work_dir,

doc-source/usage.rst

@@ -109,6 +109,12 @@ Command Line
 	:prog: dep-checker
 
 
+The :option:`-P / --pyproject <-P>` option takes precedence over the :option:`--req-file` option.
+
+.. versionchanged:: 0.7.0
+
+	Added the :option:`-P / --pyproject <-P>` option.
+
 As a ``pre-commit`` hook
 ----------------------------