nox-uv 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

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.5.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,6 @@
+nox_uv/__init__.py,sha256=saOMVr75kYQRM1F2y0WhswoalybmXaeqyXWiQw1PtOs,3799
+nox_uv/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nox_uv-0.5.0.dist-info/METADATA,sha256=E0z2X2Ls22uPh4gfkupWkBLlWSAPlAe7LqQGLrlskBM,4599
+nox_uv-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nox_uv-0.5.0.dist-info/licenses/LICENSE.txt,sha256=iTZ5ALF1isnM6Ey9Tjom0XIGBBysArB0I2NHZ9a-b8I,1067
+nox_uv-0.5.0.dist-info/RECORD,,

nox_uv-0.3.0.dist-info/METADATA

@@ -1,50 +0,0 @@
-Metadata-Version: 2.4
-Name: nox-uv
-Version: 0.3.0
-Summary: Facilitate nox integration with uv for Python projects
-Project-URL: Homepage, https://github.com/dantebben/nox-uv
-Author-email: Dan Tebben <dantebben@gmail.com>
-License-Expression: MIT
-License-File: LICENSE.txt
-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
-
-This is a basic drop-in replacement for `nox.session` of [nox](https://nox.thea.codes/) to be used 
-with the [uv](https://docs.astral.sh/uv/) package manager.
-
-To use, import `session` from `nox_uv` in your `noxfile.py`.
-
-> [!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` extras
-- `uv_all_extras`: boolean to install all extras from `pyproject.toml`
-- `uv_all_groups`: boolean to install all dependency groups
-
-## Inspiration
-
-This is heavily influenced by, but much more limited than, 
-[nox-poetry](https://nox-poetry.readthedocs.io).

nox_uv-0.3.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-nox_uv/__init__.py,sha256=r5KNgONE17jPy66T_MK6caqw5pkNYCHTgxWdcM3NuPQ,3054
-nox_uv/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nox_uv-0.3.0.dist-info/METADATA,sha256=qPBt6LmmykDW1NSS6ig1hcDL5FMIW3E4xZV_LcnZb8o,1844
-nox_uv-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nox_uv-0.3.0.dist-info/licenses/LICENSE.txt,sha256=iTZ5ALF1isnM6Ey9Tjom0XIGBBysArB0I2NHZ9a-b8I,1067
-nox_uv-0.3.0.dist-info/RECORD,,