dependence 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

dependence/_utilities.py

@@ -1,12 +1,44 @@
+import os
 import sys
 from functools import lru_cache
 from itertools import chain
+from subprocess import check_output as _check_output
+from tempfile import mktemp
 from traceback import format_exception
-from typing import Any, Dict, Iterable, List
+from typing import Any, Dict, Hashable, Iterable, List, Set, Tuple
 
 import tomli
 
 
+def check_output(command: Tuple[str, ...]) -> str:
+    """
+    This function wraps `subprocess.check_output`, but redirects stderr
+    to a temporary file, then deletes that file (a platform-independent
+    means of redirecting output to DEVNULL).
+
+    Parameters:
+
+    - command (Tuple[str, ...]): The command to run
+    """
+    stderr_path: str = mktemp()
+    with open(stderr_path, "w") as stderr:
+        output = _check_output(command, stderr=stderr, text=True)
+    os.remove(stderr_path)
+    return output
+
+
+def iter_distinct(items: Iterable[Hashable]) -> Iterable:
+    """
+    Yield distinct elements, preserving order
+    """
+    visited: Set[Hashable] = set()
+    item: Hashable
+    for item in items:
+        if item not in visited:
+            visited.add(item)
+            yield item
+
+
 @lru_cache()
 def pyproject_toml_defines_project(pyproject_toml_path: str) -> bool:
     pyproject: Dict[str, Any]

dependence/freeze.py

@@ -5,9 +5,7 @@ from importlib.metadata import distribution as _get_distribution
 from itertools import chain
 from typing import Dict, Iterable, MutableSet, Optional, Tuple, cast
 
-from more_itertools import unique_everseen
-
-from ._utilities import iter_parse_delimited_values
+from ._utilities import iter_distinct, iter_parse_delimited_values
 from .utilities import (
     get_distribution,
     get_required_distribution_names,
@@ -113,7 +111,7 @@ def get_frozen_requirements(
     requirement_strings: MutableSet[str] = cast(
         MutableSet[str], requirements - requirement_files
     )
-    frozen_requirements: Iterable[str] = unique_everseen(
+    frozen_requirements: Iterable[str] = iter_distinct(
         chain(
             requirement_strings,
             *map(
@@ -213,7 +211,7 @@ def _iter_frozen_requirements(
         )
 
     distribution_names: MutableSet[str]
-    requirements: Iterable[str] = unique_everseen(
+    requirements: Iterable[str] = iter_distinct(
         chain(
             *map(
                 lambda distribution_names: get_required_distribution_names_(
@@ -223,7 +221,6 @@ def _iter_frozen_requirements(
             )
         ),
     )
-
     requirements = map(get_requirement_string, requirements)
     return requirements
 

dependence/update.py

@@ -21,13 +21,12 @@ from typing import (
 
 import tomli
 import tomli_w
-from more_itertools import unique_everseen
 from packaging.requirements import Requirement
 from packaging.specifiers import Specifier, SpecifierSet
 from packaging.version import Version
 from packaging.version import parse as parse_version
 
-from ._utilities import iter_parse_delimited_values
+from ._utilities import iter_distinct, iter_parse_delimited_values
 from .utilities import (
     get_installed_distributions,
     is_requirement_string,
@@ -230,7 +229,7 @@ def get_updated_setup_cfg(
             # We pre-pend an empty requirement string in order to]
             # force new-line creation at the beginning of the extra
             extras_require[all_extra_name] = "\n".join(
-                unique_everseen([""] + all_extra_requirements)
+                iter_distinct([""] + all_extra_requirements)
             )
     # Return as a string
     setup_cfg: str
@@ -369,7 +368,7 @@ def get_updated_pyproject_toml(
             project_optional_dependencies[extra_name] = extra_requirements
         if all_extra_name:
             project_optional_dependencies[all_extra_name] = list(
-                unique_everseen(all_extra_requirements)
+                iter_distinct(all_extra_requirements)
             )
     if (
         build_system_requires

dependence/utilities.py

@@ -13,11 +13,12 @@ from itertools import chain
 from pathlib import Path
 from runpy import run_path
 from shutil import move, rmtree
-from subprocess import CalledProcessError, check_call, check_output
+from subprocess import CalledProcessError
 from tempfile import mkdtemp
 from types import ModuleType
 from typing import (
     IO,
+    AbstractSet,
     Any,
     Container,
     Dict,
@@ -32,11 +33,15 @@ from typing import (
 from warnings import warn
 
 import tomli
-from more_itertools import unique_everseen
 from packaging.requirements import InvalidRequirement, Requirement
 from packaging.utils import canonicalize_name
 
-from ._utilities import append_exception_text, get_exception_text
+from ._utilities import (
+    append_exception_text,
+    check_output,
+    get_exception_text,
+    iter_distinct,
+)
 
 _BUILTIN_DISTRIBUTION_NAMES: Tuple[str] = ("distribute",)
 
@@ -330,12 +335,31 @@ def _iter_setup_cfg_requirement_strings(path: str) -> Iterable[str]:
                     extra_requirements_string.split("\n"),
                 ),
             )
-    return unique_everseen(requirement_strings)
+    return iter_distinct(requirement_strings)
+
+
+def _iter_tox_ini_requirement_strings(
+    path: Union[str, Path, ConfigParser] = "",
+    string: str = "",
+) -> Iterable[str]:
+    """
+    Parse a tox.ini file and yield the requirements found in the `deps`
+    options of each section.
 
+    Parameters:
 
-def _iter_tox_ini_requirement_strings(path: str) -> Iterable[str]:
+    - path (str|Path) = "": The path to a tox.ini file
+    - string (str) = "": The contents of a tox.ini file
+    """
     parser: ConfigParser = ConfigParser()
-    parser.read(path)
+    if path:
+        assert (
+            not string
+        ), "Either `path` or `string` arguments may be provided, but not both"
+        parser.read(path)
+    else:
+        assert string, "Either a `path` or `string` argument must be provided"
+        parser.read_string(string)
 
     def get_section_option_requirements(
         section_name: str, option_name: str
@@ -358,32 +382,117 @@ def _iter_tox_ini_requirement_strings(path: str) -> Iterable[str]:
             )
         return requirements
 
-    return unique_everseen(
+    return iter_distinct(
         chain(("tox",), *map(get_section_requirements, parser.sections()))
     )
 
 
-def _iter_pyproject_toml_requirement_strings(path: str) -> Iterable[str]:
+def _iter_pyproject_toml_requirement_strings(
+    path: str,
+    exclude_build_system: bool = False,
+    exclude_project: bool = False,
+    exclude_project_dependencies: bool = False,
+    exclude_project_optional_dependencies: bool = False,
+    include_project_optional_dependencies: Iterable[str] = frozenset(),
+    exclude_tools: bool = False,
+    exclude_tox: bool = False,
+) -> Iterable[str]:
+    """
+    Read a pyproject.toml file and yield the requirements found.
+
+    - exclude_build_system (bool) = False: If `True`, build-system
+      requirements will not be included
+    - exclude_project (bool) = False: If `True`, build-system
+      requirements will not be included
+    - exclude_project_dependencies (bool) = False: If `True`, project
+      dependencies will not be included
+    - exclude_project_optional_dependencies (bool) = False: If `True`, project
+      optional dependencies will not be included
+    - include_project_optional_dependencies ({str}) = frozenset(): If a
+      non-empty set is provided, *only* dependencies for the specified extras
+      (options) will be included
+    - exclude_tools (bool) = False: If `True`, tool requirements will not be
+      included
+    - exclude_tox (bool) = False: If `True`, tool.tox dependencies will not be
+      included
+    """
+    include_project_optional_dependencies = (
+        include_project_optional_dependencies
+        if isinstance(include_project_optional_dependencies, set)
+        else frozenset(include_project_optional_dependencies)
+    )
     pyproject_io: IO[str]
     with open(path) as pyproject_io:
         pyproject: Dict[str, Any] = tomli.loads(pyproject_io.read())
-        if ("build-system" in pyproject) and (
-            "requires" in pyproject["build-system"]
+        # Build system requirements
+        if (
+            ("build-system" in pyproject)
+            and ("requires" in pyproject["build-system"])
+            and not exclude_build_system
         ):
             yield from pyproject["build-system"]["requires"]
-        if ("project" in pyproject) and (
-            "dependencies" in pyproject["project"]
-        ):
-            yield from pyproject["project"]["dependencies"]
-        if "project.optional-dependencies" in pyproject:
-            values: Iterable[str]
-            for values in pyproject["project.optional-dependencies"].values():
-                yield from values
+        # Project requirements
+        if ("project" in pyproject) and not exclude_project:
+            if (
+                "dependencies" in pyproject["project"]
+            ) and not exclude_project_dependencies:
+                yield from pyproject["project"]["dependencies"]
+            if (
+                "optional-dependencies" in pyproject["project"]
+            ) and not exclude_project_optional_dependencies:
+                key: str
+                values: Iterable[str]
+                for key, values in pyproject["project"][
+                    "optional-dependencies"
+                ].items():
+                    if (not include_project_optional_dependencies) or (
+                        key in include_project_optional_dependencies
+                    ):
+                        yield from values
+        # Tool Requirements
+        if ("tool" in pyproject) and not exclude_tools:
+            # Tox
+            if ("tox" in pyproject["tool"]) and not exclude_tox:
+                if "legacy_tox_ini" in pyproject["tool"]["tox"]:
+                    yield from _iter_tox_ini_requirement_strings(
+                        string=pyproject["tool"]["tox"]["legacy_tox_ini"]
+                    )
 
 
-def iter_configuration_file_requirement_strings(path: str) -> Iterable[str]:
+def iter_configuration_file_requirement_strings(
+    path: str,
+    exclude_build_system: bool = False,
+    exclude_project: bool = False,
+    exclude_project_dependencies: bool = False,
+    exclude_project_optional_dependencies: bool = False,
+    include_project_optional_dependencies: AbstractSet[str] = frozenset(),
+    exclude_tools: bool = False,
+    exclude_tox: bool = False,
+) -> Iterable[str]:
     """
     Read a configuration file and yield the parsed requirements.
+
+    Parameters:
+
+    - path (str): The path to a configuration file
+
+    Parameters only applicable to `pyproject.toml` files:
+
+    - exclude_build_system (bool) = False: If `True`, build-system
+      requirements will not be included
+    - exclude_project (bool) = False: If `True`, build-system
+      requirements will not be included
+    - exclude_project_dependencies (bool) = False: If `True`, project
+      dependencies will not be included
+    - exclude_project_optional_dependencies (bool) = False: If `True`, project
+      optional dependencies will not be included
+    - include_project_optional_dependencies ({str}) = frozenset(): If a
+      non-empty set is provided, *only* dependencies for the specified extras
+      (options) will be included
+    - exclude_tools (bool) = False: If `True`, tool requirements will not be
+      included
+    - exclude_tox (bool) = False: If `True`, tool.tox dependencies will not be
+      included
     """
     configuration_file_type: ConfigurationFileType = (
         get_configuration_file_type(path)
@@ -391,9 +500,22 @@ def iter_configuration_file_requirement_strings(path: str) -> Iterable[str]:
     if configuration_file_type == ConfigurationFileType.SETUP_CFG:
         return _iter_setup_cfg_requirement_strings(path)
     elif configuration_file_type == ConfigurationFileType.PYPROJECT_TOML:
-        return _iter_pyproject_toml_requirement_strings(path)
+        return _iter_pyproject_toml_requirement_strings(
+            path,
+            exclude_build_system=exclude_build_system,
+            exclude_project=exclude_project,
+            exclude_project_dependencies=exclude_project_dependencies,
+            exclude_project_optional_dependencies=(
+                exclude_project_optional_dependencies
+            ),
+            include_project_optional_dependencies=(
+                include_project_optional_dependencies
+            ),
+            exclude_tools=exclude_tools,
+            exclude_tox=exclude_tox,
+        )
     elif configuration_file_type == ConfigurationFileType.TOX_INI:
-        return _iter_tox_ini_requirement_strings(path)
+        return _iter_tox_ini_requirement_strings(path=path)
     else:
         assert (
             configuration_file_type == ConfigurationFileType.REQUIREMENTS_TXT
@@ -448,13 +570,7 @@ def _get_setup_py_metadata(path: str, args: Tuple[str, ...]) -> str:
         if os.path.isfile(path):
             command: Tuple[str, ...] = (sys.executable, path) + args
             try:
-                value = (
-                    check_output(
-                        command, encoding="utf-8", universal_newlines=True
-                    )
-                    .strip()
-                    .split("\n")[-1]
-                )
+                value = check_output(command).strip().split("\n")[-1]
             except CalledProcessError:
                 warn(
                     f"A package name could not be found in {path}, "
@@ -464,13 +580,7 @@ def _get_setup_py_metadata(path: str, args: Tuple[str, ...]) -> str:
                 # re-write egg info and attempt to get the name again
                 setup_egg_info(directory)
                 try:
-                    value = (
-                        check_output(
-                            command, encoding="utf-8", universal_newlines=True
-                        )
-                        .strip()
-                        .split("\n")[-1]
-                    )
+                    value = check_output(command).strip().split("\n")[-1]
                 except Exception:
                     warn(
                         f"A package name could not be found in {path}"
@@ -704,7 +814,7 @@ def _install_requirement_string(
         if editable:
             flags += ("-e",)
         try:
-            check_call(
+            check_output(
                 (
                     sys.executable,
                     "-m",
@@ -836,7 +946,7 @@ def _iter_requirement_names(
     if distribution is None:
         return ()
     requirements: Tuple[Requirement, ...] = tuple(
-        unique_everseen(
+        iter_distinct(
             _iter_distribution_requirements(
                 distribution,
                 extras=extras,
@@ -918,7 +1028,7 @@ def _iter_requirement_strings_required_distribution_names(
                 pass
         return set()
 
-    return unique_everseen(
+    return iter_distinct(
         chain(*map(get_required_distribution_names_, requirement_strings)),
     )
 
@@ -951,7 +1061,7 @@ def get_requirements_required_distribution_names(
     name: str
     return set(
         _iter_requirement_strings_required_distribution_names(
-            unique_everseen(
+            iter_distinct(
                 chain(
                     requirement_strings,
                     *map(

{dependence-0.2.0.dist-info → dependence-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dependence
-Version: 0.2.0
+Version: 0.3.1
 Summary: Requirement (dependency) management for python projects
 Home-page: https://github.com/enorganic/dependence
 Author-email: david@belais.me
@@ -12,7 +12,6 @@ Requires-Dist: packaging
 Requires-Dist: pip
 Requires-Dist: tomli ~=2.0
 Requires-Dist: tomli-w ~=1.0
-Requires-Dist: more-itertools >7
 Requires-Dist: setuptools >63
 
 # dependence

dependence-0.3.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+dependence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dependence/__main__.py,sha256=myBIBZdez2jC3_dkVSE-mOLo39yKi2cF_0NuVXcXF1E,1528
+dependence/_utilities.py,sha256=3fhceJ3yNRLp3HsDxvIEFZsjRlemEQ6oOF7Wx1jaRhQ,3296
+dependence/freeze.py,sha256=6sP-z-BIwOzF7JgnUD134gu4711-LY-zaQ26yPdq5JE,13298
+dependence/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dependence/update.py,sha256=FRl0FsdAIfjWacw1cVS8Fh024ZN7hK3ZHJiQpsRinfQ,16571
+dependence/utilities.py,sha256=DwYIFlS5h9B-wrycsntZsOtmuMped0Eyra9ZFmnCxwU,36201
+dependence-0.3.1.dist-info/METADATA,sha256=V2-5Ce3KwhYzl31JGftABxvlRDV42Y3ahZbvgvfoqK4,5597
+dependence-0.3.1.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+dependence-0.3.1.dist-info/entry_points.txt,sha256=NStO_B0D81ObVYr9zDs6LCy0whm0a8KCiiFHMmTwOVE,56
+dependence-0.3.1.dist-info/top_level.txt,sha256=5rooMYWKlAUelE8hjGegbf4uuAIqNuRlhlpA7oc7Qro,11
+dependence-0.3.1.dist-info/RECORD,,

{dependence-0.2.0.dist-info → dependence-0.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (71.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

dependence-0.2.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-dependence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dependence/__main__.py,sha256=myBIBZdez2jC3_dkVSE-mOLo39yKi2cF_0NuVXcXF1E,1528
-dependence/_utilities.py,sha256=pGK9JAMOAVGvamo4Espmk0NUftosW7UxZnwWXbNM47w,2385
-dependence/freeze.py,sha256=BCbqXNMReXX5N5S0FJK_bqSZCOHOIh2ti0m-4Klzpxc,13332
-dependence/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dependence/update.py,sha256=9TIU4JC1M-RHZfXYxeAmtbXS_lAFy_Z9sy8Ce1PTz4g,16603
-dependence/utilities.py,sha256=Lo3guZSA7a2gARz3RzEqLenbG6VTWcA5-eucHB9S-58,31837
-dependence-0.2.0.dist-info/METADATA,sha256=H-olY5qur_SwQupzfKeK-OofgWYt2UKg8sEorub_0Q4,5630
-dependence-0.2.0.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-dependence-0.2.0.dist-info/entry_points.txt,sha256=NStO_B0D81ObVYr9zDs6LCy0whm0a8KCiiFHMmTwOVE,56
-dependence-0.2.0.dist-info/top_level.txt,sha256=5rooMYWKlAUelE8hjGegbf4uuAIqNuRlhlpA7oc7Qro,11
-dependence-0.2.0.dist-info/RECORD,,