Add `uv export --format requirements.txt` by charliermarsh · Pull Request #6778 · astral-sh/uv

charliermarsh · 2024-08-28T21:49:54Z

Summary

The interface here is intentionally a bit more limited than uv pip compile, because we don't want requirements.txt to be a system of record -- it's just an export format. So, we don't write annotation comments (i.e., which dependency is requested from which), we don't allow writing extras, etc. It's just a flat list of requirements, with their markers and hashes.

Closes #6007.

Closes #6668.

Closes #6670.

crates/uv-cli/src/lib.rs

charliermarsh · 2024-08-28T22:38:21Z

crates/uv/tests/export.rs

+    idna==3.6 ; extra == 'async' \
+        --hash=sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca \
+        --hash=sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f
+    sniffio==1.3.1 ; extra == 'async' \


Wait... I thought this was a cool feature, but I don't think there's any way to "activate" these from uv pip install or pip install...? So we might need the export API to accept extras, to tell us which to include.

konstin

Looks good! Only some nitpicks

crates/uv-cli/src/lib.rs

konstin · 2024-08-29T08:46:38Z

crates/uv/tests/export.rs

+        dependencies = ["anyio==3.7.0"]
+
+        [build-system]
+        requires = ["setuptools>=42", "wheel"]


Setuptools already requires wheel nowadays (https://setuptools.pypa.io/en/latest/build_meta.html#how-to-use-it)

Suggested change

requires = ["setuptools>=42", "wheel"]

requires = ["setuptools>=42"]

Oh nice. I will change this separately since it's in all tests.

konstin · 2024-08-29T08:48:55Z

crates/uv/tests/export.rs

+    sortedcontainers==2.4.0 \
+        --hash=sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88 \
+        --hash=sha256:a163dcaede0f1c021485e957a39245190e74249897e2ae4b2aa38595db237ee0
+    trio==0.25.0 \


Could you add a comment on why we expect the markers to disappear? The combination of python_version > '3.11' and requires_python = ">=3.12" is hard to spot.

zanieb · 2024-08-29T17:14:00Z

crates/uv-cli/src/lib.rs

+    #[arg(long, conflicts_with = "frozen")]
+    pub locked: bool,
+
+    /// Assert that a `uv.lock` exists, without updating it.


Can we write a bit more here? What are the implications for a user running an export here? e.g.

Do not update the uv.lock before exporting.

If a uv.lock does not exist, uv will exit with an error.

Did you copy these from somewhere? I thought I touched most of these up to say stuff like that.

The LockArgs one.

Ah, that one is the simplest because it's for uv lock. I'd look at the styling in uv sync

--locked Assert that the `uv.lock` will remain unchanged. Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error. --frozen Sync without updating the `uv.lock` file. Instead of checking if the lockfile is up-to-date, uses the versions in the lockfile as the source of truth. If the lockfile is missing, uv will exit with an error. If the `pyproject.toml` includes changes to dependencies that have not been included in the lockfile yet, they will not be present in the environment.

crates/uv/tests/help.rs

helderco · 2024-08-30T17:12:46Z

Pretty cool, this will help migrate to uv.lock because users will have a way to revert easily if needed. 🎉

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.4.0` -> `0.4.4` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.4.4`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#044) [Compare Source](astral-sh/uv@0.4.3...0.4.4) ##### Enhancements - Allow customizing the project environment path with `UV_PROJECT_ENVIRONMENT` ([#6834](astral-sh/uv#6834)) - Warn when `VIRTUAL_ENV` is set but will not be respected in project commands ([#6864](astral-sh/uv#6864)) - Add `--no-hashes` to `uv export` ([#6954](astral-sh/uv#6954)) - Make HTTP headers title case for backward compatibility ([#6887](astral-sh/uv#6887)) - Pin `.python-version` in `uv init` ([#6869](astral-sh/uv#6869)) - Support `file://` URLs for `UV_PYTHON_INSTALL_MIRROR` ([#6950](astral-sh/uv#6950)) - Introduce more docker tags for uv ([#6053](astral-sh/uv#6053)) ##### Bug fixes - Avoid canonicalizing the cache directory ([#6949](astral-sh/uv#6949)) - Show all PyPy versions in `uv python list --all-versions` ([#6917](astral-sh/uv#6917)) - Avoid incorrect `requires-python` marker simplifications ([#6268](astral-sh/uv#6268)) ##### Documentation - Add documentation for `UV_PROJECT_ENVIRONMENT` ([#6987](astral-sh/uv#6987)) - Add optional dependencies section to the lockfile document ([#6982](astral-sh/uv#6982)) - Document use of the `file://` scheme in Python installation mirrors ([#6984](astral-sh/uv#6984)) - Fix outdated references to the help menu documentation in the first steps page ([#6980](astral-sh/uv#6980)) - Show env option in CLI reference documentation ([#6863](astral-sh/uv#6863)) - Add bind mount example to `docker.md` ([#6921](astral-sh/uv#6921)) ### [`v0.4.3`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#043) [Compare Source](astral-sh/uv@0.4.2...0.4.3) ##### Enhancements - Show build backend output when `--verbose` is provided ([#6903](astral-sh/uv#6903)) - Allow `uv sync --frozen --package` without copying member `pyproject.toml` ([#6943](astral-sh/uv#6943)) ##### Bug fixes - Avoid panic with missing temporary directory ([#6929](astral-sh/uv#6929)) - Avoid updating incorrect dependencies for sorted `uv add` ([#6939](astral-sh/uv#6939)) - Use lower-bound semantics for all Python compatibility comparisons ([#6882](astral-sh/uv#6882)) ### [`v0.4.2`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#042) [Compare Source](astral-sh/uv@0.4.1...0.4.2) ##### Enhancements - Adding support for `.pyc` files in `uv run` ([#6886](astral-sh/uv#6886)) - Treat missing `top_level.txt` as non-fatal ([#6881](astral-sh/uv#6881)) ##### Bug fixes - Fix `is_disjoint` check for supported environments ([#6902](astral-sh/uv#6902)) - Remove dangling archives in `uv cache clean ${package}` ([#6915](astral-sh/uv#6915)) - Error when discovered Python is incompatible with `--isolated` workspace ([#6885](astral-sh/uv#6885)) - Warn when discovered Python is incompatible with PEP 723 script ([#6884](astral-sh/uv#6884)) ### [`v0.4.1`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#041) [Compare Source](astral-sh/uv@0.4.0...0.4.1) ##### Enhancements - Add `uv export --format requirements-txt` ([#6778](astral-sh/uv#6778)) - Allow `@` references in `uv tool install --from` ([#6842](astral-sh/uv#6842)) - Normalize version specifiers by sorting ([#6333](astral-sh/uv#6333)) - Respect the user's upper-bound in `requires-python` ([#6824](astral-sh/uv#6824)) - Use Windows registry to discover Python on Windows directly ([#6761](astral-sh/uv#6761)) - Hint at `--no-workspace` in `uv init` failures ([#6815](astral-sh/uv#6815)) - Update to last PyPy releases ([#6784](astral-sh/uv#6784)) ##### Bug fixes - Avoid deadlocks when multiple uv processes lock resources ([#6790](astral-sh/uv#6790)) - Expand tildes when matching against `PATH` ([#6829](astral-sh/uv#6829)) - Fix `uv init --no-project` alias ([#6837](astral-sh/uv#6837)) - Ignore pre-release segments when discovering via `requires-python` ([#6813](astral-sh/uv#6813)) - Support inline optional tables in `uv add` and `uv remove` ([#6787](astral-sh/uv#6787)) - Update default `hello.py` to pass `ruff format` ([#6811](astral-sh/uv#6811)) - Avoid stripping root for user path display ([#6865](astral-sh/uv#6865)) - Error when user-provided environments are disjoint with Python ([#6841](astral-sh/uv#6841)) - Retain alphabetical sorting for `pyproject.toml` in `uv add` operations ([#6388](astral-sh/uv#6388)))) ##### Documentation - Add a link to the multiple index docs in the alternative index guide ([#6826](astral-sh/uv#6826)) - Add docs for inline exclude newer in PEP 723 scripts ([#6831](astral-sh/uv#6831)) - Enumerate available Docker tags ([#6768](astral-sh/uv#6768)) - Omit `[pip]` section from configuration file docs ([#6814](astral-sh/uv#6814)) - Update `project.urls` in `pyproject.toml` ([#6844](astral-sh/uv#6844)) - Add docs for AWS CodeArtifact usage ([#6816](astral-sh/uv#6816)) ##### Other changes </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

charliermarsh force-pushed the charlie/export branch 2 times, most recently from 517845d to a30c07a Compare August 28, 2024 21:55

charliermarsh force-pushed the charlie/mod branch from 2920838 to acb88e1 Compare August 28, 2024 21:55

charliermarsh force-pushed the charlie/export branch 3 times, most recently from 9abfd86 to 278804d Compare August 28, 2024 22:00

charliermarsh commented Aug 28, 2024

View reviewed changes

crates/uv-cli/src/lib.rs Outdated Show resolved Hide resolved

Base automatically changed from charlie/mod to main August 28, 2024 22:04

charliermarsh force-pushed the charlie/export branch 5 times, most recently from c19e325 to a2238ef Compare August 28, 2024 22:26

charliermarsh requested review from konstin and zanieb August 28, 2024 22:27

charliermarsh marked this pull request as ready for review August 28, 2024 22:27

charliermarsh force-pushed the charlie/export branch 3 times, most recently from 84dea46 to d921c92 Compare August 28, 2024 22:35

charliermarsh commented Aug 28, 2024

View reviewed changes

charliermarsh force-pushed the charlie/export branch 4 times, most recently from 36710aa to 0b1c49c Compare August 29, 2024 00:06

konstin approved these changes Aug 29, 2024

View reviewed changes

zanieb reviewed Aug 29, 2024

View reviewed changes

crates/uv/tests/help.rs Outdated Show resolved Hide resolved

zanieb approved these changes Aug 29, 2024

View reviewed changes

charliermarsh force-pushed the charlie/export branch from 0b1c49c to a0ac194 Compare August 29, 2024 17:26

charliermarsh enabled auto-merge (squash) August 29, 2024 17:26

Add req export

150027f

charliermarsh force-pushed the charlie/export branch from a0ac194 to 150027f Compare August 29, 2024 17:39

charliermarsh merged commit cbfc928 into main Aug 29, 2024

charliermarsh deleted the charlie/export branch August 29, 2024 17:46

BrewTestBot mentioned this pull request Aug 30, 2024

uv 0.4.1 Homebrew/homebrew-core#182978

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Add `uv export --format requirements.txt`#6778

Add `uv export --format requirements.txt`#6778
charliermarsh merged 1 commit intomainfrom
charlie/export

charliermarsh commented Aug 28, 2024 •

edited

Loading

Uh oh!

Uh oh!

charliermarsh Aug 28, 2024

Uh oh!

konstin left a comment

Uh oh!

Uh oh!

Uh oh!

konstin Aug 29, 2024

Uh oh!

charliermarsh Aug 29, 2024

Uh oh!

konstin Aug 29, 2024

Uh oh!

zanieb Aug 29, 2024

Uh oh!

charliermarsh Aug 29, 2024

Uh oh!

zanieb Aug 29, 2024

Uh oh!

Uh oh!

helderco commented Aug 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	requires = ["setuptools>=42", "wheel"]
	requires = ["setuptools>=42"]

Comments

Conversation

charliermarsh commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Uh oh!

charliermarsh Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

konstin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

konstin Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

charliermarsh Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

konstin Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

zanieb Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

charliermarsh Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

zanieb Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

helderco commented Aug 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

charliermarsh commented Aug 28, 2024 •

edited

Loading