Add `ruff version` with long version display #8034

zanieb · 2023-10-18T01:51:07Z

Adds a new ruff version sub-command which displays long version information in the style of cargo and rustc. We include the number of commits since the last release tag if its a development build, in the style of Python's versioneer.

❯ ruff version
ruff 0.1.0+14 (947940e91 2023-10-18)

❯ ruff version --output-format json
{
  "version": "0.1.0",
  "commit_info": {
    "short_commit_hash": "947940e91",
    "commit_hash": "947940e91269f20f6b3f8f8c7c63f8e914680e80",
    "commit_date": "2023-10-18",
    "last_tag": "v0.1.0",
    "commits_since_last_tag": 14
  }
}%

❯ cargo version
cargo 1.72.1 (103a7ff2e 2023-08-15)

Test plan

I've tested this manually locally, but want to at least add unit tests for the message formatting. We'd also want to check the next release to ensure the information is correct.

I checked build behavior with a detached head and branches.

Future work

We could include rustc and cargo versions from the build, the current Python version, and other diagnostic information for bug reports.

The --version and -V output is unchanged. However, we could update it to display the long ruff version without the rust and cargo versions (this is what cargo does). We'll need to be careful to ensure this does not break downstream packages which parse our version string.

❯ ruff --version
ruff 0.1.0

The LSP should be updated to use ruff version --output-format json instead of parsing ruff --version.

crates/ruff_cli/src/lib.rs

zanieb · 2023-10-18T02:06:03Z

I'm not sure I'm into shadow-rs for this — I think I may prefer to do something like cargo's implementation.

charliermarsh · 2023-10-18T02:09:42Z

I haven't looked at the code yet, but one thing to note is that we do parse the ruff version output in the LSP:

from packaging.version import Version


def version(executable: str) -> Version:
    """Returns the version of the executable at the given path."""
    output = subprocess.check_output([executable, "--version"]).decode().strip()
    version = output.replace("ruff ", "")  # no removeprefix in 3.7 :/
    return Version(version)

zanieb · 2023-10-18T02:15:17Z

This doesn't change any existing behavior — great note though it may be a good reason not to change --version to be long-form.

konstin · 2023-10-18T09:40:20Z

I'd like to switch the lsp to use the json instead

zanieb · 2023-10-18T15:12:49Z

That's a great idea!

zanieb · 2023-10-18T17:18:10Z

I'm really pleased with the handwritten implementation. I adapted the version and commit information from https://github.com/zanieb/poetry-relax/blob/main/scripts/version, https://github.com/rust-lang/cargo/blob/master/build.rs, and https://github.com/rust-lang/cargo/blob/master/src/cargo/version.rs

crates/ruff_cli/build.rs

github-actions · 2023-10-18T17:47:36Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

MichaReiser · 2023-10-18T21:55:27Z

I'd like to switch the lsp to use the json instead

How would we detect if the ruff version is new enough to support the new json output without using --version first?

charliermarsh · 2023-10-18T22:28:47Z

Hah yes that’s true. Maintaining compatibility between Ruff and the LSP feels increasingly annoying.

zanieb · 2023-10-18T23:50:44Z

I'd like to switch the lsp to use the json instead

How would we detect if the ruff version is new enough to support the new json output without using --version first?

True, that's pretty funny. We can go the "try and fail" way at the cost of some speed.

konstin · 2023-10-19T08:18:17Z

How would we detect if the ruff version is new enough to support the new json output without using --version first?

We don't, we have to wait until a ruff with a json version is the oldest supported version plus a bit of buffer for better error messages.

zanieb · 2023-10-19T18:12:07Z

crates/ruff_cli/build.rs

+    let git_head_path = git_dir.join("HEAD");
+    println!(
+        "cargo:rerun-if-changed={}",
+        git_head_path.as_path().display()
+    );
+
+    let git_head_contents = fs::read_to_string(git_head_path);
+    if let Ok(git_head_contents) = git_head_contents {
+        // The contents are either a commit or a reference in the following formats
+        // "<commit>""
+        // "ref <ref>""
+        // If a commit, checking if the HEAD file has changed is sufficient
+        // If a ref we want to add the head file for that ref to rebuild on commit
+        let mut git_ref_parts = git_head_contents.split_whitespace();
+        git_ref_parts.next();
+        if let Some(git_ref) = git_ref_parts.next() {
+            let git_ref_path = git_dir.join(git_ref);
+            println!(
+                "cargo:rerun-if-changed={}",
+                git_ref_path.as_path().display()
+            );
+        }
+    }


Okay this is a little bit much but i tested this out and basically without this, if you change any file in the ruff_cli crate e.g. add a file foo to the crate root then a rebuild is forced — this is entirely unnecessary so, here, if a git directory is present we will use commit information from it to determine if rebuilding should occur.

zanieb · 2023-10-19T20:35:26Z

Just needs some snapshot tests for the version formatting now.

zanieb · 2023-10-20T15:35:17Z

I wish we could test the ruff version command output but it would change per commit and redacting it would be meaningless.

Adds a CI job which runs `ruff-lsp` tests against the current Ruff build. Avoids rebuilding Ruff at the cost of running _after_ the cargo tests have finished. Might be worth the rebuild to get earlier feedback but I don't expect it to fail often? xref astral-sh/ruff-lsp#286 ## Test plan Verified use of the development version by inspecting version output in CI; supported by astral-sh/ruff-lsp#289 and #8034

Similar to astral-sh/ruff#8034 Adds more version information so it's clear what revision the user is on ``` ❯ cargo run -q -- --version uv 0.1.10 (daa8565 2024-02-23) ❯ cargo run -q -- -V uv 0.1.10 ❯ cargo run -q -- version uv 0.1.10 (daa8565 2024-02-23) ❯ cargo run -q -- version --output-format json { "version": "0.1.10", "commit_info": { "short_commit_hash": "daa8565a7", "commit_hash": "daa8565a75249305821fdc34ace085060c082ba3", "commit_date": "2024-02-23", "last_tag": null, "commits_since_last_tag": 0 } } ```

Add ruff version with long version display

9853a22

zanieb force-pushed the zanie/long-version branch from b65796d to 9853a22 Compare October 18, 2023 02:01

zanieb commented Oct 18, 2023

View reviewed changes

crates/ruff_cli/src/lib.rs Show resolved Hide resolved

Drop shadow-rs in favor of a way cooler hand-coded implementation

0b1b490

Move "version" to bottom of commands

fb690af

konstin reviewed Oct 18, 2023

View reviewed changes

crates/ruff_cli/build.rs Show resolved Hide resolved

zanieb added 3 commits October 18, 2023 12:22

Remove ruff_version

25c071f

Lint

5e0f016

Oops; commit version file

2d1a199

zanieb added 2 commits October 19, 2023 11:59

Remove unncessary build.rs specifier

355aba9

Use git references to trigger rebuilds

1208df9

zanieb commented Oct 19, 2023

View reviewed changes

Improve comments

53b0f5d

zanieb added 2 commits October 20, 2023 10:03

Add snapshots for version formatting

944b3e4

Handle edge cases when describe fails; add serialization test; lint

f8655ea

zanieb marked this pull request as ready for review October 20, 2023 15:35

Add ruff prefix

996ddf1

konstin approved these changes Oct 20, 2023

View reviewed changes

Commit snapshot

d685384

zanieb merged commit 860ffb9 into main Oct 20, 2023
16 checks passed

zanieb deleted the zanie/long-version branch October 20, 2023 19:07

zanieb mentioned this pull request Oct 23, 2023

Add compatibility test for ruff-lsp to CI #8016

Merged

p-linnane mentioned this pull request Oct 24, 2023

ruff 0.1.2 Homebrew/homebrew-core#152273

Merged

zanieb mentioned this pull request Feb 23, 2024

Add long-form version output astral-sh/uv#1930

Merged

zanieb mentioned this pull request Jun 2, 2024

Add info about used git commit into ruff --version if available #11691

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `ruff version` with long version display #8034

Add `ruff version` with long version display #8034

zanieb commented Oct 18, 2023 •

edited

Loading

zanieb commented Oct 18, 2023

charliermarsh commented Oct 18, 2023

zanieb commented Oct 18, 2023

konstin commented Oct 18, 2023

zanieb commented Oct 18, 2023

zanieb commented Oct 18, 2023

github-actions bot commented Oct 18, 2023 •

edited

Loading

MichaReiser commented Oct 18, 2023

charliermarsh commented Oct 18, 2023

zanieb commented Oct 18, 2023

konstin commented Oct 19, 2023

zanieb Oct 19, 2023

zanieb commented Oct 19, 2023

zanieb commented Oct 20, 2023

Add ruff version with long version display #8034

Add ruff version with long version display #8034

Conversation

zanieb commented Oct 18, 2023 • edited Loading

Test plan

Future work

zanieb commented Oct 18, 2023

charliermarsh commented Oct 18, 2023

zanieb commented Oct 18, 2023

konstin commented Oct 18, 2023

zanieb commented Oct 18, 2023

zanieb commented Oct 18, 2023

github-actions bot commented Oct 18, 2023 • edited Loading

PR Check Results

Ecosystem

MichaReiser commented Oct 18, 2023

charliermarsh commented Oct 18, 2023

zanieb commented Oct 18, 2023

konstin commented Oct 19, 2023

zanieb Oct 19, 2023

Choose a reason for hiding this comment

zanieb commented Oct 19, 2023

zanieb commented Oct 20, 2023

Add `ruff version` with long version display #8034

Add `ruff version` with long version display #8034

zanieb commented Oct 18, 2023 •

edited

Loading

github-actions bot commented Oct 18, 2023 •

edited

Loading