Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix version parsing #739

Merged
merged 2 commits into from
Nov 21, 2023
Merged

Fix version parsing #739

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d963f8a
Fix version parsing
fcollonval Nov 20, 2023
0adbe19
Avoid setting releaselevel to final as much as possible
fcollonval Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions nbdime/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@

VersionInfo = namedtuple("VersionInfo", ["major", "minor", "micro", "releaselevel", "serial"])

_specifier_ = {"a": "alpha", "b": "beta", "rc": "candidate", "": "final"}
_specifier_ = {"a": "alpha", "b": "beta", "rc": "candidate"}

__version__ = "4.0.0"

parser = re.compile(r"^(?P<major>\d+)\.(?P<minor>\d+)\.(?P<micro>\d+)((?P<releaselevel>a|b|rc)(?P<serial>\d+))?$")

parsed_version = parser.match(__version__)
groups = parsed_version.groupdict()

version_info = VersionInfo(
int(groups["major"]),
int(groups["minor"]),
int(groups["micro"]),
_specifier_[groups.get("releaselevel", "")],
_specifier_.get(groups.get("releaselevel", ""), "final"),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is the right choice: if someone makes a mistake and bumps to "beta" instead of "b", then it will default to final since it cannot parse it?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind sharing what error you were seeing that this will fix?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_specifier_.get(groups.get("releaselevel", ""), "final"),
_specifier_[groups.get("releaselevel") or ""],

Copy link
Collaborator Author

@fcollonval fcollonval Nov 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error is that if not found groups.get("releaselevel") is None. Therefore, as None is not a key of _specificer, it raises an KeyError.

I'll go for a more advance solution than Vidar's proposal as the proposed solution does not address the case of release level being beta for example.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My point was that "beta" would be an invalid value that should throw an error. Somewhere at least.. probably not good for it to throw in packaged code though, so this change is fine. But yes, let's try to get a regression test for the future as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For documentation, beta is a valid specifier: https://peps.python.org/pep-0440/#pre-release-spelling

groups.get("serial", ""),
)
Loading