Fix "not enough values to unpack" when parsing .git_archival.txt from a tagged commit; also fix #759 #772
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Given .git_archival.txt content like this:
node: 3634907645428b9542cfb4fd1ceef08f14526cb8
node-date: 2022-10-13T20:38:09-06:00
describe-name: v0.0.5
ref-names: HEAD -> main, tag: v0.0.5
we would previously fail with an exception like this:
$ python3 -m setuptools_scm
Traceback (most recent call last):
[..snip..]
File ".../setuptools_scm/git.py", line 312, in parse_archival
return archival_to_version(data, config=config)
File ".../setuptools_scm/git.py", line 286, in archival_to_version
tag, number, node, _ = _git_parse_describe(archival_describe)
File ".../setuptools_scm/git.py", line 245, in _git_parse_describe
tag, number, node = describe_output.rsplit("-", 2)
ValueError: not enough values to unpack (expected 3, got 1)
The problem is that the describe-name field is "v0.0.5" instead of
looking like "v0.0.5-0-g3634907".
When we invoke git-describe ourselves, we specify the --long option, but
the format-strings implemented by git-archive do not currently give us
any way to force long-output in a .git_archival.txt file.
This change detects this condition and returns None for the missing
fields.
…h how we invoke git-describe This covers `--tags` and `--match '*[0-9]*'` (and `--dirty` is unnecessary). There is unfortunately no format-string equivalent to git-describe's `--long` option, Archives made from this repository after this change should now get versioned correctly. Fixes: pypa#759
for more information, see https://pre-commit.ci
RonnyPfannschmidt
approved these changes
Oct 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Given
.git_archival.txtcontent like this:setuptools_scm fails with an exception like this:
The problem here is that the describe-name field is "v0.0.5" instead of
something like "v0.0.5-0-g3634907", so the tuple unpacking fails.
So, it works correctly with untagged versions of the repo:
But if we tag the repo and create another archive, the exception occurs:
Version information:
The first commit of the pull-request proposes a fix for that.
The second commit fixes #759.