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

Jump to bottom

Add target-version to black config #9962

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Add target-version to black config #9962

merged 1 commit into from
Nov 19, 2024

Conversation

cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Nov 18, 2024

What do these changes do?

Add target-version option to black config in pyproject.toml and reformat code.
https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version

@cdce8p cdce8p added the bot:chronographer:skip This PR does not need to include a change note label Nov 18, 2024
@cdce8p cdce8p mentioned this pull request Nov 18, 2024
Open
@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Nov 18, 2024

CodSpeed Performance Report

Merging #9962 will not alter performance

Comparing cdce8p:black-master (aa55b72) with master (be31bed)

Summary

✅ 43 untouched benchmarks

@codecov Codecov
Copy link

codecov bot commented Nov 18, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (be31bed) to head (aa55b72).
Report is 53 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #9962   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files         121      121           
  Lines       36707    36707           
  Branches     4381     4381           
=======================================
  Hits        36239    36239           
  Misses        315      315           
  Partials      153      153
Flag Coverage Δ
CI-GHA 98.61% <100.00%> (ø)
OS-Linux 98.30% <100.00%> (ø)
OS-Windows 96.13% <100.00%> (ø)
OS-macOS 97.39% <100.00%> (-0.01%) ⬇️
Py-3.10.11 97.24% <100.00%> (ø)
Py-3.10.15 97.79% <100.00%> (ø)
Py-3.11.10 97.84% <96.15%> (ø)
Py-3.11.9 97.29% <96.15%> (-0.01%) ⬇️
Py-3.12.7 98.36% <96.15%> (-0.01%) ⬇️
Py-3.13.0 98.35% <96.15%> (-0.01%) ⬇️
Py-3.9.13 97.17% <100.00%> (+<0.01%) ⬆️
Py-3.9.20 97.71% <100.00%> (-0.05%) ⬇️
Py-pypy7.3.16 97.32% <100.00%> (+<0.01%) ⬆️
VM-macos 97.39% <100.00%> (-0.01%) ⬇️
VM-ubuntu 98.30% <100.00%> (ø)
VM-windows 96.13% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@bdraco bdraco added backport-3.10 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot labels Nov 18, 2024
@bdraco
Copy link
Member

bdraco commented Nov 18, 2024

If we don't backport, it will increase the chance of conflicts for future backports

@cdce8p
Copy link
Contributor Author

cdce8p commented Nov 18, 2024 •
edited
Loading

If we don't backport, it will increase the chance of conflicts for future backports

Should I do the backports manually tomorrow? I doubt the automatic one would apply cleanly.

Older versions also support older Python versions which in turn might effect the available formatting.

@bdraco
Copy link
Member

bdraco commented Nov 19, 2024 •
edited
Loading

If we don't backport, it will increase the chance of conflicts for future backports

Should I do the backports manually tomorrow? I doubt the automatic one would apply cleanly.

Older versions also support older Python versions which in turn might effect the available formatting.

Will think about the best way overnight. Too much going on right now to work it out.

@asvetlov asvetlov merged commit 00fd4eb into aio-libs:master Nov 19, 2024
42 of 45 checks passed
@patchback Patchback
Copy link
Contributor

patchback bot commented Nov 19, 2024 •
edited
Loading

Backport to 3.10: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 00fd4eb on top of patchback/backports/3.10/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962

Backporting merged PR #9962 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/3.10/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962 upstream/3.10
  4. Now, cherry-pick PR Add target-version to black config #9962 contents into that branch: 
    $ git cherry-pick -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
    If it'll yell at you with something like fatal: Commit 00fd4eb62582caccfc721cb0c36e61f0350c2009 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add target-version to black config #9962 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/3.10/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback Patchback
Copy link
Contributor

patchback bot commented Nov 19, 2024 •
edited
Loading

Backport to 3.11: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 00fd4eb on top of patchback/backports/3.11/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962

Backporting merged PR #9962 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/3.11/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962 upstream/3.11
  4. Now, cherry-pick PR Add target-version to black config #9962 contents into that branch: 
    $ git cherry-pick -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
    If it'll yell at you with something like fatal: Commit 00fd4eb62582caccfc721cb0c36e61f0350c2009 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add target-version to black config #9962 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/3.11/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback Patchback
Copy link
Contributor

patchback bot commented Nov 19, 2024 •
edited
Loading

Backport to 3.12: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 00fd4eb on top of patchback/backports/3.12/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962

Backporting merged PR #9962 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/3.12/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962 upstream/3.12
  4. Now, cherry-pick PR Add target-version to black config #9962 contents into that branch: 
    $ git cherry-pick -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
    If it'll yell at you with something like fatal: Commit 00fd4eb62582caccfc721cb0c36e61f0350c2009 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 00fd4eb62582caccfc721cb0c36e61f0350c2009
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add target-version to black config #9962 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/3.12/00fd4eb62582caccfc721cb0c36e61f0350c2009/pr-9962
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

asvetlov pushed a commit that referenced this pull request Nov 19, 2024
@cdce8p @asvetlov
Add target-version to black config (#9962)
74a937f 
Add `target-version` option to black config in `pyproject.toml` and
reformat code.

https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version
(cherry picked from commit 00fd4eb)
@bdraco
Copy link
Member

bdraco commented Nov 19, 2024 •
edited
Loading

If we don't backport, it will increase the chance of conflicts for future backports

Should I do the backports manually tomorrow? I doubt the automatic one would apply cleanly.
Older versions also support older Python versions which in turn might effect the available formatting.

Will think about the best way overnight. Too much going on right now to work it out.

Probably good to do the manual cherry picks above, and adjust the target versions before pushing, and fix it locally or let the pre-commit bot clean it up.

@bdraco
Copy link
Member

bdraco commented Nov 19, 2024 •
edited
Loading

3.10 is the only version that supports Python 3.8 still.

We will likely only publish another 3.10 if there is a severe regression. At this point it might be dead so we can probably skip back-porting to 3.10

asvetlov pushed a commit that referenced this pull request Nov 19, 2024
@cdce8p @asvetlov
Add target-version to black config (#9962)
5a03c5a 
Add `target-version` option to black config in `pyproject.toml` and
reformat code.

https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version
(cherry picked from commit 00fd4eb)
asvetlov pushed a commit that referenced this pull request Nov 19, 2024
@cdce8p @asvetlov
Add target-version to black config (#9962)
3c218c4 
Add `target-version` option to black config in `pyproject.toml` and
reformat code.

https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version
(cherry picked from commit 00fd4eb)
asvetlov added a commit that referenced this pull request Nov 19, 2024
@asvetlov @cdce8p
Add target-version to black config (#9962) (#9986)
17b005a 
Add `target-version` option to black config in `pyproject.toml` and
reformat code.


https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version
(cherry picked from commit 00fd4eb)

<!-- Thank you for your contribution! -->

## What do these changes do?

<!-- Please give a short brief about these changes. -->

## Are there changes in behavior for the user?

<!-- Outline any notable behaviour for the end users. -->

## Is it a substantial burden for the maintainers to support this?

<!--
Stop right there! Pause. Just for a minute... Can you think of anything
obvious that would complicate the ongoing development of this project?

Try to consider if you'd be able to maintain it throughout the next
5 years. Does it seem viable? Tell us your thoughts! We'd very much
love to hear what the consequences of merging this patch might be...

This will help us assess if your change is something we'd want to
entertain early in the review process. Thank you in advance!
-->

## Related issue number

<!-- Are there any issues opened that will be resolved by merging this
change? -->
<!-- Remember to prefix with 'Fixes' if it should close the issue (e.g.
'Fixes #123'). -->

## Checklist

- [ ] I think the code is well written
- [ ] Unit tests for the changes exist
- [ ] Documentation reflects the changes
- [ ] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [ ] Add a new news fragment into the `CHANGES/` folder
  * name it `<issue_or_pr_num>.<type>.rst` (e.g. `588.bugfix.rst`)
  * if you don't have an issue number, change it to the pull request
    number after creating the PR
    * `.bugfix`: A bug fix for something the maintainers deemed an
      improper undesired behavior that got corrected to match
      pre-agreed expectations.
    * `.feature`: A new behavior, public APIs. That sort of stuff.
    * `.deprecation`: A declaration of future API removals and breaking
      changes in behavior.
    * `.breaking`: When something public is removed in a breaking way.
      Could be deprecated in an earlier release.
    * `.doc`: Notable updates to the documentation structure or build
      process.
    * `.packaging`: Notes for downstreams about unobvious side effects
      and tooling. Changes in the test invocation considerations and
      runtime assumptions.
    * `.contrib`: Stuff that affects the contributor experience. e.g.
      Running tests, building the docs, setting up the development
      environment.
    * `.misc`: Changes that are hard to assign to any of the above
      categories.
  * Make sure to use full sentences with correct case and punctuation,
    for example:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

    Use the past tense or the present tense a non-imperative mood,
    referring to what's changed compared to the last released version
    of this project.

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
asvetlov added a commit that referenced this pull request Nov 19, 2024
@asvetlov @cdce8p
Add target-version to black config (#9962) (#9985)
79f2a94 
Add `target-version` option to black config in `pyproject.toml` and
reformat code.


https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#t-target-version
(cherry picked from commit 00fd4eb)

<!-- Thank you for your contribution! -->

## What do these changes do?

<!-- Please give a short brief about these changes. -->

## Are there changes in behavior for the user?

<!-- Outline any notable behaviour for the end users. -->

## Is it a substantial burden for the maintainers to support this?

<!--
Stop right there! Pause. Just for a minute... Can you think of anything
obvious that would complicate the ongoing development of this project?

Try to consider if you'd be able to maintain it throughout the next
5 years. Does it seem viable? Tell us your thoughts! We'd very much
love to hear what the consequences of merging this patch might be...

This will help us assess if your change is something we'd want to
entertain early in the review process. Thank you in advance!
-->

## Related issue number

<!-- Are there any issues opened that will be resolved by merging this
change? -->
<!-- Remember to prefix with 'Fixes' if it should close the issue (e.g.
'Fixes #123'). -->

## Checklist

- [ ] I think the code is well written
- [ ] Unit tests for the changes exist
- [ ] Documentation reflects the changes
- [ ] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [ ] Add a new news fragment into the `CHANGES/` folder
  * name it `<issue_or_pr_num>.<type>.rst` (e.g. `588.bugfix.rst`)
  * if you don't have an issue number, change it to the pull request
    number after creating the PR
    * `.bugfix`: A bug fix for something the maintainers deemed an
      improper undesired behavior that got corrected to match
      pre-agreed expectations.
    * `.feature`: A new behavior, public APIs. That sort of stuff.
    * `.deprecation`: A declaration of future API removals and breaking
      changes in behavior.
    * `.breaking`: When something public is removed in a breaking way.
      Could be deprecated in an earlier release.
    * `.doc`: Notable updates to the documentation structure or build
      process.
    * `.packaging`: Notes for downstreams about unobvious side effects
      and tooling. Changes in the test invocation considerations and
      runtime assumptions.
    * `.contrib`: Stuff that affects the contributor experience. e.g.
      Running tests, building the docs, setting up the development
      environment.
    * `.misc`: Changes that are hard to assign to any of the above
      categories.
  * Make sure to use full sentences with correct case and punctuation,
    for example:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

    Use the past tense or the present tense a non-imperative mood,
    referring to what's changed compared to the last released version
    of this project.

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
@cdce8p cdce8p deleted the black-master branch November 19, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdraco bdraco bdraco approved these changes

@asvetlov asvetlov asvetlov approved these changes

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

Assignees
No one assigned
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cdce8p @bdraco @asvetlov