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

Update black version #31

Merged
merged 2 commits into from Mar 30, 2022
Merged

Update black version #31

merged 2 commits into from Mar 30, 2022

Conversation

A-CGray
Copy link
Member

@A-CGray A-CGray commented Mar 29, 2022

Purpose

Today one of black's dependencies, click, made some breaking changes that broke black. They released a fix but to get it we need to update to black v22.3.0, otherwise all of our black formatting checks that are run with GHA will fail. The other option is to pin click<8.1.0 but that feels like a bad approach.

Expected time until merged

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@A-CGray A-CGray requested a review from ewu63 March 29, 2022 02:15
@ewu63
Copy link
Collaborator

ewu63 commented Mar 29, 2022

Is there really no way to use the older version? Feels kinda nuts that all previous versions of black can no longer be used. I guess the way to bypass this is to not use the GHA but instead manually downgrade click or something.

I'm just hesitant to update because there are formatting changes with 22 which means this would probably fail all the existing formatting in all repos. I guess I'm okay with bumping this but we have to be careful in updating this + getting everyone to update black on their machines.

@A-CGray
Copy link
Member Author

A-CGray commented Mar 29, 2022

My reading of the PR I linked to is that it's either upgrade to 22.3 or pin an old version of click, I could be misunderstanding though

@A-CGray
Copy link
Member Author

A-CGray commented Mar 29, 2022

Looks like this is now causing a failure in the azure jobs too

Copy link
Contributor

@sseraj sseraj left a comment

Choose a reason for hiding this comment

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

I think we should just update the black version.

@ewu63 ewu63 merged commit 5de8acb into main Mar 30, 2022
@ewu63 ewu63 deleted the UpdateBlack branch March 30, 2022 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants