Prepare release 23.7.0 (#3776)

This commit is contained in:
Jelle Zijlstra 2023-07-10 17:09:47 -07:00 committed by GitHub
parent 38723bb778
commit 193ee766ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 60 additions and 39 deletions

View File

@ -6,97 +6,118 @@
<!-- Include any especially major or disruptive changes here --> <!-- Include any especially major or disruptive changes here -->
### Stable style
<!-- Changes that affect Black's stable style -->
### Preview style
<!-- Changes that affect Black's preview style -->
### Configuration
<!-- Changes to how Black can be configured -->
### Packaging
<!-- Changes to how Black is packaged, such as dependency requirements -->
### Parser
<!-- Changes to the parser or to version autodetection -->
### Performance
<!-- Changes that improve Black's performance. -->
### Output
<!-- Changes to Black's terminal output and error messages -->
### _Blackd_
<!-- Changes to blackd -->
### Integrations
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
### Documentation
<!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. -->
## 23.7.0
### Highlights
- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be - Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
supported until further notice (#3765) supported until further notice (#3765)
### Stable style ### Stable style
<!-- Changes that affect Black's stable style -->
- Fix a bug where an illegal trailing comma was added to return type annotations using - Fix a bug where an illegal trailing comma was added to return type annotations using
PEP 604 unions (#3735) PEP 604 unions (#3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled - Fix several bugs and crashes where comments in stub files were removed or mishandled
under some circumstances. (#3745) under some circumstances (#3745)
- Fix a bug where multi-line open parenthesis magic comment like `type: ignore` were not - Fix a crash with multi-line magic comments like `type: ignore` within parentheses
correctly parsed (#3740) (#3740)
- Fix error in AST validation when Black removes trailing whitespace in a type comment - Fix error in AST validation when _Black_ removes trailing whitespace in a type comment
(#3773) (#3773)
### Preview style ### Preview style
<!-- Changes that affect Black's preview style -->
- Implicitly concatenated strings used as function args are no longer wrapped inside - Implicitly concatenated strings used as function args are no longer wrapped inside
parentheses (#3640) parentheses (#3640)
- Remove blank lines between a class definition and its docstring (#3692) - Remove blank lines between a class definition and its docstring (#3692)
### Configuration ### Configuration
<!-- Changes to how Black can be configured --> - The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS`
- The `--workers` argument to Black can now be specified via the `BLACK_NUM_WORKERS`
environment variable (#3743) environment variable (#3743)
- `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691) - `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691)
- Fix black not honouring `pyproject.toml` settings when running `--stdin-filename` and - Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename`
the `pyproject.toml` found isn't in the current working directory (#3719) and the `pyproject.toml` found isn't in the current working directory (#3719)
- Black will now error if `exclude` and `extend-exclude` have invalid data types in - _Black_ will now error if `exclude` and `extend-exclude` have invalid data types in
`pyproject.toml`, instead of silently doing the wrong thing (#3764) `pyproject.toml`, instead of silently doing the wrong thing (#3764)
### Packaging ### Packaging
<!-- Changes to how Black is packaged, such as dependency requirements -->
- Upgrade mypyc from 0.991 to 1.3 (#3697) - Upgrade mypyc from 0.991 to 1.3 (#3697)
- Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768) - Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768)
### Parser ### Parser
<!-- Changes to the parser or to version autodetection -->
- Add support for the new PEP 695 syntax in Python 3.12 (#3703) - Add support for the new PEP 695 syntax in Python 3.12 (#3703)
### Performance ### Performance
<!-- Changes that improve Black's performance. -->
- Speed up _Black_ significantly when the cache is full (#3751) - Speed up _Black_ significantly when the cache is full (#3751)
- Avoid importing `IPython` in a case where we wouldn't need it (#3748) - Avoid importing `IPython` in a case where we wouldn't need it (#3748)
### Output ### Output
<!-- Changes to Black's terminal output and error messages -->
- Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728) - Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
- Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749) - Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749)
### _Blackd_ ### _Blackd_
<!-- Changes to blackd -->
- The `blackd` argument parser now shows the default values for options in their help - The `blackd` argument parser now shows the default values for options in their help
text (#3712) text (#3712)
### Integrations ### Integrations
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
- Black is now tested with - Black is now tested with
[`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning) [`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
(#3763) (#3763)
- Update GitHub Action to display black output in the job summary (#3688) - Update GitHub Action to display black output in the job summary (#3688)
- Deprecated `set-output` command in CI test to keep up to date with GitHub's
deprecation announcement (#3757)
### Documentation ### Documentation
- Add a CITATION.cff file to the root of the repository, containing metadata on how to - Add a CITATION.cff file to the root of the repository, containing metadata on how to
cite this software (#3723) cite this software (#3723)
- Update the _classes_ and _exceptions_ documentation in Developer reference to match
<!-- Major changes to documentation and policies. Small docs changes the latest code base (#3755)
don't need a changelog entry. -->
- Updated the _classes_ and _exceptions_ documentation in Developer reference to match
the latest ccode base. (#3755)
## 23.3.0 ## 23.3.0

View File

@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
```yaml ```yaml
repos: repos:
- repo: https://github.com/psf/black - repo: https://github.com/psf/black
rev: 23.3.0 rev: 23.7.0
hooks: hooks:
- id: black - id: black
# It is recommended to specify the latest version of Python # It is recommended to specify the latest version of Python
@ -31,7 +31,7 @@ include Jupyter Notebooks. To use this hook, simply replace the hook's `id: blac
```yaml ```yaml
repos: repos:
- repo: https://github.com/psf/black - repo: https://github.com/psf/black
rev: 23.3.0 rev: 23.7.0
hooks: hooks:
- id: black-jupyter - id: black-jupyter
# It is recommended to specify the latest version of Python # It is recommended to specify the latest version of Python

View File

@ -193,8 +193,8 @@ configuration file for consistent results across environments.
```console ```console
$ black --version $ black --version
black, 23.3.0 (compiled: yes) black, 23.7.0 (compiled: yes)
$ black --required-version 23.3.0 -c "format = 'this'" $ black --required-version 23.7.0 -c "format = 'this'"
format = "this" format = "this"
$ black --required-version 31.5b2 -c "still = 'beta?!'" $ black --required-version 31.5b2 -c "still = 'beta?!'"
Oh no! 💥 💔 💥 The required version does not match the running version! Oh no! 💥 💔 💥 The required version does not match the running version!
@ -285,7 +285,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
```console ```console
$ black --version $ black --version
black, 23.3.0 black, 23.7.0
``` ```
#### `--config` #### `--config`