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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ducktools-pythonfinder
-Version: 0.6.8
+Version: 0.7.1
 Summary: Cross platform tool to find available python installations
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-pythonfinder
@@ -124,6 +124,17 @@ PythonInstall(version=(3, 8, 10, 'final', 0), executable='~\\.pyenv\\pyenv-win\\
 PythonInstall(version=(3, 13, 0, 'candidate', 1), executable='~\\.pyenv\\pyenv-win\\versions\\3.13.0rc1\\python.exe', architecture='64bit', implementation='cpython', metadata={}, shadowed=False)```
 ```
 
+### Finding venvs ###
+
+There is now a submodule to search for virtual environments.
+
+```python
+from ducktools.pythonfinder.venv import list_python_venvs
+
+for venv in list_python_venvs():
+    print(venv.executable)
+```
+
 ### Python.org search ###
 
 Python.org searches are handled by the `ducktools.pythonfinder.pythonorg_search` module.

{ducktools_pythonfinder-0.6.8 → ducktools_pythonfinder-0.7.1}/README.md

@@ -96,6 +96,17 @@ PythonInstall(version=(3, 8, 10, 'final', 0), executable='~\\.pyenv\\pyenv-win\\
 PythonInstall(version=(3, 13, 0, 'candidate', 1), executable='~\\.pyenv\\pyenv-win\\versions\\3.13.0rc1\\python.exe', architecture='64bit', implementation='cpython', metadata={}, shadowed=False)```
 ```
 
+### Finding venvs ###
+
+There is now a submodule to search for virtual environments.
+
+```python
+from ducktools.pythonfinder.venv import list_python_venvs
+
+for venv in list_python_venvs():
+    print(venv.executable)
+```
+
 ### Python.org search ###
 
 Python.org searches are handled by the `ducktools.pythonfinder.pythonorg_search` module.

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

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

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

@@ -0,0 +1,265 @@
+# 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 os
+import sys
+
+
+from ducktools.classbuilder.prefab import Prefab
+from ducktools.lazyimporter import LazyImporter, FromImport, ModuleImport
+
+from .shared import (
+    PythonInstall,
+    get_install_details,
+    version_str_to_tuple,
+    version_tuple_to_str,
+)
+
+
+_laz = LazyImporter(
+    [
+        ModuleImport("re"),
+        ModuleImport("json"),
+        FromImport("pathlib", "Path"),
+        FromImport("subprocess", "run"),
+    ]
+)
+
+VENV_CONFIG_NAME = "pyvenv.cfg"
+
+
+# VIRTUALENV can make some invalid regexes that are just the tuple with dots.
+VIRTUALENV_PY_VER_RE = (
+    r"(?P<major>\d+)\.(?P<minor>\d+)\.?(?P<micro>\d*)\.(?P<releaselevel>.+)\.(?P<serial>\d*)?"
+)
+
+
+class InvalidVEnvError(Exception):
+    pass
+
+
+class PythonPackage(Prefab):
+    name: str
+    version: str
+
+
+class PythonVEnv(Prefab):
+    folder: str
+    executable: str
+    version: tuple[int, int, int, str, int]
+    parent_path: str
+
+    @property
+    def version_str(self) -> str:
+        return version_tuple_to_str(self.version)
+
+    @property
+    def parent_executable(self) -> str:
+        if sys.platform == "win32":
+            return os.path.join(self.parent_path, "python.exe")
+        else:
+            return os.path.join(self.parent_path, "python")
+
+    @property
+    def parent_exists(self) -> bool:
+        return os.path.exists(self.parent_executable)
+
+    def get_parent_install(self, cache: list[PythonInstall] | None = None) -> PythonInstall | None:
+        install = None
+        cache = [] if cache is None else cache
+
+        if self.parent_exists:
+            exe = self.parent_executable
+
+            # Python installs may be cached, can skip querying exe.
+            for inst in cache:
+                if os.path.samefile(inst.executable, exe):
+                    install = inst
+                    break
+
+            if install is None:
+                install = get_install_details(exe)
+
+        return install
+
+    def list_packages(self):
+        if not self.parent_exists:
+            raise FileNotFoundError(
+                f"Parent Python at \"{self.parent_executable}\" does not exist."
+            )
+
+        # Should probably use sys.executable and have pip as a dependency
+        # We would need to look at possibly changing how ducktools-env works for that however.
+
+        data = _laz.run(
+            [
+                self.parent_executable,
+                "-m", "pip",
+                "--python", self.executable,
+                "list",
+                "--format", "json"
+            ],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+
+        raw_packages = _laz.json.loads(data.stdout)
+
+        packages = [
+            PythonPackage(
+                name=p["name"],
+                version=p["version"],
+            )
+            for p in raw_packages
+        ]
+
+        return packages
+
+    @classmethod
+    def from_cfg(cls, cfg_path):
+        """
+        Get a PythonVEnv instance from the path to a config file
+
+        :param cfg_path:
+        :return:
+        """
+        parent_path, version_str = None, None
+        venv_base = cfg_path.parent
+
+        with cfg_path.open() as f:
+            for line in f:
+                key, value = (item.strip() for item in line.split("="))
+
+                if key == "home":
+                    parent_path = value
+                elif key in {"version", "version_info"}:
+                    # venv and uv use different key names :)
+                    version_str = value
+
+                if parent_path and version_str:
+                    break
+            else:
+                # Not a valid venv, ignore
+                raise InvalidVEnvError(f"Path and version not defined in {cfg_path}")
+
+        if sys.platform == "win32":
+            venv_exe = os.path.join(venv_base, "Scripts", "python.exe")
+        else:
+            venv_exe = os.path.join(venv_base, "bin", "python")
+
+        try:
+            version_tuple = version_str_to_tuple(version_str)
+        except ValueError:  # pragma: no cover
+            # Might be virtualenv putting in incorrect versions
+            parsed_version = _laz.re.fullmatch(VIRTUALENV_PY_VER_RE, version_str)
+            if parsed_version:
+                major, minor, micro, releaselevel, serial = parsed_version.groups()
+                version_tuple = (
+                    int(major),
+                    int(minor),
+                    int(micro) if micro else 0,
+                    releaselevel,
+                    int(serial if serial != "" else 0),
+                )
+            else:
+                raise InvalidVEnvError(
+                    f"Could not determine version from venv version string {version_str}"
+                )
+
+        return cls(
+            folder=venv_base,
+            executable=venv_exe,
+            version=version_tuple,
+            parent_path=parent_path
+        )
+
+
+def get_python_venvs(base_dir=None, recursive=False, search_parent_folders=False):
+    """
+    Yield discoverable python virtual environment information
+
+    If recursive=True then search_parent_folders is ignored.
+
+    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.
+
+    If you're in a folder of source trees and want to find venvs inside any subfolders
+    then use recursive=True.
+
+    :param base_dir: Base directory to search venvs
+    :param recursive: Also check subfolders of the base directory
+    :param search_parent_folders: Also search parent folders
+    :yield: PythonVEnv details.
+    """
+    base_dir = _laz.Path.cwd() if base_dir is None else _laz.Path(base_dir)
+
+    search_folders = [base_dir]
+
+    # 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)
+
+    for f in search_folders:
+        try:
+            for conf in f.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
+
+
+def list_python_venvs(
+    base_dir=None,
+    recursive=False,
+    search_parent_folders=False,
+) -> list[PythonVEnv]:
+    """
+    Get a list of discoverable python virtual environment information
+
+    If recursive=True then search_parent_folders is ignored.
+
+    :param base_dir: Base directory to search venvs
+    :param recursive: Also check subfolders of the base directory
+    :param search_parent_folders: Also search parent folders
+    :returns: List of Python VEnv details.
+    """
+    return list(
+        get_python_venvs(
+            base_dir=base_dir,
+            recursive=recursive,
+            search_parent_folders=search_parent_folders,
+        )
+    )

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ducktools-pythonfinder
-Version: 0.6.8
+Version: 0.7.1
 Summary: Cross platform tool to find available python installations
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-pythonfinder
@@ -124,6 +124,17 @@ PythonInstall(version=(3, 8, 10, 'final', 0), executable='~\\.pyenv\\pyenv-win\\
 PythonInstall(version=(3, 13, 0, 'candidate', 1), executable='~\\.pyenv\\pyenv-win\\versions\\3.13.0rc1\\python.exe', architecture='64bit', implementation='cpython', metadata={}, shadowed=False)```
 ```
 
+### Finding venvs ###
+
+There is now a submodule to search for virtual environments.
+
+```python
+from ducktools.pythonfinder.venv import list_python_venvs
+
+for venv in list_python_venvs():
+    print(venv.executable)
+```
+
 ### Python.org search ###
 
 Python.org searches are handled by the `ducktools.pythonfinder.pythonorg_search` module.

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

@@ -12,6 +12,7 @@ src/ducktools/pythonfinder/_version.py
 src/ducktools/pythonfinder/details_script.py
 src/ducktools/pythonfinder/pythonorg_search.py
 src/ducktools/pythonfinder/shared.py
+src/ducktools/pythonfinder/venv.py
 src/ducktools/pythonfinder/darwin/__init__.py
 src/ducktools/pythonfinder/linux/__init__.py
 src/ducktools/pythonfinder/linux/pyenv_search.py
@@ -31,6 +32,7 @@ tests/test_orgsearch.py
 tests/test_pyenv.py
 tests/test_shared.py
 tests/test_uv_finder.py
+tests/test_venv_finder.py
 tests/sources/python_versions.txt
 tests/sources/release.json
 tests/sources/release_file.json

{ducktools_pythonfinder-0.6.8 → ducktools_pythonfinder-0.7.1}/tests/conftest.py

@@ -20,11 +20,14 @@
 # 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.
+import sys
+
 from pathlib import Path
 
 import pytest
 
 from ducktools.pythonfinder import details_script
+from ducktools.pythonfinder.shared import get_install_details
 
 
 @pytest.fixture(scope="session")
@@ -37,6 +40,26 @@ def uses_details_script(fs):
     fs.add_real_file(details_script.__file__)
 
 
+@pytest.fixture(scope="session")
+def this_python():
+    if sys.platform == "win32":
+        py_exe = Path(sys.base_prefix) / "python.exe"
+    else:
+        py_exe = Path(sys.base_prefix) / "bin" / "python"
+
+    return get_install_details(str(py_exe))
+
+
+@pytest.fixture(scope="session")
+def this_venv():
+    if sys.platform == "win32":
+        exe = sys.executable
+    else:
+        exe = str(Path(sys.executable).with_name("python"))
+    venv = get_install_details(exe)
+    return venv
+
+
 def pytest_addoption(parser):
     parser.addoption(
         "--run-uv-python",

ducktools_pythonfinder-0.7.1/tests/test_venv_finder.py

@@ -0,0 +1,125 @@
+# 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.
+import os
+import subprocess
+import sys
+import tempfile
+
+from ducktools.pythonfinder.venv import list_python_venvs
+
+import pytest
+
+
+@pytest.fixture(scope="module")
+def with_venvs():
+    with tempfile.TemporaryDirectory() as tmpdir:
+        # We can't actually use venv directly here as
+        # Older python on linux makes invalid venvs
+        if sys.platform == "win32":
+            python_exe = os.path.join(sys.base_prefix, "python.exe")
+        else:
+            python_exe = os.path.join(sys.base_prefix, "bin", "python")
+
+        def make_venv(pth):
+            subprocess.run(
+                [
+                    python_exe,
+                    "-m", "venv",
+                    "--without-pip",
+                    os.path.join(tmpdir, pth),
+                ],
+                check=True,
+                capture_output=True
+            )
+
+        make_venv(".venv")
+        make_venv("subfolder/.venv")
+        make_venv("subfolder/subsubfolder/env")
+
+        assert os.path.exists(os.path.join(tmpdir, ".venv"))
+
+        yield tmpdir
+
+
+def test_no_venvs():
+    # Don't use the venv directory here
+    with tempfile.TemporaryDirectory() as tmpdir:
+        venvs = list_python_venvs(base_dir=tmpdir)
+
+    assert len(venvs) == 0
+
+
+def test_local_found(with_venvs):
+    venvs = list_python_venvs(base_dir=with_venvs, recursive=False)
+
+    assert len(venvs) == 1
+    assert os.path.samefile(venvs[0].folder, os.path.join(with_venvs, ".venv"))
+
+
+def test_found_in_parent(with_venvs):
+    venvs = list_python_venvs(base_dir=os.path.join(with_venvs, "subfolder"), search_parent_folders=True)
+
+    assert os.path.samefile(venvs[0].folder, os.path.join(with_venvs, "subfolder/.venv"))
+    assert os.path.samefile(venvs[1].folder, os.path.join(with_venvs, ".venv"))
+
+
+def test_all_found(with_venvs):
+    venvs = sorted(
+        list_python_venvs(base_dir=with_venvs, recursive=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]
+
+    assert os.path.samefile(this_python.executable, venv_ex.parent_executable)
+
+    # We found the base env that created this python, all details match
+    parent = venv_ex.get_parent_install()
+    assert parent == this_python
+
+    # venv version str works same as parent
+    assert venv_ex.version_str == parent.version_str
+
+
+def test_found_parent_cache(with_venvs, this_python):
+    venv_ex = list_python_venvs(base_dir=with_venvs, recursive=False)[0]
+
+    parent = venv_ex.get_parent_install(cache=[this_python])
+    assert parent == this_python
+
+
+def test_empty_packages(with_venvs):
+    venv_ex = list_python_venvs(base_dir=with_venvs, recursive=False)[0]
+
+    assert os.path.exists(venv_ex.parent_executable)
+    assert os.path.exists(venv_ex.executable)
+
+    packages = venv_ex.list_packages()
+    assert packages == []

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

@@ -1,2 +0,0 @@
-__version__ = "0.6.8"
-__version_tuple__ = (0, 6, 8)