nox-uv 0.3.0__tar.gz → 0.5.0__tar.gz

{nox_uv-0.3.0 → nox_uv-0.5.0}/.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on: [push, pull_request]
 
 env:
-  UV_VERSION: "0.6.12"
+  UV_VERSION: "0.7.12"
 
 jobs:
   test:
@@ -15,8 +15,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install uv
         uses: astral-sh/setup-uv@v5
-        # Caching is enabled by default for GitHub-hosted runners:
-        #   https://github.com/astral-sh/setup-uv?tab=readme-ov-file#enable-caching
         with:
           version: ${{ env.UV_VERSION }}
       - name: Set up Python ${{ matrix.python-version }}

nox_uv-0.5.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: nox-uv
+Version: 0.5.0
+Summary: Facilitate nox integration with uv for Python projects
+Project-URL: Homepage, https://github.com/dantebben/nox-uv
+Project-URL: Repository, https://github.com/dantebben/nox-uv
+Project-URL: Issues, https://github.com/dantebben/nox-uv/issues
+Author-email: Dan Tebben <dantebben@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: nox,uv
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: nox>=2025.05.01
+Description-Content-Type: text/markdown
+
+## Intro
+
+[![GitHub Actions][github-actions-badge]](https://github.com/dantebben/nox-uv/actions)
+[![PyPI version][pypi-version-badge]](https://pypi.python.org/pypi/nox-uv)
+[![Python versions][python-versions-badge]](https://pypi.python.org/pypi/nox-uv)
+[![uv][uv-badge]](https://github.com/astral-sh/uv)
+[![Nox][nox-badge]](https://github.com/wntrblm/nox)
+[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)
+[![Type checked with mypy][mypy-badge]](https://mypy-lang.org/)
+
+[github-actions-badge]: https://github.com/dantebben/nox-uv/workflows/CI/badge.svg
+[pypi-version-badge]: https://img.shields.io/pypi/v/nox-uv.svg
+[python-versions-badge]: https://img.shields.io/pypi/pyversions/nox-uv.svg
+[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
+[nox-badge]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[mypy-badge]: https://www.mypy-lang.org/static/mypy_badge.svg
+
+`nox-uv` is a simple drop-in replacement for [nox](https://nox.thea.codes/)'s `@nox.session` that installs
+dependencies constrained by [uv](https://docs.astral.sh/uv/)'s lockfile.
+
+## Usage
+
+Add `nox-uv` as a development dependency. The following example adds it into a `nox`
+`dependency-group`.
+
+```shell
+uv add --group nox nox-uv
+```
+
+Using the following configuration within `pyproject.toml` as an example:
+
+```toml
+[dependency-groups]
+nox = [
+    "nox-uv",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+type_check = [
+    "mypy",
+]
+lint = [
+    "ruff",
+]
+```
+
+Within, your `noxfile.py`:
+
+1. Import `session` from `nox_uv`.
+2. Set `venv_backend` to `"uv"`. This can be done globally using
+   `options.default_venv_backend = "uv"`.
+3. Use the new [`uv_*` parameters](#added-parameters) to `session` to control which dependencies
+   are synced into the session's virtual environment in addition to the project's main
+   dependencies.
+     - `uv sync` is used to install dependencies so that their versions are constrained by
+       `uv.lock`.
+
+```py
+from nox import Session, options
+from nox_uv import session
+
+options.default_venv_backend = "uv"
+
+
+@session(
+    python=["3.10", "3.11", "3.12", "3.13"],
+    uv_groups=["test"],
+)
+def test(s: Session) -> None:
+    s.run("python", "-m", "pytest")
+
+
+@session(uv_groups=["type_check"])
+def type_check(s: Session) -> None:
+    s.run("mypy", "src")
+
+
+@session(uv_only_groups=["lint"])
+def type_check(s: Session) -> None:
+    s.run("ruff", "check", ".")
+    s.run("ruff", "format", "--check", ".")
+```
+
+> [!NOTE]
+> All `@session(...)` parameters are keywords only, no positional parameters are allowed.
+
+> [!NOTE]
+> The `default_groups` defined in `pyproject.toml` are _not_ installed by default. The
+> user must explicitly list the desired groups in the `uv_groups` parameter. 
+
+### Added parameters
+
+- `uv_groups`: list of `uv` _dependency-groups_
+- `uv_extras`: list of `uv` _optional-dependencies_
+- `uv_only_groups`: list of `uv` _only-groups_ to include. Prevents installation of project
+   _dependencies_.
+- `uv_all_extras`: boolean to install all _optional-dependencies_ from `pyproject.toml`
+- `uv_all_groups`: boolean to install all _dependency-groups_
+- `uv_sync_locked`: boolean to validate that `uv.lock` is up-to-date
+
+
+## Inspiration
+
+This is heavily influenced by, but much more limited than, 
+[nox-poetry](https://nox-poetry.readthedocs.io).

nox_uv-0.5.0/README.md

@@ -0,0 +1,108 @@
+## Intro
+
+[![GitHub Actions][github-actions-badge]](https://github.com/dantebben/nox-uv/actions)
+[![PyPI version][pypi-version-badge]](https://pypi.python.org/pypi/nox-uv)
+[![Python versions][python-versions-badge]](https://pypi.python.org/pypi/nox-uv)
+[![uv][uv-badge]](https://github.com/astral-sh/uv)
+[![Nox][nox-badge]](https://github.com/wntrblm/nox)
+[![Ruff][ruff-badge]](https://github.com/astral-sh/ruff)
+[![Type checked with mypy][mypy-badge]](https://mypy-lang.org/)
+
+[github-actions-badge]: https://github.com/dantebben/nox-uv/workflows/CI/badge.svg
+[pypi-version-badge]: https://img.shields.io/pypi/v/nox-uv.svg
+[python-versions-badge]: https://img.shields.io/pypi/pyversions/nox-uv.svg
+[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
+[nox-badge]: https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[mypy-badge]: https://www.mypy-lang.org/static/mypy_badge.svg
+
+`nox-uv` is a simple drop-in replacement for [nox](https://nox.thea.codes/)'s `@nox.session` that installs
+dependencies constrained by [uv](https://docs.astral.sh/uv/)'s lockfile.
+
+## Usage
+
+Add `nox-uv` as a development dependency. The following example adds it into a `nox`
+`dependency-group`.
+
+```shell
+uv add --group nox nox-uv
+```
+
+Using the following configuration within `pyproject.toml` as an example:
+
+```toml
+[dependency-groups]
+nox = [
+    "nox-uv",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+type_check = [
+    "mypy",
+]
+lint = [
+    "ruff",
+]
+```
+
+Within, your `noxfile.py`:
+
+1. Import `session` from `nox_uv`.
+2. Set `venv_backend` to `"uv"`. This can be done globally using
+   `options.default_venv_backend = "uv"`.
+3. Use the new [`uv_*` parameters](#added-parameters) to `session` to control which dependencies
+   are synced into the session's virtual environment in addition to the project's main
+   dependencies.
+     - `uv sync` is used to install dependencies so that their versions are constrained by
+       `uv.lock`.
+
+```py
+from nox import Session, options
+from nox_uv import session
+
+options.default_venv_backend = "uv"
+
+
+@session(
+    python=["3.10", "3.11", "3.12", "3.13"],
+    uv_groups=["test"],
+)
+def test(s: Session) -> None:
+    s.run("python", "-m", "pytest")
+
+
+@session(uv_groups=["type_check"])
+def type_check(s: Session) -> None:
+    s.run("mypy", "src")
+
+
+@session(uv_only_groups=["lint"])
+def type_check(s: Session) -> None:
+    s.run("ruff", "check", ".")
+    s.run("ruff", "format", "--check", ".")
+```
+
+> [!NOTE]
+> All `@session(...)` parameters are keywords only, no positional parameters are allowed.
+
+> [!NOTE]
+> The `default_groups` defined in `pyproject.toml` are _not_ installed by default. The
+> user must explicitly list the desired groups in the `uv_groups` parameter. 
+
+### Added parameters
+
+- `uv_groups`: list of `uv` _dependency-groups_
+- `uv_extras`: list of `uv` _optional-dependencies_
+- `uv_only_groups`: list of `uv` _only-groups_ to include. Prevents installation of project
+   _dependencies_.
+- `uv_all_extras`: boolean to install all _optional-dependencies_ from `pyproject.toml`
+- `uv_all_groups`: boolean to install all _dependency-groups_
+- `uv_sync_locked`: boolean to validate that `uv.lock` is up-to-date
+
+
+## Inspiration
+
+This is heavily influenced by, but much more limited than, 
+[nox-poetry](https://nox-poetry.readthedocs.io).

{nox_uv-0.3.0 → nox_uv-0.5.0}/noxfile.py

@@ -3,14 +3,8 @@ from nox import Session, options, parametrize
 from nox_uv import session
 
 options.error_on_external_run = True
-options.reuse_existing_virtualenvs = False
 options.default_venv_backend = "uv"
-options.sessions = ["uv_lock_check", "lint", "type_check", "test"]
-
-
-@session(venv_backend="none")
-def uv_lock_check(s: Session) -> None:
-    s.run("uv", "lock", "--check")
+options.sessions = ["lint", "type_check", "test"]
 
 
 @session(
@@ -23,16 +17,16 @@ def test(s: Session) -> None:
         "-m",
         "pytest",
         "--cov=nox_uv",
+        "--cov-branch",
         "--cov-report=html",
         "--cov-report=term",
+        "--cov-fail-under=100",
         "tests",
         *s.posargs,
     )
 
 
-# For some sessions, set venv_backend="none" to simply execute scripts within the existing Poetry
-# environment. This requires that nox is run within `poetry shell` or using `poetry run nox ...`.
-@session(venv_backend="none")
+@session(uv_only_groups=["lint"])
 @parametrize(
     "command",
     [
@@ -56,7 +50,7 @@ def fmt(s: Session, command: list[str]) -> None:
     s.run(*command)
 
 
-@session(uv_groups=["lint"])
+@session(uv_only_groups=["lint"])
 @parametrize(
     "command",
     [
@@ -68,22 +62,11 @@ def lint(s: Session, command: list[str]) -> None:
     s.run(*command)
 
 
-@session(venv_backend="none")
+@session(uv_only_groups=["lint"])
 def lint_fix(s: Session) -> None:
     s.run("ruff", "check", ".", "--extend-fixable", "F401", "--fix")
 
 
-@session(venv_backend="none")
+@session(uv_groups=["test", "type_check"])
 def type_check(s: Session) -> None:
     s.run("mypy", "src", "tests", "noxfile.py")
-
-
-@session(venv_backend="none")
-def simple_test(s: Session) -> None:
-    assert 1 == 1
-
-
-@session(venv_backend="none")
-def run_test_as_session(s: Session) -> None:
-    """Test ability to call a nother session."""
-    simple_test(s)

{nox_uv-0.3.0 → nox_uv-0.5.0}/pyproject.toml

@@ -1,7 +1,8 @@
 [project]
 name = "nox-uv"
-version = "0.3.0"
+version = "0.5.0"
 description = "Facilitate nox integration with uv for Python projects"
+keywords = ["nox", "uv"]
 readme = "README.md"
 authors = [
     { name = "Dan Tebben", email = "dantebben@gmail.com" }
@@ -31,6 +32,8 @@ dependencies = [
 
 [project.urls]
 Homepage = "https://github.com/dantebben/nox-uv"
+Repository = "https://github.com/dantebben/nox-uv"
+Issues = "https://github.com/dantebben/nox-uv/issues"
 
 [build-system]
 requires = ["hatchling"]
@@ -41,9 +44,12 @@ lint = [
     "ruff>=0.9.7",
 ]
 test = [
+    # TODO: Remove this upper bound with pytest-cov fixes issues with filterwarnings = ["error"]
+    #   https://github.com/pytest-dev/pytest-cov/issues/693
+    "pytest<8.4.0",
     "pytest-cov>=6.0.0",
 ]
-type-check = [
+type_check = [
     "mypy>=1.15.0",
 ]
 
@@ -98,9 +104,6 @@ split-on-trailing-comma = false
 [tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
-[tool.ruff.lint.flake8-bugbear]
-extend-immutable-calls = ["typer.Argument"]
-
 [tool.pytest.ini_options]
 addopts = [
     "--strict-config",
@@ -114,4 +117,3 @@ parallel = true
 # The nox session that calls coverage does not find "src/nox_uv", but it is found in the 
 # subprocess. Coverage generates a warning that the module was not found, but coverage is actually
 # run and determined in the "parallel" subprocess.
-disable_warnings = ["module-not-imported", "no-data-collected"]

{nox_uv-0.3.0 → nox_uv-0.5.0}/src/nox_uv/__init__.py

@@ -16,15 +16,17 @@ def session(
     python: Python | None = None,
     reuse_venv: bool | None = None,
     name: str | None = None,
-    venv_backend: Any | None = None,
+    venv_backend: str | None = None,
     venv_params: Sequence[str] = (),
     tags: Sequence[str] | None = None,
     default: bool = True,
     requires: Sequence[str] | None = None,
     uv_groups: Sequence[str] = (),
     uv_extras: Sequence[str] = (),
+    uv_only_groups: Sequence[str] = (),
     uv_all_extras: bool = False,
     uv_all_groups: bool = False,
+    uv_sync_locked: bool = True,
     **kwargs: dict[str, Any],
 ) -> Callable[..., Callable[..., R]]:
     """Drop-in replacement for the :func:`nox.session` decorator to add support for `uv`.
@@ -52,27 +54,37 @@ def session(
             uv_extras=uv_extras,
             uv_all_extras=uv_all_extras,
             uv_all_groups=uv_all_groups,
+            uv_only_groups=uv_only_groups,
+            uv_sync_locked=uv_sync_locked,
             **kwargs,
         )  # type: ignore
 
     [function] = args
 
     # Create the `uv sync` command
-    sync_cmd = ["uv", "sync", "--no-default-groups", "--locked"]
+    sync_cmd = ["uv", "sync", "--no-default-groups"]
+    extended_cmd: list[str] = []
+
+    # Add the --locked flag
+    if uv_sync_locked:
+        sync_cmd.append("--locked")
 
     # Add the groups
-    for g in uv_groups:
-        sync_cmd.append(f"--group={g}")
+    extended_cmd.extend([f"--group={g}" for g in uv_groups])
 
     # Add the extras
-    for e in uv_extras:
-        sync_cmd.append(f"--extra={e}")
+    extended_cmd.extend([f"--extra={e}" for e in uv_extras])
+
+    # Add the only-groups
+    extended_cmd.extend([f"--only-group={g}" for g in uv_only_groups])
 
     if uv_all_groups:
-        sync_cmd.append("--all-groups")
+        extended_cmd.append("--all-groups")
 
     if uv_all_extras:
-        sync_cmd.append("--all-extras")
+        extended_cmd.append("--all-extras")
+
+    sync_cmd += extended_cmd
 
     @functools.wraps(function)
     def wrapper(s: nox.Session, *_args: Any, **_kwargs: Any) -> None:
@@ -82,11 +94,20 @@ def session(
             # UV called from Nox does not respect the Python version set in the Nox session.
             # We need to pass the Python version to UV explicitly.
             if s.python is not None:
-                # NOTE: casting to string explicitly because implicit casting isn't working
-                # for the type checker.
-                s.env["UV_PYTHON"] = str(s.python)
+                s.env["UV_PYTHON"] = s.virtualenv.location
 
+            s.debug(
+                f"UV_PYTHON={s.env['UV_PYTHON']} | "
+                f"UV_PROJECT_ENVIRONMENT={s.env['UV_PROJECT_ENVIRONMENT']}"
+            )
             s.run_install(*sync_cmd)
+        else:
+            if len(extended_cmd) > 0:
+                raise s.error(
+                    'Using "uv" specific paramaters is not allowed outside of a "uv" '
+                    "venv_backend.\n"
+                    f"Check the venv_backend, or the {extended_cmd} parameters."
+                )
 
         function(nox.Session(s._runner), *_args, **_kwargs)
 

{nox_uv-0.3.0 → nox_uv-0.5.0}/tests/subproject/noxfile.py

@@ -3,22 +3,21 @@ from nox import Session, options
 from nox_uv import session
 
 options.default_venv_backend = "uv"
-options.reuse_existing_virtualenvs = False
-
 options.sessions = [
     "check_python_version",
     "install_nothing",
-    "only_test_group",
+    "test_group",
     "all_groups",
     "all_extras",
-    "only_one_extra",
+    "one_extra",
     "correct_python",
+    "only_groups",
 ]
 
 
 @session(venv_backend="none")
 def check_python_version(s: Session) -> None:
-    s.run("python3", "--version")
+    s.run("python", "--version")
 
 
 @session
@@ -35,7 +34,7 @@ def install_nothing(s: Session) -> None:
 
 
 @session(uv_groups=["test"])
-def only_test_group(s: Session) -> None:
+def test_group(s: Session) -> None:
     r = s.run("uv", "pip", "list", silent=True)
     assert isinstance(r, str)
     assert "pytest-cov" in r
@@ -62,8 +61,8 @@ def all_extras(s: Session) -> None:
     assert "pyyaml" in r
 
 
-@session(uv_extras=["pyyaml"])
-def only_one_extra(s: Session) -> None:
+@session(uv_extras=["pyyaml"], uv_sync_locked=False)  # Test without the --locked flag
+def one_extra(s: Session) -> None:
     r = s.run("uv", "pip", "list", silent=True)
     assert isinstance(r, str)
     assert "networkx" not in r
@@ -73,8 +72,26 @@ def only_one_extra(s: Session) -> None:
 @session(python=["3.10"])
 def correct_python(s: Session) -> None:
     assert s.python == "3.10"
-    v = s.run("python3", "--version", silent=True)
+    v = s.run("python", "--version", silent=True)
     if isinstance(v, str):
         assert "Python 3.10" in v
     else:
         raise RuntimeError("Python version was not returned.")
+
+
+@session(uv_only_groups=["lint"])
+def only_groups(s: Session) -> None:
+    r = s.run("uv", "pip", "list", silent=True)
+    assert isinstance(r, str)
+    assert "ruff" in r
+    assert "nox-uv" not in r
+
+
+@session(uv_groups=["type_check"], venv_backend="virtualenv")
+def failed_virtualenv(s: Session) -> None:
+    pass
+
+
+@session(uv_groups=["type_check"], venv_backend="none")
+def failed_venv_none(s: Session) -> None:
+    pass

{nox_uv-0.3.0 → nox_uv-0.5.0}/tests/subproject/pyproject.toml

@@ -12,7 +12,7 @@ dependencies = [
 ]
 
 [tool.uv.sources]
-nox-uv = { path = "../../" }
+nox-uv = { path = "../../", editable = true }
 
 [project.optional-dependencies] 
 pyyaml = ["pyyaml"]
@@ -29,7 +29,7 @@ lint = [
 test = [
     "pytest-cov>=6.0.0",
 ]
-type-check = [
+type_check = [
     "mypy>=1.15.0",
 ]
 
@@ -37,5 +37,5 @@ type-check = [
 default-groups = [
     "lint",
     "test",
-    "type-check",
+    "type_check",
 ]

{nox_uv-0.3.0 → nox_uv-0.5.0}/tests/subproject/uv.lock

@@ -266,8 +266,8 @@ wheels = [
 
 [[package]]
 name = "nox-uv"
-version = "0.3.0"
-source = { directory = "../../" }
+version = "0.5.0"
+source = { editable = "../../" }
 dependencies = [
     { name = "nox" },
 ]
@@ -277,7 +277,10 @@ requires-dist = [{ name = "nox", specifier = ">=2025.5.1" }]
 
 [package.metadata.requires-dev]
 lint = [{ name = "ruff", specifier = ">=0.9.7" }]
-test = [{ name = "pytest-cov", specifier = ">=6.0.0" }]
+test = [
+    { name = "pytest", specifier = "<8.4.0" },
+    { name = "pytest-cov", specifier = ">=6.0.0" },
+]
 type-check = [{ name = "mypy", specifier = ">=1.15.0" }]
 
 [[package]]
@@ -457,7 +460,7 @@ type-check = [
 
 [package.metadata]
 requires-dist = [
-    { name = "nox-uv", directory = "../../" },
+    { name = "nox-uv", editable = "../../" },
     { name = "pyyaml", marker = "extra == 'pyyaml'" },
     { name = "scapy", marker = "extra == 'scapy'" },
 ]

nox_uv-0.5.0/tests/test_lib.py

@@ -0,0 +1,35 @@
+import os
+from pathlib import Path
+import subprocess
+
+
+def test_1() -> None:
+    assert 5 == 5
+
+
+def test_run_uv_nox() -> None:
+    cur_folder = Path.cwd()
+    testing_folder = Path(__file__).parent / "subproject"
+    os.chdir(testing_folder)
+    a = subprocess.run(["uv", "run", "python", "-m", "nox"])
+    assert a.returncode == 0
+    os.chdir(cur_folder)
+
+
+def test_run_failed_uv_venv() -> None:
+    cur_folder = Path.cwd()
+    testing_folder = Path(__file__).parent / "subproject"
+    os.chdir(testing_folder)
+    a = subprocess.run(
+        ["uv", "run", "python", "-m", "nox", "-s", "failed_virtualenv"], capture_output=True
+    )
+    assert a.returncode == 1  # This test is expected to fail with a `Session.error` raised.
+    assert "is not allowed" in a.stderr.decode()
+
+    a = subprocess.run(
+        ["uv", "run", "python", "-m", "nox", "-s", "failed_venv_none"], capture_output=True
+    )
+    assert a.returncode == 1  # This test is expected to fail with a `Session.error` raised.
+    assert "is not allowed" in a.stderr.decode()
+
+    os.chdir(cur_folder)