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

Pin black to 23.12. #5112

Merged
merged 2 commits into from Jan 26, 2024
Merged

Pin black to 23.12. #5112

merged 2 commits into from Jan 26, 2024

Conversation

vincentmr
Copy link
Contributor

@vincentmr vincentmr commented Jan 26, 2024

Before submitting

Please complete the following checklist when submitting a PR:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    test directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Add a new entry to the doc/releases/changelog-dev.md file, summarizing the
    change, and including a link back to the PR.

  • The PennyLane source code conforms to
    PEP8 standards.
    We check all of our code against Pylint.
    To lint modified files, simply pip install pylint, and then
    run pylint pennylane/path/to/file.py.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Context:
Black just released v24, which changes about 50 files.

Description of the Change:
Pin Black to v23.12.

Benefits:
Everyone gets the same Black version. Fewer formatting changes to track in the future.

Possible Drawbacks:

Related GitHub Issues:

Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (479591a) 99.68% compared to head (0458c2f) 99.68%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5112      +/-   ##
==========================================
- Coverage   99.68%   99.68%   -0.01%     
==========================================
  Files         393      391       -2     
  Lines       35874    35524     -350     
==========================================
- Hits        35762    35412     -350     
  Misses        112      112              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vincentmr vincentmr marked this pull request as ready for review January 26, 2024 14:31
Copy link
Contributor

@AmintorDusko AmintorDusko left a comment

Choose a reason for hiding this comment

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

Thank you for that!

@vincentmr vincentmr requested a review from a team January 26, 2024 14:45
Copy link
Contributor

@Alex-Preciado Alex-Preciado left a comment

Choose a reason for hiding this comment

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

Thanks @vincentmr !! Let's pin for now to remove the blocker. We can prepare a format PR next week.

@vincentmr vincentmr merged commit 321ad70 into master Jan 26, 2024
35 checks passed
@vincentmr vincentmr deleted the ci/pin_black branch January 26, 2024 20:50
albi3ro pushed a commit that referenced this pull request Jan 31, 2024
**Context:**
See #5112. New version of `black` came out, and it auto-formatted a
bunch of files. Most of these changes are backwards-compatible (with
previous versions of `black`) but not all, so it was non-trivial

**Description of the Change:**
Did the following:
```shell
pip install -U black
make format
git add .
pip install black~=23.12
make format
```
At this point, all unstaged changes are non-backwards-compatible lines.
So, I tweaked those lines, ran `make format` to make sure they were good
with old black, then re-ran the above set of commands to ensure it's
forwards-compatible too. I'll inline comment each actual change I made.

**Benefits:**
- devs can use whatever version of `black` they choose, including the
new one
- less pinned packages == more pennylane spirit

**Possible Drawbacks:**
N/A

[sc-55823]
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