rename requirements-txt and requirements-txt-dev

docs/usage.md

@@ -36,7 +36,7 @@ To determine the project's dependencies, _deptry_ will scan the directory it is
  - development dependencies from `dev-dependencies.txt` and `dependencies-dev.txt`, if any exist
 
 _deptry_ can be configured to look for `pip` requirements files with other names or in other directories.
-See [Requirements txt](#requirements-txt) and [Requirements txt dev](#requirements-txt-dev).
+See [Requirements txt](#requirements-file) and [Requirements txt dev](#requirements-file-dev).
 
 ## Excluding files and directories
 
@@ -228,40 +228,40 @@ ignore_notebooks = true
 deptry . --ignore-notebooks
 ```
 
-#### Requirements txt
+#### Requirements file
 
 List of [`pip` requirements files](https://pip.pypa.io/en/stable/user_guide/#requirements-files) that contain the source dependencies.
 
 - Type: `list[str]`
 - Default: `["requirements.txt"]`
-- `pyproject.toml` option name: `requirements_txt`
-- CLI option name: `--requirements-txt` (short: `-rt`)
+- `pyproject.toml` option name: `requirements_file`
+- CLI option name: `--requirements-file` (short: `-rt`)
 - `pyproject.toml` example:
 ```toml
 [tool.deptry]
-requirements_txt = ["requirements.txt", "requirements-private.txt"]
+requirements_file = ["requirements.txt", "requirements-private.txt"]
 ```
 - CLI example:
 ```shell
-deptry . --requirements-txt requirements.txt,requirements-private.txt
+deptry . --requirements-file requirements.txt,requirements-private.txt
 ```
 
-#### Requirements txt dev
+#### Requirements file dev
 
 List of [`pip` requirements files](https://pip.pypa.io/en/stable/user_guide/#requirements-files) that contain the source development dependencies.
 
 - Type: `list[str]`
 - Default: `["dev-requirements.txt", "requirements-dev.txt"]`
-- `pyproject.toml` option name: `requirements_txt_dev`
-- CLI option name: `--requirements-txt-dev` (short: `-rtd`)
+- `pyproject.toml` option name: `requirements_file_dev`
+- CLI option name: `--requirements-file-dev` (short: `-rtd`)
 - `pyproject.toml` example:
 ```toml
 [tool.deptry]
-requirements_txt_dev = ["requirements-dev.txt", "requirements-tests.txt"]
+requirements_file_dev = ["requirements-dev.txt", "requirements-tests.txt"]
 ```
 - CLI example:
 ```shell
-deptry . --requirements-txt-dev requirements-dev.txt,requirements-tests.txt
+deptry . --requirements-file-dev requirements-dev.txt,requirements-tests.txt
 ```
 
 #### Known first party

python/deptry/cli.py

@@ -11,6 +11,10 @@
 
 from deptry.config import read_configuration_from_pyproject_toml
 from deptry.core import Core
+from deptry.deprecate.requirements_txt import (
+ REQUIREMENTS_TXT_DEPRECATION_MESSAGE,
+ REQUIREMENTS_TXT_DEV_DEPRECATION_MESSAGE,
+)
 
 if TYPE_CHECKING:
  from collections.abc import Mapping, MutableMapping, Sequence
@@ -183,19 +187,25 @@ def display_deptry_version(ctx: click.Context, _param: click.Parameter, value: b
  help="Display the current version and exit.",
 )
 @click.option(
- "--requirements-txt",
- "-rt",
+ "--requirements-txt", "-rt", type=COMMA_SEPARATED_TUPLE, help="To be deprecated.", hidden=True, default=()
+)
+@click.option(
+ "--requirements-txt-dev", "-rtd", type=COMMA_SEPARATED_TUPLE, help="To be deprecated.", hidden=True, default=()
+)
+@click.option(
+ "--requirements-file",
+ "-rf",
  type=COMMA_SEPARATED_TUPLE,
- help=""".txt files to scan for dependencies. If a file called pyproject.toml with a [tool.poetry.dependencies] section is found, this argument is ignored
+ help=""".txt files to scan for dependencies. If a file called pyproject.toml with a [tool.poetry.dependencies] or [project] section is found, this argument is ignored
  and the dependencies are extracted from the pyproject.toml file instead. Can be multiple e.g. `deptry . --requirements-txt req/prod.txt,req/extra.txt`""",
  default=("requirements.txt",),
  show_default=True,
 )
 @click.option(
- "--requirements-txt-dev",
- "-rtd",
+ "--requirements-file-dev",
+ "-rfd",
  type=COMMA_SEPARATED_TUPLE,
- help=""".txt files to scan for additional development dependencies. If a file called pyproject.toml with a [tool.poetry.dependencies] section is found, this argument is ignored
+ help=""".txt files to scan for additional development dependencies. If a file called pyproject.toml with a [tool.poetry.dependencies] or [project] section is found, this argument is ignored
  and the dependencies are extracted from the pyproject.toml file instead. Can be multiple e.g. `deptry . --requirements-txt-dev req/dev.txt,req/test.txt`""",
  default=("dev-requirements.txt", "requirements-dev.txt"),
  show_default=True,
@@ -246,6 +256,8 @@ def deptry(
  ignore_notebooks: bool,
  requirements_txt: tuple[str, ...],
  requirements_txt_dev: tuple[str, ...],
+ requirements_file: tuple[str, ...],
+ requirements_file_dev: tuple[str, ...],
  known_first_party: tuple[str, ...],
  json_output: str,
  package_module_name_map: MutableMapping[str, tuple[str, ...]],
@@ -264,6 +276,12 @@ def deptry(
  deptry src worker
 
  """
+
+ if requirements_txt:
+ logging.warning(REQUIREMENTS_TXT_DEPRECATION_MESSAGE)
+
+ if requirements_txt_dev:
+ logging.warning(REQUIREMENTS_TXT_DEV_DEPRECATION_MESSAGE)
  Core(
  root=root,
  config=config,
@@ -274,8 +292,8 @@ def deptry(
  ignore_notebooks=ignore_notebooks,
  ignore=ignore,
  per_rule_ignores=per_rule_ignores,
- requirements_txt=requirements_txt,
- requirements_txt_dev=requirements_txt_dev,
+ requirements_file=requirements_txt if requirements_txt else requirements_file,
+ requirements_file_dev=requirements_txt_dev if requirements_txt_dev else requirements_file_dev,
  known_first_party=known_first_party,
  json_output=json_output,
  package_module_name_map=package_module_name_map,

python/deptry/core.py

@@ -9,7 +9,7 @@
 from deptry.dependency_getter.pdm import PDMDependencyGetter
 from deptry.dependency_getter.pep_621 import PEP621DependencyGetter
 from deptry.dependency_getter.poetry import PoetryDependencyGetter
-from deptry.dependency_getter.requirements_txt import RequirementsTxtDependencyGetter
+from deptry.dependency_getter.requirements_file import RequirementsTxtDependencyGetter
 from deptry.dependency_specification_detector import DependencyManagementFormat, DependencySpecificationDetector
 from deptry.exceptions import IncorrectDependencyFormatError, UnsupportedPythonVersionError
 from deptry.imports.extract import get_imported_modules_from_list_of_files
@@ -48,8 +48,8 @@ class Core:
  extend_exclude: tuple[str, ...]
  using_default_exclude: bool
  ignore_notebooks: bool
- requirements_txt: tuple[str, ...]
- requirements_txt_dev: tuple[str, ...]
+ requirements_file: tuple[str, ...]
+ requirements_file_dev: tuple[str, ...]
  known_first_party: tuple[str, ...]
  json_output: str
  package_module_name_map: Mapping[str, tuple[str, ...]]
@@ -59,7 +59,7 @@ def run(self) -> None:
  self._log_config()
 
  dependency_management_format = DependencySpecificationDetector(
- self.config, requirements_txt=self.requirements_txt
+ self.config, requirements_file=self.requirements_file
  ).detect()
  dependencies_extract = self._get_dependencies(dependency_management_format)
 
@@ -151,9 +151,9 @@ def _get_dependencies(self, dependency_management_format: DependencyManagementFo
  return PEP621DependencyGetter(
  self.config, self.package_module_name_map, self.pep621_dev_dependency_groups
  ).get()
- if dependency_management_format is DependencyManagementFormat.REQUIREMENTS_TXT:
+ if dependency_management_format is DependencyManagementFormat.REQUIREMENTS_FILE:
  return RequirementsTxtDependencyGetter(
- self.config, self.package_module_name_map, self.requirements_txt, self.requirements_txt_dev
+ self.config, self.package_module_name_map, self.requirements_file, self.requirements_file_dev
  ).get()
  raise IncorrectDependencyFormatError
 

python/deptry/dependency_getter/requirements_txt.py → python/deptry/dependency_getter/requirements_file.py

@@ -16,13 +16,13 @@
 class RequirementsTxtDependencyGetter(DependencyGetter):
  """Extract dependencies from requirements.txt files."""
 
- requirements_txt: tuple[str, ...] = ("requirements.txt",)
- requirements_txt_dev: tuple[str, ...] = ("dev-requirements.txt", "requirements-dev.txt")
+ requirements_file: tuple[str, ...] = ("requirements.txt",)
+ requirements_file_dev: tuple[str, ...] = ("dev-requirements.txt", "requirements-dev.txt")
 
  def get(self) -> DependenciesExtract:
  dependencies = list(
  itertools.chain(
- *(self._get_dependencies_from_requirements_file(file_name) for file_name in self.requirements_txt)
+ *(self._get_dependencies_from_requirements_file(file_name) for file_name in self.requirements_file)
  )
  )
 
@@ -39,9 +39,9 @@ def get(self) -> DependenciesExtract:
 
  def _scan_for_dev_requirements_files(self) -> list[str]:
  """
- Check if any of the files passed as requirements_txt_dev exist, and if so; return them.
+ Check if any of the files passed as requirements_file_dev exist, and if so; return them.
  """
- dev_requirements_files = [file_name for file_name in self.requirements_txt_dev if file_name in os.listdir()]
+ dev_requirements_files = [file_name for file_name in self.requirements_file_dev if file_name in os.listdir()]
  if dev_requirements_files:
  logging.debug("Found files with development requirements! %s", dev_requirements_files)
  return dev_requirements_files

python/deptry/dependency_specification_detector.py

@@ -12,7 +12,7 @@ class DependencyManagementFormat(Enum):
  PDM = "pdm"
  PEP_621 = "pep_621"
  POETRY = "poetry"
- REQUIREMENTS_TXT = "requirements_txt"
+ REQUIREMENTS_FILE = "requirements_file"
 
 
 class DependencySpecificationDetector:
@@ -25,9 +25,9 @@ class DependencySpecificationDetector:
 
  """
 
- def __init__(self, config: Path, requirements_txt: tuple[str, ...] = ("requirements.txt",)) -> None:
+ def __init__(self, config: Path, requirements_file: tuple[str, ...] = ("requirements.txt",)) -> None:
  self.config = config
- self.requirements_txt = requirements_txt
+ self.requirements_file = requirements_file
 
  def detect(self) -> DependencyManagementFormat:
  pyproject_toml_found = self._project_contains_pyproject_toml()
@@ -37,10 +37,10 @@ def detect(self) -> DependencyManagementFormat:
  return DependencyManagementFormat.PDM
  if pyproject_toml_found and self._project_uses_pep_621():
  return DependencyManagementFormat.PEP_621
- if self._project_uses_requirements_txt():
- return DependencyManagementFormat.REQUIREMENTS_TXT
+ if self._project_uses_requirements_file():
+ return DependencyManagementFormat.REQUIREMENTS_FILE
 
- raise DependencySpecificationNotFoundError(self.requirements_txt)
+ raise DependencySpecificationNotFoundError(self.requirements_file)
 
  def _project_contains_pyproject_toml(self) -> bool:
  if self.config.exists():
@@ -100,11 +100,11 @@ def _project_uses_pep_621(self) -> bool:
  else:
  return True
 
- def _project_uses_requirements_txt(self) -> bool:
- check = any(Path(requirements_txt).is_file() for requirements_txt in self.requirements_txt)
+ def _project_uses_requirements_file(self) -> bool:
+ check = any(Path(requirements_file).is_file() for requirements_file in self.requirements_file)
  if check:
  logging.debug(
  "Dependency specification found in '%s'. Will use this to determine the project's dependencies.\n",
- ", ".join(self.requirements_txt),
+ ", ".join(self.requirements_file),
  )
  return check

python/deptry/deprecate/requirements_txt.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+REQUIREMENTS_TXT_DEPRECATION_MESSAGE = (
+ "Warning: In an upcoming release, support for the `--requirements-txt` command-line "
+ "option and the `requirements_txt` configuration parameter will be discontinued. "
+ "Instead, use `--requirements-file` or `requirements_txt` under the `[tool.deptry]` "
+ "section in pyproject.toml."
+)
+
+REQUIREMENTS_TXT_DEV_DEPRECATION_MESSAGE = (
+ "Warning: In an upcoming release, support for the `--requirements-txt-dev` command-line "
+ "option and the `requirements_txt_dev` configuration parameter will be discontinued. "
+ "Instead, use `--requirements-file-dev` or `requirements_txt_dev` under the `[tool.deptry]` "
+ "section in pyproject.toml."
+)

python/deptry/exceptions.py

@@ -9,10 +9,10 @@
 
 
 class DependencySpecificationNotFoundError(FileNotFoundError):
- def __init__(self, requirements_txt: tuple[str, ...]) -> None:
+ def __init__(self, requirements_file: tuple[str, ...]) -> None:
  super().__init__(
  "No file called 'pyproject.toml' with a [tool.poetry.dependencies], [tool.pdm] or [project] section or"
- f" file(s) called '{', '.join(requirements_txt)}' found. Exiting."
+ f" file(s) called '{', '.join(requirements_file)}' found. Exiting."
  )
 
 

tests/functional/cli/test_cli_requirements_txt.py

@@ -14,7 +14,7 @@
 
 
 @pytest.mark.xdist_group(name=Project.REQUIREMENTS_TXT)
-def test_cli_single_requirements_txt(pip_venv_factory: PipVenvFactory) -> None:
+def test_cli_single_requirements_file(pip_venv_factory: PipVenvFactory) -> None:
  with pip_venv_factory(
  Project.REQUIREMENTS_TXT,
  install_command=(
@@ -23,7 +23,7 @@ def test_cli_single_requirements_txt(pip_venv_factory: PipVenvFactory) -> None:
  ) as virtual_env:
  issue_report = f"{uuid.uuid4()}.json"
  result = virtual_env.run(
- "deptry . --requirements-txt requirements.txt --requirements-txt-dev requirements-dev.txt -o"
+ "deptry . --requirements-file requirements.txt --requirements-file-dev requirements-dev.txt -o"
  f" {issue_report}"
  )
 
@@ -105,7 +105,7 @@ def test_cli_single_requirements_txt(pip_venv_factory: PipVenvFactory) -> None:
 
 
 @pytest.mark.xdist_group(name=Project.REQUIREMENTS_TXT)
-def test_cli_multiple_requirements_txt(pip_venv_factory: PipVenvFactory) -> None:
+def test_cli_multiple_requirements_file(pip_venv_factory: PipVenvFactory) -> None:
  with pip_venv_factory(
  Project.REQUIREMENTS_TXT,
  install_command=(
@@ -114,7 +114,7 @@ def test_cli_multiple_requirements_txt(pip_venv_factory: PipVenvFactory) -> None
  ) as virtual_env:
  issue_report = f"{uuid.uuid4()}.json"
  result = virtual_env.run(
- "deptry . --requirements-txt requirements.txt,requirements-2.txt --requirements-txt-dev"
+ "deptry . --requirements-file requirements.txt,requirements-2.txt --requirements-file-dev"
  f" requirements-dev.txt -o {issue_report}"
  )