pydepinject 0.0.1.dev0__py3-none-any.whl

pydepinject/__init__.py

@@ -0,0 +1,203 @@
+from __future__ import annotations
+
+import functools
+import hashlib
+import logging
+import os
+import pathlib
+import shutil
+import subprocess
+import sys
+import tempfile
+import typing
+import venv
+
+if typing.TYPE_CHECKING:
+    from collections.abc import Callable
+    from types import TracebackType
+    from typing import Any
+
+
+VERSION = "0.0.1dev"
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+
+VENV_ROOT = pathlib.Path(tempfile.gettempdir()) / __name__.split(".")[0] / "venvs"
+logger.debug("VENV_ROOT: %s", VENV_ROOT)
+
+
+def is_requirements_satisfied(*packages: str):
+    """Check if the requirements are already satisfied. Return None if it cannot be determined."""
+    try:
+        if "pkg_resources" in sys.modules:
+            del sys.modules["pkg_resources"]
+        import pkg_resources
+    except ImportError:
+        logger.debug(
+            "pkg_resources not found. Cannot check if requirements are satisfied."
+        )
+        return None
+
+    try:
+        for package in packages:
+            logger.debug("Checking package: %s", package)
+            req = pkg_resources.Requirement.parse(package)
+            pkg_resources.require(str(req))
+            logger.debug("Requirement %s is satisfied", package)
+        return True
+    except (pkg_resources.DistributionNotFound, pkg_resources.VersionConflict):
+        logger.debug("Requirements %s are not satisfied. Return False", packages)
+        return False
+
+
+class RequirementManager:
+    """A decorator and context manager to manage Python package requirements."""
+
+    def __init__(
+        self,
+        *packages: str,
+        venv_name: str | None = None,
+        venv_root: pathlib.Path = VENV_ROOT,
+        recreate: bool = False,
+        ephemeral: bool = False,
+    ):
+        """Initialize the RequirementManager.
+
+        Args:
+            *packages: A list of package requirements.
+            venv_name: The name of the virtual environment. If not provided,
+                a unique name will be generated based on the package requirements.
+            venv_root: The root directory for virtual environments.
+            recreate: If True, the virtual environment will be recreated if it exists.
+            ephemeral: If True, the virtual environment will be deleted after use.
+        """
+        self.packages = packages
+        self.venv_name = venv_name
+        self.original_pythonpath = os.environ.get("PYTHONPATH", "")
+        self.original_path = os.environ.get("PATH", "")
+        self.original_syspath = sys.path.copy()
+        self._venv_path = venv_root / self.venv_name if self.venv_name else None
+        self._venv_root = venv_root
+        self.ephemeral = ephemeral
+        self.recreate = recreate
+        self._activated = False
+
+    @property
+    def venv_path(self):
+        if self._venv_path:
+            """Returns a path to the virtual environment. If not set, a unique path is generated."""
+            return self._venv_path
+        # Create a unique hash for the package requirements
+        reqs_str = ",".join(self.packages)
+        reqs_hash = hashlib.md5(reqs_str.encode()).hexdigest()
+
+        self._venv_path = self._venv_root / reqs_hash
+        return self._venv_path
+
+    def _create_virtualenv(self):
+        """Create a virtual environment if it does not exist."""
+        if self.venv_path.exists() and not self.recreate:
+            return
+        logger.debug("Creating virtualenv: %s", self.venv_path)
+        venv.create(str(self.venv_path), with_pip=True, clear=self.recreate)
+
+    def _install_packages(self):
+        logger.info("Installing packages: %s", self.packages)
+        pip_executable = pathlib.Path(self.venv_path) / "bin" / "pip"
+        pip_args = [
+            str(pip_executable),
+            "install",
+            "--quiet",
+            "--no-python-version-warning",
+            "--disable-pip-version-check",
+            *self.packages,
+        ]
+        logger.debug("Running command: %s", " ".join(pip_args))
+        subprocess.check_call(pip_args)
+
+    def _activate_venv(self):
+        if is_requirements_satisfied(*self.packages):
+            logger.debug(
+                "Requirements %s already satisfied. No need to create venv",
+                self.packages,
+            )
+            return self
+
+        self.original_pythonpath = os.environ.get("PYTHONPATH", "")
+        self.original_path = os.environ.get("PATH", "")
+        self.original_syspath = sys.path.copy()
+
+        self._create_virtualenv()
+
+        venv_site_packages = (
+            pathlib.Path(self.venv_path)
+            / "lib"
+            / f"python{sys.version_info.major}.{sys.version_info.minor}"
+            / "site-packages"
+        )
+        os.environ["PYTHONPATH"] = str(venv_site_packages) + (
+            os.pathsep + self.original_pythonpath if self.original_pythonpath else ""
+        )
+        os.environ["PATH"] = (
+            str(pathlib.Path(self.venv_path) / "bin") + os.pathsep + self.original_path
+        )
+        sys.path.insert(0, str(venv_site_packages))
+        self._activated = True
+        if is_requirements_satisfied(*self.packages):
+            logger.debug(
+                "Requirements %s already satisfied within %s",
+                self.packages,
+                self.venv_path,
+            )
+            return self
+        self._install_packages()
+
+    def _deactivate_venv(self):
+        if not self._activated:
+            return
+        os.environ["PATH"] = self.original_path
+        os.environ["PYTHONPATH"] = self.original_pythonpath
+        sys.path = self.original_syspath
+        # Cleanup imported cached modules from the temporary venv.
+        venv_imports: set[str] = set()
+        for name, module in sys.modules.items():
+            module_path = getattr(module, "__file__", None)
+            if module_path and pathlib.Path(module_path).is_relative_to(self.venv_path):
+                venv_imports.add(name)
+        for name in venv_imports:
+            del sys.modules[name]
+        self._activated = False
+        if self.ephemeral:
+            logger.debug("Deleting ephemeral venv: %s", self.venv_path)
+            shutil.rmtree(self.venv_path)
+
+    def __enter__(self):
+        self._activate_venv()
+        return self
+
+    def __exit__(
+        self,
+        exctype: type[BaseException] | None,
+        excinst: BaseException | None,
+        exctb: TracebackType | None,
+    ) -> None:
+        del exctype, excinst, exctb
+        self._deactivate_venv()
+
+    def __call__(self, func: Callable[..., Any] | None = None):
+        if func is None:
+            self._activate_venv()
+            return
+
+        @functools.wraps(func)
+        def wrapper(*args: Any, **kwargs: Any):
+            with self:
+                print("returning func()")
+                return func(*args, **kwargs)
+
+        return wrapper
+
+
+requires = RequirementManager

pydepinject-0.0.1.dev0.dist-info/LICENSE

@@ -0,0 +1,9 @@
+ The MIT License (MIT)
+
+Copyright © 2024 pydepinject
+
+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.

pydepinject-0.0.1.dev0.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: pydepinject
+Version: 0.0.1.dev0
+Summary: A package to dynamically inject requirements into a virtual environment.
+Author: pydepinject
+License: MIT
+Project-URL: homepage, https://github.com/pydepinject/pydepinject
+Project-URL: documentation, https://github.com/pydepinject/pydepinject
+Project-URL: repository, https://github.com/pydepinject/pydepinject
+Keywords: virtualenv,requirements,dependency management
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: build
+Requires-Dist: check-manifest ==0.49 ; extra == 'build'
+Requires-Dist: build ==1.2.1 ; extra == 'build'
+Requires-Dist: wheel ==0.43.0 ; extra == 'build'
+Requires-Dist: setuptools ==70.0.0 ; extra == 'build'
+Provides-Extra: lint
+Requires-Dist: ruff ==0.4.7 ; extra == 'lint'
+Requires-Dist: pyright ==1.1.365 ; extra == 'lint'
+Requires-Dist: isort ==5.13.2 ; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest ==8.2.1 ; extra == 'test'
+Requires-Dist: pytest-cov ==5.0.0 ; extra == 'test'
+
+# Requirement Manager
+
+This project provides a `RequirementManager` (`requires` is an alias) class to manage Python package requirements using virtual environments. It can be used as a decorator or context manager to ensure specific packages are installed and available during the execution of a function or code block.
+
+## Features
+
+- Automatically creates and manages virtual environments.
+- Checks if the required packages are already installed.
+- Installs packages if they are not already available.
+- Supports ephemeral virtual environments that are deleted after use.
+- Can be used as a decorator or context manager.
+
+## Installation
+
+`pip install pydepinject`
+
+
+## Usage
+
+### Decorator
+
+To use the `requires` as a decorator, simply decorate your function with the required packages:
+
+```python
+from pydepinject import requires
+
+
+@requires("requests", "numpy")
+def my_function():
+    import requests
+    import numpy as np
+    print(requests.__version__)
+    print(np.__version__)
+
+my_function()
+```
+
+### Context Manager
+
+You can also use the `requires` as a context manager:
+
+```python
+from pydepinject import requires
+
+
+with requires("requests", "numpy"):
+    import requests
+    import numpy as np
+    print(requests.__version__)
+    print(np.__version__)
+```
+
+### Reusable Virtual Environments
+
+The `requires` can create named virtual environments and reuse them across multiple functions or code blocks:
+
+```python
+@requires("requests", venv_name="myenv", ephemeral=False)
+def my_function():
+    import requests
+    print(requests.__version__)
+
+
+with requires("pylint", venv_name="myenv", ephemeral=False):
+    import pylint
+    print(pylint.__version__)
+    import requests  # This is also available here because it was installed in the same virtual environment
+    print(requests.__version__)
+```
+
+### Managing Virtual Environments
+
+The `requires` can automatically delete ephemeral virtual environments after use. This is useful when you want to ensure that the virtual environment is clean and does not persist after the function or code block completes:
+
+```python
+@requires("requests", venv_name="myenv", ephemeral=True)
+def my_function():
+    import requests
+    print(requests.__version__)
+
+my_function()
+```
+
+## Logging
+
+The `requires` uses the `logging` module to provide debug information. By default, it logs to the console at the DEBUG level. You can adjust the logging configuration as needed.
+
+## Unit Tests
+
+Unit tests are provided to verify the functionality of the `requires`. The tests use `pytest` and cover various scenarios including decorator usage, context manager usage, ephemeral environments, and more.
+
+### Running Tests
+
+To run the unit tests, ensure you have `pytest` installed, and then execute the following command:
+
+```bash
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

pydepinject-0.0.1.dev0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pydepinject/__init__.py,sha256=mjbRTs9SFE-Cmwn12hCABwdMb5z-Dz7DFuaTBxbMdTA,6856
+pydepinject-0.0.1.dev0.dist-info/LICENSE,sha256=Rwfkv5kSPGRiBn_2Cb7lNyo3Dvc02a5jqMmJnvgnW7s,1086
+pydepinject-0.0.1.dev0.dist-info/METADATA,sha256=xSRjvFHdi9HsMDqwUb_Ku8MYHgCuza2oCN21A1JjNok,4442
+pydepinject-0.0.1.dev0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pydepinject-0.0.1.dev0.dist-info/top_level.txt,sha256=VdrZmvJZGzKrHnAs17D7cBjpyIrE5HRVaQjPB13xHew,12
+pydepinject-0.0.1.dev0.dist-info/RECORD,,

pydepinject-0.0.1.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pydepinject-0.0.1.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pydepinject