From 1323ede59c5ab894bb402cddaf53827ab457957f Mon Sep 17 00:00:00 2001 From: Jelle Zijlstra Date: Sun, 9 Jul 2023 21:22:02 -0700 Subject: [PATCH 1/2] Prepare release 23.7.0 --- CHANGES.md | 86 +++++++++++++-------- docs/integrations/source_version_control.md | 4 +- docs/usage_and_configuration/the_basics.md | 6 +- 3 files changed, 58 insertions(+), 38 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index c7389ce57c6..16633abe321 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,97 +6,117 @@ +### Stable style + + + +### Preview style + + + +### Configuration + + + +### Packaging + + + +### Parser + + + +### Performance + + + +### Output + + + +### _Blackd_ + + + +### Integrations + + + +### Documentation + + + +## 23.7.0 + +### Highlights + - Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be supported until further notice (#3765) ### Stable style - - - Fix a bug where an illegal trailing comma was added to return type annotations using PEP 604 unions (#3735) - Fix several bugs and crashes where comments in stub files were removed or mishandled - under some circumstances. (#3745) -- Fix a bug where multi-line open parenthesis magic comment like `type: ignore` were not - correctly parsed (#3740) -- Fix error in AST validation when Black removes trailing whitespace in a type comment + under some circumstances (#3745) +- Fix a crash with multi-line magic comments like `type: ignore` within parentheses (#3740) +- Fix error in AST validation when _Black_ removes trailing whitespace in a type comment (#3773) ### Preview style - - - Implicitly concatenated strings used as function args are no longer wrapped inside parentheses (#3640) - Remove blank lines between a class definition and its docstring (#3692) ### Configuration - - -- 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) - `.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` 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) ### Packaging - - - Upgrade mypyc from 0.991 to 1.3 (#3697) - Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768) ### Parser - - - Add support for the new PEP 695 syntax in Python 3.12 (#3703) ### Performance - - - Speed up _Black_ significantly when the cache is full (#3751) - Avoid importing `IPython` in a case where we wouldn't need it (#3748) ### Output - - - 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) ### _Blackd_ - - - The `blackd` argument parser now shows the default values for options in their help text (#3712) ### Integrations - - - Black is now tested with [`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning) (#3763) - 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 - Add a CITATION.cff file to the root of the repository, containing metadata on how to cite this software (#3723) - - - -- Updated the _classes_ and _exceptions_ documentation in Developer reference to match - the latest ccode base. (#3755) +- Update the _classes_ and _exceptions_ documentation in Developer reference to match + the latest code base (#3755) ## 23.3.0 diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md index 8b8fd658e0e..a9d33d2d853 100644 --- a/docs/integrations/source_version_control.md +++ b/docs/integrations/source_version_control.md @@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you ```yaml repos: - repo: https://github.com/psf/black - rev: 23.3.0 + rev: 23.7.0 hooks: - id: black # 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 repos: - repo: https://github.com/psf/black - rev: 23.3.0 + rev: 23.7.0 hooks: - id: black-jupyter # It is recommended to specify the latest version of Python diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index 2a461487210..f5862edccaa 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -193,8 +193,8 @@ configuration file for consistent results across environments. ```console $ black --version -black, 23.3.0 (compiled: yes) -$ black --required-version 23.3.0 -c "format = 'this'" +black, 23.7.0 (compiled: yes) +$ black --required-version 23.7.0 -c "format = 'this'" format = "this" $ black --required-version 31.5b2 -c "still = 'beta?!'" 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 $ black --version -black, 23.3.0 +black, 23.7.0 ``` #### `--config` From feb58881a5e48247aafeb808e7518f83152a8d2b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 10 Jul 2023 04:23:17 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CHANGES.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 16633abe321..c61ee698c5d 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -60,7 +60,8 @@ PEP 604 unions (#3735) - Fix several bugs and crashes where comments in stub files were removed or mishandled under some circumstances (#3745) -- Fix a crash with multi-line magic comments like `type: ignore` within parentheses (#3740) +- Fix a crash with multi-line magic comments like `type: ignore` within parentheses + (#3740) - Fix error in AST validation when _Black_ removes trailing whitespace in a type comment (#3773) @@ -75,8 +76,8 @@ - The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS` environment variable (#3743) - `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691) -- Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename` and - the `pyproject.toml` found isn't in the current working directory (#3719) +- Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename` + 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 `pyproject.toml`, instead of silently doing the wrong thing (#3764)