Standardize type comments to form `# type: (value)` (#2097) #4645

ranjodhsingh1729 · 2025-04-07T21:43:49Z

Description

Fixes #2097 – is_type_comment() is wrong
Closes #4572

Summary of Changes:

Modified function signatures across several modules to pass the mode parameter to is_type_comment and make_comment.
Incorporated parts of PR Standardize type comments #4467 by @Pedro-Muller29, particularly the fix in mode.py addressing the unhashable type: mode issue.

Acknowledgment:
Credit to @Pedro-Muller29 for the initial work in PR #4467.

Any suggestions are welcome

Checklist - did you ...

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

Co-authored-by: Pedro Mezacasa Muller <[email protected]>

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

tusharsadhwani · 2025-04-20T11:23:00Z

@ranjodhsingh1729 any reasons for closing the PR? It's fairly large so I haven't found time to review it yet.

ranjodhsingh1729 · 2025-04-20T14:11:01Z

@tusharsadhwani My Bad. I’m new to contributing and assumed I’d made an error when I saw no activity.

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

…RUF001 (PR psf#4694);

cobaltt7

Sorry for the delay in review. Looks pretty good! Just a few small things

src/black/comments.py

src/black/mode.py

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

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<25.9.1,>=25.9.0` -> `<25.11.1,>=25.11.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/black/25.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/25.9.0/25.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.11.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25110) [Compare Source](psf/black@25.9.0...25.11.0) ##### Highlights - Enable base 3.14 support ([#4804](psf/black#4804)) - Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#4805](psf/black#4805)) ##### Stable style - Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#4811](psf/black#4811)) - Comments containing fmt directives now preserve their exact formatting instead of being normalized ([#4811](psf/black#4811)) ##### Preview style - Move `multiline_string_handling` from `--unstable` to `--preview` ([#4760](psf/black#4760)) - Fix bug where module docstrings would be treated as normal strings if preceded by comments ([#4764](psf/black#4764)) - Fix bug where python 3.12 generics syntax split line happens weirdly ([#4777](psf/black#4777)) - Standardize type comments to form `# type: <value>` ([#4645](psf/black#4645)) - Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound statements with semicolon-separated bodies ([#4800](psf/black#4800)) ##### Configuration - Add `no_cache` option to control caching behavior. ([#4803](psf/black#4803)) ##### Packaging - Releases now include arm64 Linux binaries ([#4773](psf/black#4773)) ##### Output - Write unchanged content to stdout when excluding formatting from stdin using pipes ([#4610](psf/black#4610)) ##### *Blackd* - Implemented BlackDClient. This simple python client allows to easily send formatting requests to blackd ([#4774](psf/black#4774)) ##### Integrations - Enable 3.14 base CI ([#4804](psf/black#4804)) - Enhance GitHub Action `psf/black` to support the `required-version` major-version-only "stability" format when using pyproject.toml ([#4770](psf/black#4770)) - Improve error message for vim plugin users. It now handles independently vim version - Vim: Warn on unsupported Vim and Python versions independently ([#4772](psf/black#4772)) - Vim: Print the import paths when importing black fails ([#4675](psf/black#4675)) - Vim: Fix handling of virtualenvs that have a different Python version ([#4675](psf/black#4675)) </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/roboluke/pulls/393 Co-authored-by: renovate[bot] <[email protected]> Co-committed-by: renovate[bot] <[email protected]>

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<25.9.1,>=25.9.0` -> `<25.11.1,>=25.11.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/black/25.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/25.9.0/25.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>psf/black (black)</summary> ### [`v25.11.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#25110) [Compare Source](psf/black@25.9.0...25.11.0) ##### Highlights - Enable base 3.14 support ([#4804](psf/black#4804)) - Add support for the new Python 3.14 t-string syntax introduced by PEP 750 ([#4805](psf/black#4805)) ##### Stable style - Fix bug where comments between `# fmt: off` and `# fmt: on` were reformatted ([#4811](psf/black#4811)) - Comments containing fmt directives now preserve their exact formatting instead of being normalized ([#4811](psf/black#4811)) ##### Preview style - Move `multiline_string_handling` from `--unstable` to `--preview` ([#4760](psf/black#4760)) - Fix bug where module docstrings would be treated as normal strings if preceded by comments ([#4764](psf/black#4764)) - Fix bug where python 3.12 generics syntax split line happens weirdly ([#4777](psf/black#4777)) - Standardize type comments to form `# type: <value>` ([#4645](psf/black#4645)) - Fix `fix_fmt_skip_in_one_liners` preview feature to respect `# fmt: skip` for compound statements with semicolon-separated bodies ([#4800](psf/black#4800)) ##### Configuration - Add `no_cache` option to control caching behavior. ([#4803](psf/black#4803)) ##### Packaging - Releases now include arm64 Linux binaries ([#4773](psf/black#4773)) ##### Output - Write unchanged content to stdout when excluding formatting from stdin using pipes ([#4610](psf/black#4610)) ##### *Blackd* - Implemented BlackDClient. This simple python client allows to easily send formatting requests to blackd ([#4774](psf/black#4774)) ##### Integrations - Enable 3.14 base CI ([#4804](psf/black#4804)) - Enhance GitHub Action `psf/black` to support the `required-version` major-version-only "stability" format when using pyproject.toml ([#4770](psf/black#4770)) - Improve error message for vim plugin users. It now handles independently vim version - Vim: Warn on unsupported Vim and Python versions independently ([#4772](psf/black#4772)) - Vim: Print the import paths when importing black fails ([#4675](psf/black#4675)) - Vim: Fix handling of virtualenvs that have a different Python version ([#4675](psf/black#4675)) </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/epage/pulls/176 Co-authored-by: renovate[bot] <[email protected]> Co-committed-by: renovate[bot] <[email protected]>

ranjodhsingh1729 and others added 2 commits April 8, 2025 02:33

Standardize type comments to form # type: (value) (psf#2097)

a969e00

Co-authored-by: Pedro Mezacasa Muller <[email protected]>

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

a347490

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

ranjodhsingh1729 changed the title ~~Standardize type comments to form # type: (value) (psf#2097)~~ Standardize type comments to form # type: (value) Apr 7, 2025

ranjodhsingh1729 changed the title ~~Standardize type comments to form # type: (value)~~ Standardize type comments to form # type: (value) (#2097) Apr 7, 2025

ranjodhsingh1729 marked this pull request as ready for review April 8, 2025 03:43

ranjodhsingh1729 closed this Apr 20, 2025

ranjodhsingh1729 reopened this Apr 20, 2025

ranjodhsingh1729 and others added 3 commits July 22, 2025 14:55

Merge branch 'main' into standardize-type-comments

523e2a6

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

4233f1e

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

Change the missed NON_BREAKING_SPACE to "\N{NO-BREAK SPACE}" per …

b7abcd4

…RUF001 (PR psf#4694);

cobaltt7 mentioned this pull request Jul 22, 2025

Fix #2097: Recognize type comments with spaces after # #4652

Closed

cobaltt7 reviewed Jul 22, 2025

View reviewed changes

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

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

src/black/mode.py Show resolved Hide resolved

cobaltt7 linked an issue Jul 22, 2025 that may be closed by this pull request

is_type_comment() is wrong #2097

Closed

cobaltt7 mentioned this pull request Jul 22, 2025

Format type: ignore comments #2601

Closed

cobaltt7 linked an issue Jul 22, 2025 that may be closed by this pull request

Format type: ignore comments #2601

Closed

ranjodhsingh1729 and others added 6 commits July 28, 2025 11:28

Clean up unnecessary strip calls as per review

fcc7234

Merge branch 'main' into standardize-type-comments

0bf7ca8

Just triggering CI with something trivial

cb4d8d6

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

320033f

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

Merge branch 'main' into standardize-type-comments

e225afe

Merge branch 'main' into standardize-type-comments

0c4e89b

ranjodhsingh1729 requested a review from cobaltt7 October 18, 2025 05:26

Add the missing newline at the end of the test case

89f6afe

cobaltt7 approved these changes Oct 18, 2025

View reviewed changes

cobaltt7 merged commit 4380e55 into psf:main Oct 18, 2025
45 of 46 checks passed

cobaltt7 mentioned this pull request Nov 29, 2025

Setting the 2026 stable style #4875

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Standardize type comments to form `# type: (value)` (#2097) #4645

Standardize type comments to form `# type: (value)` (#2097) #4645

Uh oh!

ranjodhsingh1729 commented Apr 7, 2025 •

edited by cobaltt7

Loading

Uh oh!

tusharsadhwani commented Apr 20, 2025

Uh oh!

ranjodhsingh1729 commented Apr 20, 2025

Uh oh!

cobaltt7 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Standardize type comments to form # type: (value) (#2097) #4645

Standardize type comments to form # type: (value) (#2097) #4645

Uh oh!

Conversation

ranjodhsingh1729 commented Apr 7, 2025 • edited by cobaltt7 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Any suggestions are welcome

Checklist - did you ...

Uh oh!

tusharsadhwani commented Apr 20, 2025

Uh oh!

ranjodhsingh1729 commented Apr 20, 2025

Uh oh!

cobaltt7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Standardize type comments to form `# type: (value)` (#2097) #4645

Standardize type comments to form `# type: (value)` (#2097) #4645

ranjodhsingh1729 commented Apr 7, 2025 •

edited by cobaltt7

Loading