nox-uv 0.2.3__tar.gz → 0.4.0__tar.gz

{nox_uv-0.2.3 → nox_uv-0.4.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.3"
 
 jobs:
   test:

nox_uv-0.4.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: nox-uv
+Version: 0.4.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.4.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.2.3 → nox_uv-0.4.0}/noxfile.py

@@ -3,7 +3,6 @@ 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"]
 
@@ -23,8 +22,10 @@ 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,
     )

{nox_uv-0.2.3 → nox_uv-0.4.0}/pyproject.toml

@@ -1,7 +1,8 @@
 [project]
 name = "nox-uv"
-version = "0.2.3"
+version = "0.4.0"
 description = "Facilitate nox integration with uv for Python projects"
+keywords = ["nox", "uv"]
 readme = "README.md"
 authors = [
     { name = "Dan Tebben", email = "dantebben@gmail.com" }
@@ -26,18 +27,13 @@ classifiers = [
 
 requires-python = ">=3.9"
 dependencies = [
-    "nox>=2025.2.9",
+    "nox>=2025.05.01",
 ]
 
-# These optional dependencies are only for testing ability to include/exclude extras.
-[project.optional-dependencies] 
-pyyaml = ["pyyaml"]
-scapy = ["scapy"]
-
-
-
 [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"]
@@ -54,18 +50,8 @@ type-check = [
     "mypy>=1.15.0",
 ]
 
-never-used = [
-    "networkx"
-]
-
-
 [tool.uv]
-default-groups = [
-    "lint",
-    "test",
-    "type-check",
-]
-
+default-groups = "all"
 
 [tool.mypy]
 ignore_missing_imports = true
@@ -115,9 +101,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",
@@ -131,4 +114,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.2.3 → nox_uv-0.4.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:
@@ -87,6 +99,13 @@ def session(
                 s.env["UV_PYTHON"] = str(s.python)
 
             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.4.0/tests/subproject/.python-version

@@ -0,0 +1 @@
+3.12

nox_uv-0.4.0/tests/subproject/main.py

@@ -0,0 +1,6 @@
+def main() -> None:
+    print("Hello from subproject!")
+
+
+if __name__ == "__main__":
+    main()

nox_uv-0.2.3/tests/subnoxfile.py → nox_uv-0.4.0/tests/subproject/noxfile.py

@@ -7,10 +7,13 @@ options.reuse_existing_virtualenvs = False
 
 options.sessions = [
     "check_python_version",
-    "only_test_group",
+    "install_nothing",
+    "test_group",
     "all_groups",
     "all_extras",
+    "one_extra",
     "correct_python",
+    "only_groups",
 ]
 
 
@@ -19,20 +22,36 @@ def check_python_version(s: Session) -> None:
     s.run("python3", "--version")
 
 
+@session
+def install_nothing(s: Session) -> None:
+    r = s.run("uv", "pip", "list", silent=True)
+    assert isinstance(r, str)
+    assert "nox-uv" in r
+    assert "scapy" not in r
+    assert "pyyaml" not in r
+    assert "networkx" not in r
+    assert "ruff" not in r
+    assert "pytest-cov" not in r
+    assert "mypy" not in r
+
+
 @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
     assert "networkx" not in r
+    assert "ruff" not in r
 
 
 @session(uv_all_groups=True)
 def all_groups(s: Session) -> None:
     r = s.run("uv", "pip", "list", silent=True)
     assert isinstance(r, str)
-    assert "pytest-cov" in r
     assert "networkx" in r
+    assert "ruff" in r
+    assert "pytest-cov" in r
+    assert "mypy" in r
 
 
 @session(uv_all_extras=True)
@@ -40,14 +59,14 @@ def all_extras(s: Session) -> None:
     r = s.run("uv", "pip", "list", silent=True)
     assert isinstance(r, str)
     assert "networkx" not in r
+    assert "scapy" in r
     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 "scapy" not in r
     assert "networkx" not in r
     assert "pyyaml" in r
 
@@ -60,3 +79,21 @@ def correct_python(s: Session) -> None:
         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.4.0/tests/subproject/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "subproject"
+version = "0.1.0"
+description = "Project for testing nox-uv"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Private: Do Not Upload",
+]
+dependencies = [
+    "nox-uv",
+]
+
+[tool.uv.sources]
+nox-uv = { path = "../../", editable = true }
+
+[project.optional-dependencies] 
+pyyaml = ["pyyaml"]
+scapy = ["scapy"]
+
+[dependency-groups]
+never-used = [
+    "networkx"
+]
+
+lint = [
+    "ruff>=0.9.7",
+]
+test = [
+    "pytest-cov>=6.0.0",
+]
+type-check = [
+    "mypy>=1.15.0",
+]
+
+[tool.uv]
+default-groups = [
+    "lint",
+    "test",
+    "type-check",
+]