dependence 1.1.2__py3-none-any.whl → 1.2.0__py3-none-any.whl

dependence/_utilities.py

@@ -4,6 +4,7 @@ import functools
 import json
 import os
 import re
+import shutil
 import sys
 from collections import deque
 from collections.abc import Container, Hashable, Iterable, MutableSet
@@ -95,6 +96,44 @@ def _undefined() -> Undefined:
     return UNDEFINED
 
 
+cache: Any
+try:
+    from functools import cache  # type: ignore
+except ImportError:
+    from functools import lru_cache
+
+    cache = lru_cache(maxsize=None)
+
+
+def as_tuple(
+    user_function: Callable[..., Iterable[Any]],
+) -> Callable[..., tuple[Any, ...]]:
+    """
+    This is a decorator which will return an iterable as a tuple.
+    """
+
+    def wrapper(*args: Any, **kwargs: Any) -> tuple[Any, ...]:
+        return tuple(user_function(*args, **kwargs) or ())
+
+    return functools.update_wrapper(wrapper, user_function)
+
+
+def as_cached_tuple(
+    maxsize: int | None = None, *, typed: bool = False
+) -> Callable[[Callable[..., Iterable[Any]]], Callable[..., tuple[Any, ...]]]:
+    """
+    This is a decorator which will return an iterable as a tuple,
+    and cache that tuple.
+
+    Parameters:
+
+    - maxsize (int|None) = None: The maximum number of items to cache.
+    - typed (bool) = False: For class methods, should the cache be distinct for
+      sub-classes?
+    """
+    return functools.lru_cache(maxsize=maxsize, typed=typed)(as_tuple)
+
+
 def iter_distinct(items: Iterable[Hashable]) -> Iterable:
     """
     Yield distinct elements, preserving order
@@ -418,47 +457,75 @@ def iter_configuration_files(path: str | Path) -> Iterable[Path | str]:
             yield path
 
 
-class _EditablePackageMetadata(TypedDict):
+def _iter_editable_project_locations() -> Iterable[tuple[str, str]]:
+    metadata: PackageMetadata
+    for name, metadata in map_pip_list().items():
+        editable_project_location: str | None = metadata.get(
+            "editable_project_location"
+        )
+        if editable_project_location:
+            yield (
+                name,
+                editable_project_location,
+            )
+
+
+@functools.lru_cache
+def map_editable_project_locations() -> dict[str, str]:
+    """
+    Get a mapping of (normalized) editable distribution names to their
+    locations.
+    """
+    return dict(_iter_editable_project_locations())
+
+
+class PackageMetadata(TypedDict, total=False):
     name: str
     version: str
     editable_project_location: str
 
 
-def _iter_editable_distribution_locations() -> Iterable[tuple[str, str]]:
-    metadata: _EditablePackageMetadata
-    for metadata in json.loads(
-        check_output(
-            (
-                sys.executable,
-                "-m",
-                "pip",
-                "list",
-                "--editable",
-                "--format=json",
-            )
+def _iter_pip_list() -> Iterable[tuple[str, PackageMetadata]]:
+    uv: str | None = shutil.which("uv")
+    command: tuple[str, ...]
+    if uv:
+        command = (
+            uv,
+            "pip",
+            "list",
+            "--python",
+            sys.executable,
+            "--format=json",
         )
-    ):
+    else:
+        # If `uv` is not available, use `pip`
+        command = (
+            sys.executable,
+            "-m",
+            "pip",
+            "list",
+            "--format=json",
+        )
+    metadata: PackageMetadata
+    for metadata in json.loads(check_output(command)):
         yield (
             normalize_name(metadata["name"]),
-            metadata["editable_project_location"],
+            metadata,
         )
 
 
-@functools.lru_cache
-def get_editable_distributions_locations() -> dict[str, str]:
-    """
-    Get a mapping of (normalized) editable distribution names to their
-    locations.
-    """
-    return dict(_iter_editable_distribution_locations())
+@cache
+def map_pip_list() -> dict[str, PackageMetadata]:
+    return dict(_iter_pip_list())
 
 
 def cache_clear() -> None:
     """
     Clear distribution metadata caches
     """
+    map_pip_list.cache_clear()
     get_installed_distributions.cache_clear()
-    get_editable_distributions_locations.cache_clear()
+    map_editable_project_locations.cache_clear()
     is_editable.cache_clear()
     is_installed.cache_clear()
     get_requirement_string_distribution_name.cache_clear()
@@ -470,7 +537,7 @@ def refresh_editable_distributions() -> None:
     """
     name: str
     location: str
-    for name, location in get_editable_distributions_locations().items():
+    for name, location in map_editable_project_locations().items():
         _install_requirement_string(location, name=name, editable=True)
 
 
@@ -482,7 +549,13 @@ def get_installed_distributions() -> dict[str, Distribution]:
     refresh_editable_distributions()
     installed: dict[str, Distribution] = {}
     for distribution in _get_distributions():
-        installed[normalize_name(distribution.metadata["Name"])] = distribution
+        name: str = distribution.metadata["Name"]
+        if distribution.version is None:
+            # If no version can be found, use pip to find the version
+            distribution.metadata["Version"] = (
+                map_pip_list().get(name, {}).get("version")
+            )
+        installed[normalize_name(name)] = distribution
     return installed
 
 
@@ -751,7 +824,7 @@ def is_editable(name: str) -> bool:
     """
     Return `True` if the indicated distribution is an editable installation.
     """
-    return bool(normalize_name(name) in get_editable_distributions_locations())
+    return bool(normalize_name(name) in map_editable_project_locations())
 
 
 def _get_setup_cfg_metadata(path: str, key: str) -> str:
@@ -880,7 +953,7 @@ def _setup_location(
 
 
 def get_editable_distribution_location(name: str) -> str:
-    return get_editable_distributions_locations().get(normalize_name(name), "")
+    return map_editable_project_locations().get(normalize_name(name), "")
 
 
 def setup_egg_info(directory: str | Path, egg_base: str = "") -> None:
@@ -975,6 +1048,10 @@ def _get_requirement_name(requirement: Requirement) -> str:
     return normalize_name(requirement.name)
 
 
+@deprecated(
+    "dependence._utilities.install_requirement is deprecated and will be "
+    "removed in a future release."
+)
 def install_requirement(requirement: str | Requirement) -> None:
     """
     Install a requirement
@@ -1000,21 +1077,44 @@ def _install_requirement_string(
     Install a requirement string with no dependencies, compilation, build
     isolation, etc.
     """
-    command: tuple[str, ...] = (
-        sys.executable,
-        "-m",
-        "pip",
-        "install",
-        "--no-deps",
-        "--no-compile",
-    )
-    if editable:
-        command += (
-            "-e",
-            requirement_string,
+    command: tuple[str, ...]
+    uv: str | None = shutil.which("uv")
+    if uv:
+        command = (
+            uv,
+            "pip",
+            "install",
+            "--python",
+            sys.executable,
+            "--no-deps",
+            "--no-compile",
+            *(
+                (
+                    "-e",
+                    requirement_string,
+                )
+                if editable
+                else (requirement_string,)
+            ),
         )
     else:
-        command += (requirement_string,)
+        # If `uv` is not available, use `pip`
+        command = (
+            sys.executable,
+            "-m",
+            "pip",
+            "install",
+            "--no-deps",
+            "--no-compile",
+            *(
+                (
+                    "-e",
+                    requirement_string,
+                )
+                if editable
+                else (requirement_string,)
+            ),
+        )
     try:
         check_output(command)
     except CalledProcessError as error:
@@ -1079,31 +1179,15 @@ def _install_requirement(
     cache_clear()
 
 
-def _get_requirement_distribution(
-    requirement: Requirement,
+def _get_installed_distribution(
     name: str,
-    *,
-    reinstall: bool = True,
-    echo: bool = False,
 ) -> Distribution | None:
     if name in _BUILTIN_DISTRIBUTION_NAMES:
         return None
     try:
         return get_installed_distributions()[name]
     except KeyError:
-        if not reinstall:
-            raise
-        if echo:
-            warn(
-                f'The required distribution "{name}" was not installed, '
-                "attempting to install it now...",
-                stacklevel=2,
-            )
-        # Attempt to install the requirement...
-        install_requirement(requirement)
-        return _get_requirement_distribution(
-            requirement, name, reinstall=False, echo=echo
-        )
+        return None
 
 
 def _iter_distribution_requirements(
@@ -1140,9 +1224,7 @@ def _iter_requirement_names(
     # Ensure we don't follow the same requirement again, causing cyclic
     # recursion
     exclude.add(name)
-    distribution: Distribution | None = _get_requirement_distribution(
-        requirement, name, echo=echo
-    )
+    distribution: Distribution | None = _get_installed_distribution(name)
     if distribution is None:
         return ()
     requirements: tuple[Requirement, ...] = tuple(

dependence/freeze.py

@@ -5,8 +5,6 @@ import os
 from collections.abc import Iterable, MutableSet
 from fnmatch import fnmatch
 from functools import partial
-from importlib.metadata import Distribution
-from importlib.metadata import distribution as _get_distribution
 from itertools import chain
 from pathlib import Path
 from typing import TYPE_CHECKING, cast
@@ -15,7 +13,6 @@ from dependence._utilities import (
     get_distribution,
     get_required_distribution_names,
     get_requirement_string_distribution_name,
-    install_requirement,
     iter_configuration_file_requirement_strings,
     iter_configuration_files,
     iter_distinct,
@@ -23,6 +20,9 @@ from dependence._utilities import (
     normalize_name,
 )
 
+if TYPE_CHECKING:
+    from importlib.metadata import Distribution
+
 _DO_NOT_PIN_DISTRIBUTION_NAMES: MutableSet[str] = {
     "importlib-metadata",
     "importlib-resources",
@@ -218,7 +218,7 @@ def _iter_frozen_requirements(
     no_version: Iterable[str] = (),
     depth: int | None = None,
 ) -> Iterable[str]:
-    def get_requirement_string(distribution_name: str) -> str:
+    def get_requirement_string(distribution_name: str) -> str | None:
         def distribution_name_matches_pattern(pattern: str) -> bool:
             return fnmatch(distribution_name, pattern)
 
@@ -230,9 +230,11 @@ def _iter_frozen_requirements(
         try:
             distribution = get_distribution(distribution_name)
         except KeyError:
+            # If the distribution is not installed, skip it
+            return None
             # If the distribution is missing, install it
-            install_requirement(distribution_name)
-            distribution = _get_distribution(distribution_name)
+            # install_requirement(distribution_name)
+            # distribution = _get_distribution(distribution_name)
         return f"{distribution.metadata['Name']}=={distribution.version}"
 
     def get_required_distribution_names_(
@@ -267,7 +269,7 @@ def _iter_frozen_requirements(
             )
         ),
     )
-    return map(get_requirement_string, requirements)
+    return filter(None, map(get_requirement_string, requirements))
 
 
 def freeze(

dependence/update.py

@@ -133,12 +133,17 @@ def _get_updated_requirement_string(
         return requirement_string
     try:
         distribution: Distribution = get_installed_distributions()[name]
+        if distribution.version is None:
+            return requirement_string
         _update_requirement_specifiers(requirement, distribution.version)
     except KeyError:
         # If the requirement isn't installed, we can't update the version
         pass
     except TypeError as error:
-        message = f"Unable to determine installed version for {requirement}"
+        message: str = (
+            f"Unable to determine installed version for {requirement_string}: "
+            f"{distribution!r}"
+        )
         raise ValueError(message) from error
     return str(requirement)
 

{dependence-1.1.2.dist-info → dependence-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dependence
-Version: 1.1.2
+Version: 1.2.0
 Summary: A dependency management tool for python projects
 Project-URL: Documentation, https://dependence.enorganic.org
 Project-URL: Repository, https://github.com/enorganic/dependence

dependence-1.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+dependence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dependence/__main__.py,sha256=zk67MINE1FpsBcXDDvRiHQwmO7_4iay_Rkq3JTPrha4,1802
+dependence/_utilities.py,sha256=-9RGMsQKzaA-fEDswdXSx1LAVKdasWuKQGl7jgTeZXs,38960
+dependence/freeze.py,sha256=dW3m2zEf2l61GWKdQTgrvj8FCDINU6GahmKr5ViIKX4,16226
+dependence/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dependence/update.py,sha256=043Hsj8bQJypJ_p_dxSl8HXBwlGoUK238OFYThTWVos,20856
+dependence/upgrade.py,sha256=lNovLvKhxiczZAJj2_hHrbkDscNOTrx1xaOhmobVNSI,7747
+dependence-1.2.0.dist-info/METADATA,sha256=gdt6DNV_0GX-ZSZppXZKePSORAiweGYy2CYJQfIifA0,8364
+dependence-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dependence-1.2.0.dist-info/entry_points.txt,sha256=NStO_B0D81ObVYr9zDs6LCy0whm0a8KCiiFHMmTwOVE,56
+dependence-1.2.0.dist-info/RECORD,,

dependence-1.1.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-dependence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dependence/__main__.py,sha256=zk67MINE1FpsBcXDDvRiHQwmO7_4iay_Rkq3JTPrha4,1802
-dependence/_utilities.py,sha256=CxIl7BkoTqMtrOsJzq544_RDa8-QtZufKj31PazIBFI,36790
-dependence/freeze.py,sha256=MMv7_feEXfRo8cxyrgK0su17k1k8uLXWwpRCvrj-vz8,16184
-dependence/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dependence/update.py,sha256=QLe6sx39PKM3x6TxMzQxTUPDSKn8d7UizIVpbqMZuJI,20707
-dependence/upgrade.py,sha256=lNovLvKhxiczZAJj2_hHrbkDscNOTrx1xaOhmobVNSI,7747
-dependence-1.1.2.dist-info/METADATA,sha256=XhMrXo14In72SHqOStXK0bn8NVEm4XqWkbGBWOyUCUo,8364
-dependence-1.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dependence-1.1.2.dist-info/entry_points.txt,sha256=NStO_B0D81ObVYr9zDs6LCy0whm0a8KCiiFHMmTwOVE,56
-dependence-1.1.2.dist-info/RECORD,,