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.

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

Add the missing install requirement packaging #225

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

greyli
Copy link
Member

@greyli greyli commented Dec 7, 2023

The packaging lib is not listed in the install_requires list.

https://github.com/greyli/flask-extension-status/actions/runs/7129071225/job/19412328108

Run python -c "from flask import Flask; app = Flask(__name__); from flask_debugtoolbar import DebugToolbarExtension; DebugToolbarExtension(app)"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/opt/hostedtoolcache/Python/3.12.0/x64/lib/python3.12/site-packages/flask_debugtoolbar/__init__.py", line 6, in <module>
    from packaging import version as version_builder
ModuleNotFoundError: No module named 'packaging'
Error: Process completed with exit code 1.

We need to merge this and then make a fix release ASAP.

Copy link
Contributor

@nickjj nickjj left a comment

Choose a reason for hiding this comment

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

Looks good. To keep things easier for users do you want to release 0.14.1 even though this is a meta release to fix releasing 0.14.0?

Optionally do we care about the ordering of these packages? For example do we want to alphabetize them? I'm ok either way.

@greyli
Copy link
Member Author

greyli commented Dec 7, 2023

Looks good. To keep things easier for users do you want to release 0.14.1 even though this is a meta release to fix releasing 0.14.0?

We do need to release 0.14.1 to fix the issue since 0.14.0 won't run correctly.

Optionally do we care about the ordering of these packages? For example do we want to alphabetize them? I'm ok either way.

I don't think we need to care about the order. This packaging will be removed in the next major release (see #224).

@nickjj
Copy link
Contributor

nickjj commented Dec 7, 2023

We do need to release 0.14.1 to fix the issue since 0.14.0 won't run correctly.

If a release fails for something release related sometimes package authors will release 0.14.0.post0 or a variant of the original release number without incrementing the patch number. Post-release segments are documented here: https://packaging.python.org/en/latest/specifications/version-specifiers/#post-releases

Using 0.14.1 is a little more user friendly because it matches what you usually see when thinking about version numbers but using a post-release segment is potentially more technically correct. Although in the past we've incremented the patch version for failed package releases.

After the new release is out, I do suggest we yank 0.14.0, you can see we've yanked previous releases https://pypi.org/project/Flask-DebugToolbar/#history. This will keep the release available if someone wants to reference it directly but installers will ignore it. It's a good indicator to let folks know not to use this version.

Copy link
Member

@jeffwidman jeffwidman left a comment

Choose a reason for hiding this comment

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

Oof, good catch!

@jeffwidman
Copy link
Member

jeffwidman commented Dec 7, 2023

Please don't forget to include the actual text of the failure in your PR / commit description. Links to CI runs will go stale over time as those CI run logs expire.

Also, please update your commit description to match the PR description so that when I do a squash merge I don't have to copy paste the description from the PR description. 😄

@jeffwidman jeffwidman merged commit ab9a41d into pallets-eco:master Dec 7, 2023
10 checks passed
@jeffwidman
Copy link
Member

Also, for anyone blocked by this before we get a bugfix release out, the workaround is simple--just manually install packaging into your environment before running Flask-DebugToolbar.

jeffwidman added a commit that referenced this pull request Dec 7, 2023
We need a `0.14.1` release which will include the bugfix #225.
@jeffwidman jeffwidman mentioned this pull request Dec 7, 2023
@greyli
Copy link
Member Author

greyli commented Dec 8, 2023

Also, please update your commit description to match the PR description so that when I do a squash merge I don't have to copy paste the description from the PR description. 😄

Sorry, will do it next time. I need to write a note on my desk :P

Thanks for the quick action on 0.14.1!

greyli added a commit to greyli/flask-debugtoolbar that referenced this pull request Dec 10, 2023
To prevent issues like pallets-eco#225,
This PR add a minimal test that no extra deps are involved, it only install
the package, then try to import the extension class.

fixes pallets-eco#226
greyli added a commit to greyli/flask-debugtoolbar that referenced this pull request Dec 10, 2023
To prevent issues like pallets-eco#225,
This PR add a minimal test that no extra deps are involved, it only install
the package, then try to import the extension class.

fixes pallets-eco#226
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants