ducktools-pythonfinder 0.7.1__tar.gz → 0.7.3__tar.gz

{ducktools_pythonfinder-0.7.1/src/ducktools_pythonfinder.egg-info → ducktools_pythonfinder-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ducktools-pythonfinder
-Version: 0.7.1
+Version: 0.7.3
 Summary: Cross platform tool to find available python installations
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-pythonfinder

ducktools_pythonfinder-0.7.3/scripts/list_python_venvs.py

@@ -0,0 +1,120 @@
+# ducktools-pythonfinder
+# MIT License
+# 
+# Copyright (c) 2013-2014 David C Ellis
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+from __future__ import annotations
+
+import sys
+
+if sys.version_info < (3, 12):
+    raise RuntimeError("This script requires Python 3.12 or newer.")
+
+from collections.abc import Iterable, Callable, Generator
+from pathlib import Path
+
+from ducktools.classbuilder.prefab import Prefab
+from ducktools.pythonfinder.venv import get_python_venvs
+
+
+# Taken from ducktools-env's main
+def get_columns(
+    *,
+    data: Iterable,
+    headings: list[str],
+    attributes: list[str],
+    getter: Callable[[object, str], str] = getattr,
+) -> Generator[str]:
+    """
+    A helper function to generate a table to print with correct column widths
+
+    :param data: input data
+    :param headings: headings for the top of the table
+    :param attributes: attribute names to use for each column
+    :param getter: attribute getter function (ex: getattr, dict.get)
+    :return: Generator of column lines
+    """
+    if len(headings) != len(attributes):
+        raise TypeError("Must be the same number of headings as attributes")
+
+    widths = {
+        f"{attrib}": len(head) for attrib, head in zip(attributes, headings)
+    }
+
+    data_rows = []
+    for d in data:
+        row = []
+        for attrib in attributes:
+            d_text = f"{getter(d, attrib)}"
+            d_len = len(d_text)
+            widths[f"{attrib}"] = max(widths[attrib], d_len)
+            row.append(d_text)
+        data_rows.append(row)
+
+    yield (
+        "| "
+        + " | ".join(f"{head:<{widths[attrib]}}"
+                     for head, attrib in zip(headings, attributes))
+        + " |"
+    )
+    yield (
+        "| "
+        + " | ".join("-" * widths[attrib]
+                     for attrib in attributes)
+        + " |"
+    )
+
+    for row in data_rows:
+        yield (
+            "| "
+            + " | ".join(f"{item:<{widths[attrib]}}"
+                         for item, attrib in zip(row, attributes))
+            + " |"
+        )
+
+
+class DisplayVEnv(Prefab):
+    version: str
+    path: str
+    parent_path: str
+
+
+def get_all_venvs():
+    cwd = Path.cwd()
+
+    venvs = get_python_venvs(recursive=True, search_parent_folders=True)
+    venv_data = [
+        DisplayVEnv(
+            version=venv.version_str,
+            path=str(Path(venv.folder).relative_to(cwd, walk_up=True)),
+            parent_path=venv.parent_path,
+        )
+        for venv in venvs
+    ]
+
+    headings = ["Version", "Path", "Base Runtime"]
+    attribs = ["version", "path", "parent_path"]
+
+    for row in get_columns(data=venv_data, headings=headings, attributes=attribs, getter=getattr):
+        print(row)
+
+
+if __name__ == "__main__":
+    get_all_venvs()

ducktools_pythonfinder-0.7.3/src/ducktools/pythonfinder/_version.py

@@ -0,0 +1,2 @@
+__version__ = "0.7.3"
+__version_tuple__ = (0, 7, 3)

{ducktools_pythonfinder-0.7.1 → ducktools_pythonfinder-0.7.3}/src/ducktools/pythonfinder/venv.py

@@ -22,6 +22,11 @@
 # SOFTWARE.
 from __future__ import annotations
 
+try:
+    from _collections_abc import Iterable
+except ImportError:
+    from collections.abc import Iterable
+
 import os
 import sys
 
@@ -103,7 +108,7 @@ class PythonVEnv(Prefab):
 
         return install
 
-    def list_packages(self):
+    def list_packages(self) -> list[PythonPackage]:
         if not self.parent_exists:
             raise FileNotFoundError(
                 f"Parent Python at \"{self.parent_executable}\" does not exist."
@@ -138,17 +143,17 @@ class PythonVEnv(Prefab):
         return packages
 
     @classmethod
-    def from_cfg(cls, cfg_path):
+    def from_cfg(cls, cfg_path: str | os.PathLike) -> PythonVEnv:
         """
         Get a PythonVEnv instance from the path to a config file
 
-        :param cfg_path:
-        :return:
+        :param cfg_path: Path to a virtualenv config file
+        :return: PythonVEnv with details relative to that config file
         """
         parent_path, version_str = None, None
-        venv_base = cfg_path.parent
+        venv_base = os.path.dirname(cfg_path)
 
-        with cfg_path.open() as f:
+        with open(cfg_path, 'r') as f:
             for line in f:
                 key, value = (item.strip() for item in line.split("="))
 
@@ -192,15 +197,20 @@ class PythonVEnv(Prefab):
             folder=venv_base,
             executable=venv_exe,
             version=version_tuple,
-            parent_path=parent_path
+            parent_path=parent_path,
         )
 
 
-def get_python_venvs(base_dir=None, recursive=False, search_parent_folders=False):
+def get_python_venvs(
+    base_dir: str | os.PathLike | None = None,
+    recursive: bool = False,
+    search_parent_folders: bool = False
+) -> Iterable[PythonVEnv]:
     """
     Yield discoverable python virtual environment information
 
-    If recursive=True then search_parent_folders is ignored.
+    If recursive=True and search_parent_folders=True *only* the current working
+    directory will be searched recursively. Parent folders will not be searched recursively
 
     If you're in a project directory and are looking for a potential venv
     search_parent_folders=True will search parents and yield installs discovered.
@@ -215,36 +225,40 @@ def get_python_venvs(base_dir=None, recursive=False, search_parent_folders=False
     """
     base_dir = _laz.Path.cwd() if base_dir is None else _laz.Path(base_dir)
 
-    search_folders = [base_dir]
+    cwd_pattern = pattern = f"*/{VENV_CONFIG_NAME}"
 
-    # Recursive searches don't also search parent folders.
     if recursive:
-        pattern = f"**/{VENV_CONFIG_NAME}"
-    else:
-        pattern = f"*/{VENV_CONFIG_NAME}"
-        if search_parent_folders:
-            search_folders.extend(base_dir.parents)
+        # Only search cwd recursively, parents are searched non-recursively
+        cwd_pattern = "*" + pattern
 
-    for f in search_folders:
+    for conf in base_dir.glob(cwd_pattern):
         try:
-            for conf in f.glob(pattern):
-                try:
-                    env = PythonVEnv.from_cfg(conf)
-                except InvalidVEnvError:
+            env = PythonVEnv.from_cfg(conf)
+        except InvalidVEnvError:
+            continue
+        yield env
+
+    if search_parent_folders:
+        # Search parent folders
+        for fld in base_dir.parents:
+            try:
+                for conf in fld.glob(pattern):
+                    try:
+                        env = PythonVEnv.from_cfg(conf)
+                    except InvalidVEnvError:
+                        continue
+                    yield env
+            except OSError as e:
+                # MacOS can error on searching up folders with an invalid argument
+                # On Python 3.11 or earlier.
+                if e.errno == 22:
                     continue
 
-                yield env
-        except OSError as e:
-            # MacOS can error on searching up folders with an invalid argument
-            # On Python 3.11 or earlier.
-            if e.errno == 22:
-                continue
-
 
 def list_python_venvs(
-    base_dir=None,
-    recursive=False,
-    search_parent_folders=False,
+    base_dir: str | os.PathLike | None = None,
+    recursive: bool = False,
+    search_parent_folders: bool = False,
 ) -> list[PythonVEnv]:
     """
     Get a list of discoverable python virtual environment information

{ducktools_pythonfinder-0.7.1 → ducktools_pythonfinder-0.7.3/src/ducktools_pythonfinder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ducktools-pythonfinder
-Version: 0.7.1
+Version: 0.7.3
 Summary: Cross platform tool to find available python installations
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-pythonfinder

{ducktools_pythonfinder-0.7.1 → ducktools_pythonfinder-0.7.3}/src/ducktools_pythonfinder.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ README.md
 pyproject.toml
 scripts/build_zipapp.py
 scripts/detail_this_python.py
+scripts/list_python_venvs.py
 scripts/print_python_versions.py
 src/ducktools/pythonfinder/__init__.py
 src/ducktools/pythonfinder/__main__.py

{ducktools_pythonfinder-0.7.1 → ducktools_pythonfinder-0.7.3}/tests/test_venv_finder.py

@@ -76,6 +76,13 @@ def test_local_found(with_venvs):
     assert os.path.samefile(venvs[0].folder, os.path.join(with_venvs, ".venv"))
 
 
+def test_parent_not_always_searched(with_venvs):
+    venvs = list_python_venvs(base_dir=os.path.join(with_venvs, "subfolder"), search_parent_folders=False)
+
+    assert len(venvs) == 1
+    assert os.path.samefile(venvs[0].folder, os.path.join(with_venvs, "subfolder/.venv"))
+
+
 def test_found_in_parent(with_venvs):
     venvs = list_python_venvs(base_dir=os.path.join(with_venvs, "subfolder"), search_parent_folders=True)
 
@@ -95,6 +102,22 @@ def test_all_found(with_venvs):
     assert os.path.samefile(venvs[2].folder, os.path.join(with_venvs, "subfolder/subsubfolder/env"))
 
 
+def test_recursive_parents(with_venvs):
+    venvs = sorted(
+        list_python_venvs(
+            base_dir=os.path.join(with_venvs, "subfolder"),
+            recursive=True,
+            search_parent_folders=True,
+        ),
+        key=lambda x: x.folder
+    )
+
+    assert len(venvs) == 3
+    assert os.path.samefile(venvs[0].folder, os.path.join(with_venvs, ".venv"))
+    assert os.path.samefile(venvs[1].folder, os.path.join(with_venvs, "subfolder/.venv"))
+    assert os.path.samefile(venvs[2].folder, os.path.join(with_venvs, "subfolder/subsubfolder/env"))
+
+
 def test_found_parent(with_venvs, this_python, this_venv):
     venv_ex = list_python_venvs(base_dir=with_venvs, recursive=False)[0]
 

ducktools_pythonfinder-0.7.1/src/ducktools/pythonfinder/_version.py

@@ -1,2 +0,0 @@
-__version__ = "0.7.1"
-__version_tuple__ = (0, 7, 1)