fix: bug where the doublestar operation had inconsistent formatting. #4154

wannieman98 · 2024-01-16T09:42:26Z

Description

Fixes #4149, which according to the ternary operation expression was not correctly being formatted. This was caused by the existing black's logic to determine whether the base of the exponential expression is simple or not, meaning whether it does not have parenthesis or brackets and such and just accepting naming or dotted lookups. Essentially, the existing logic was to loop over the direction (base backwards, exponential forward) and find whether a bracket or parenthesis existed. This logic worked for the exponential case since it doesn't need to care about chained expressions. This PR is to involve checking whether base is a chained expression and check the expression is simple.

Just to make sure, I added some more complex cases that would cause the bug other than the case mentioned in the issue.

Checklist - did you ...

Add an entry in CHANGES.md if necessary?
Add / update tests if necessary?
Add new / update outdated documentation?

wannieman98 · 2024-01-16T19:54:08Z

Hi! Seems like diff-shades check failed with "6 semaphore objects missing" user warning. From my experience this was a result of memory issue rather than the test actually failing. Could we try running this step again? Thanks!

CHANGES.md

github-actions · 2024-01-17T02:00:57Z

diff-shades reports zero changes comparing this PR (d9d1279) to main (7edb50f).

What is this? | Workflow run | diff-shades documentation

JelleZijlstra · 2024-01-19T00:51:56Z

Thanks! I haven't looked in detail yet, but this likely needs to go into the preview style only if it changes formatting for existing code. (diff-shades didn't find any, but that might just be because the patterns where this makes a difference are rare.)

wannieman98 · 2024-01-25T07:14:45Z

Review would be appreciated!

JelleZijlstra · 2024-01-25T19:21:25Z

Thanks, I'm planning to look at this after the 24.1 release goes out (hopefully today/tomorrow). There's enough in that release already :)

JelleZijlstra

Thanks!

This will need to go in the preview style, so gated behind an if Preview... in mode check (you can see examples elsewhere in the code).

tests/data/cases/power_op_spacing.py

src/black/trans.py

wannieman98 · 2024-01-31T02:45:07Z

Hi @JelleZijlstra, I have addressed the comments, could you kindly review again? Thanks!

JelleZijlstra

Thanks! Getting very close.

src/black/trans.py

src/black/mode.py

tests/data/cases/is_simple_lookup_for_doublestar_expression.py

…ber it is trying to fix

…cessary boolean

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

…Also update test case to use latin letters

for more information, see https://pre-commit.ci

…x grammer issue

…o issue_4149

wannieman98 · 2024-02-05T04:54:01Z

@JelleZijlstra Thanks for the review! Addressed the comments hope this works out :)

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | dependency-groups | major | `<25.0.0,>=24.10.0` -> `<25.2.0,>=25.1.0` | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.1.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#2510) [Compare Source](psf/black@24.10.0...25.1.0) ##### Highlights This release introduces the new 2025 stable style ([#4558](psf/black#4558)), stabilizing the following changes: - Normalize casing of Unicode escape characters in strings to lowercase ([#2916](psf/black#2916)) - Fix inconsistencies in whether certain strings are detected as docstrings ([#4095](psf/black#4095)) - Consistently add trailing commas to typed function parameters ([#4164](psf/black#4164)) - Remove redundant parentheses in if guards for case blocks ([#4214](psf/black#4214)) - Add parentheses to if clauses in case blocks when the line is too long ([#4269](psf/black#4269)) - Whitespace before `# fmt: skip` comments is no longer normalized ([#4146](psf/black#4146)) - Fix line length computation for certain expressions that involve the power operator ([#4154](psf/black#4154)) - Check if there is a newline before the terminating quotes of a docstring ([#4185](psf/black#4185)) - Fix type annotation spacing between `*` and more complex type variable tuple ([#4440](psf/black#4440)) The following changes were not in any previous release: - Remove parentheses around sole list items ([#4312](psf/black#4312)) - Generic function definitions are now formatted more elegantly: parameters are split over multiple lines first instead of type parameter definitions ([#4553](psf/black#4553)) ##### Stable style - Fix formatting cells in IPython notebooks with magic methods and starting or trailing empty lines ([#4484](psf/black#4484)) - Fix crash when formatting `with` statements containing tuple generators/unpacking ([#4538](psf/black#4538)) ##### Preview style - Fix/remove string merging changing f-string quotes on f-strings with internal quotes ([#4498](psf/black#4498)) - Collapse multiple empty lines after an import into one ([#4489](psf/black#4489)) - Prevent `string_processing` and `wrap_long_dict_values_in_parens` from removing parentheses around long dictionary values ([#4377](psf/black#4377)) - Move `wrap_long_dict_values_in_parens` from the unstable to preview style ([#4561](psf/black#4561)) ##### Packaging - Store license identifier inside the `License-Expression` metadata field, see [PEP 639](https://peps.python.org/pep-0639/). ([#4479](psf/black#4479)) ##### Performance - Speed up the `is_fstring_start` function in Black's tokenizer ([#4541](psf/black#4541)) ##### Integrations - If using stdin with `--stdin-filename` set to a force excluded path, stdin won't be formatted. ([#4539](psf/black#4539)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tainton.uk/repos/PwnedPW/pulls/283 Reviewed-by: Luke Tainton <luke@tainton.uk> Co-authored-by: Renovate [BOT] <renovate-bot@git.tainton.uk> Co-committed-by: Renovate [BOT] <renovate-bot@git.tainton.uk>

wannieman98 marked this pull request as ready for review January 16, 2024 09:47

wannieman98 changed the title ~~Fix a bug where the doublestar operation had inconsistent formatting.~~ fix: bug where the doublestar operation had inconsistent formatting. Jan 16, 2024

cobaltt7 reviewed Jan 17, 2024

View reviewed changes

CHANGES.md Outdated Show resolved Hide resolved

wannieman98 mentioned this pull request Jan 17, 2024

Inconsistent formatting of ** in tenary expression. #4149

Closed

JelleZijlstra self-requested a review January 19, 2024 00:51

JelleZijlstra requested changes Jan 27, 2024

View reviewed changes

wannieman98 requested a review from JelleZijlstra January 28, 2024 09:15

JelleZijlstra reviewed Jan 31, 2024

View reviewed changes

src/black/trans.py Outdated Show resolved Hide resolved

src/black/mode.py Show resolved Hide resolved

tests/data/cases/is_simple_lookup_for_doublestar_expression.py Outdated Show resolved Hide resolved

wannieman98 and others added 11 commits February 4, 2024 19:16

Fix a bug where the doublestar operation had inconsistent formatting.

b93bf4a

Update CHANGES.md to include the correct PR number, not the issue num…

09d1e92

…ber it is trying to fix

Move the change log to the unreleased section

5da10ac

Move the changes comment into the preview section and remove the unne…

e9bdca6

…cessary boolean

Update CHANGES.md from /*/* to **

2bbe85d

Apply suggestions from code review

e2fa9f6

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Add the newly updated is simple lookup function to the preview mode. …

a6a22f3

…Also update test case to use latin letters

Update power_op_spacing.py

a241946

Update trans.py docstring for handle_is_simple_look_up_prev

addc702

Update trans.py

f7e1621

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

f514570

for more information, see https://pre-commit.ci

wannieman98 force-pushed the issue_4149 branch from e56874d to f514570 Compare February 5, 2024 03:26

pre-commit-ci bot and others added 3 commits February 5, 2024 03:26

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

f2b7774

for more information, see https://pre-commit.ci

Address comments in the revision to remove duplicate test case and fi…

75c965e

…x grammer issue

Merge branch 'issue_4149' of https://github.com/wannieman98/black int…

Loading
Loading status checks…

532e6b2

…o issue_4149

wannieman98 requested a review from JelleZijlstra February 5, 2024 04:52

Merge branch 'main' into issue_4149

Loading
Loading status checks…

d9d1279

JelleZijlstra approved these changes Feb 5, 2024

View reviewed changes

JelleZijlstra merged commit 32230e6 into psf:main Feb 5, 2024
46 checks passed

wannieman98 deleted the issue_4149 branch February 7, 2024 05:17

MichaReiser mentioned this pull request Sep 16, 2024

Ruff 2025 style guide astral-sh/ruff#13371

Closed

29 tasks

JelleZijlstra mentioned this pull request Dec 4, 2024

Setting the 2025 stable style #4522

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: bug where the doublestar operation had inconsistent formatting. #4154

fix: bug where the doublestar operation had inconsistent formatting. #4154

wannieman98 commented Jan 16, 2024 •

edited

Loading

wannieman98 commented Jan 16, 2024

github-actions bot commented Jan 17, 2024 •

edited

Loading

JelleZijlstra commented Jan 19, 2024

wannieman98 commented Jan 25, 2024

JelleZijlstra commented Jan 25, 2024

JelleZijlstra left a comment

wannieman98 commented Jan 31, 2024

JelleZijlstra left a comment

wannieman98 commented Feb 5, 2024

fix: bug where the doublestar operation had inconsistent formatting. #4154

fix: bug where the doublestar operation had inconsistent formatting. #4154

Conversation

wannieman98 commented Jan 16, 2024 • edited Loading

Description

Checklist - did you ...

wannieman98 commented Jan 16, 2024

github-actions bot commented Jan 17, 2024 • edited Loading

JelleZijlstra commented Jan 19, 2024

wannieman98 commented Jan 25, 2024

JelleZijlstra commented Jan 25, 2024

JelleZijlstra left a comment

Choose a reason for hiding this comment

wannieman98 commented Jan 31, 2024

JelleZijlstra left a comment

Choose a reason for hiding this comment

wannieman98 commented Feb 5, 2024

wannieman98 commented Jan 16, 2024 •

edited

Loading

github-actions bot commented Jan 17, 2024 •

edited

Loading