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

Fix version date calculation in corner cases #149

Merged
merged 2 commits into from
Oct 19, 2024
Merged

Fix version date calculation in corner cases #149

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d99e5d4
Refactor compute_stub_version for better understandability
srittau Oct 19, 2024
b5d76e9
Fix version date calculation in corner cases
srittau Oct 19, 2024
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
23 changes: 15 additions & 8 deletions stub_uploader/get_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ def ensure_specificity(ver: list[int], specificity: int) -> None:
ver.extend([0] * (specificity - len(ver)))


# `today` can be passed as an argument for testing purposes.
def compute_stub_version(
version_spec: Specifier, published_versions: list[Version], date: datetime.date
version_spec: Specifier, published_versions: list[Version], today: datetime.date
) -> Version:
# The most important postcondition is that the incremented version is greater than
# all published versions. This ensures that users who don't pin get the most
Expand Down Expand Up @@ -111,7 +112,7 @@ def compute_stub_version(
base_version_changed = False

ensure_specificity(base_version_parts, stub_specificity)
unused_date = find_unused_date(max_published, base_version_changed, date)
unused_date = find_unused_date(max_published, base_version_changed, today)
new_version_parts = [*base_version_parts[:-1], unused_date.strftime("%Y%m%d")]
new_version = Version(".".join(map(str, new_version_parts)))
assert_compatibility(
Expand All @@ -123,19 +124,25 @@ def compute_stub_version(
return new_version


# `today` can be passed as an argument for testing purposes.
def find_unused_date(
max_published: Version, base_version_changed: bool, date: datetime.date
max_published: Version, base_version_changed: bool, today: datetime.date
) -> datetime.date:
# Is not necessarily a date in case the package predates the switch
# to the current versioning scheme.
last_date = max_published.release[-1]

# If the base version changed, we should always be able to use the current date.
if base_version_changed:
return date
return today

# Make sure that the last published release is not unreasonable large.
assert int(date.strftime("%Y%m%d")) + 14 > max_published.release[-1]
assert int(today.strftime("%Y%m%d")) + 14 > last_date
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does 14 come from here? Is it just arbitrary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. It's very unlikely we publish more than 14 versions in a day.

Copy link
Contributor

Choose a reason for hiding this comment

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

While 13 versions are just a little unlikely, I guess :)

Copy link
Contributor

Choose a reason for hiding this comment

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

While 13 versions are just a little unlikely, I guess :)

a little unlikely, but very unlucky


while int(date.strftime("%Y%m%d")) <= max_published.release[-1]:
date = date + datetime.timedelta(days=1)
return date
new_date = today
while int(new_date.strftime("%Y%m%d")) <= last_date:
new_date += datetime.timedelta(days=1)
return new_date


def assert_compatibility(
Expand Down