isort: allow skipping add future annotation imports per file
Closed, ResolvedPublicFeature
Actions

Assigned To

Authored By

	Xqt
	Fri, Feb 6, 10:13 AM

Description

Current Behaviour
isort is currently configured to automatically add from __future__ import annotations to Python modules. However, some files (e.g. configuration modules like pywikibot/config.py or bootstrap scripts such as pwb.py) must not receive this import. At the moment, pwb.py is excluded from the isort hook entirely.

Proposal
Provide a way to exclude specific files from automatically adding the future import while keeping all other isort functionality (e.g. import sorting and formatting) enabled for given files.

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Only skip pwb.py from adding future annotations.	pywikibot/core	master	+2 -2
	isort: allow skipping add future annotation imports per file	pywikibot/core	master	+17 -12

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Stalled		anoexpected	T416145 Use type hints to validate user configuration variables
		Resolved	Feature	Xqt	T416667 isort: allow skipping add future annotation imports per file

Event Timeline

Xqt created this task.Fri, Feb 6, 10:13 AM

Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald TranscriptFri, Feb 6, 10:13 AM

Xqt changed the task status from Open to In Progress.Fri, Feb 6, 10:14 AM

Xqt triaged this task as High priority.

Xqt changed the subtype of this task from "Task" to "Feature Request".

Xqt added a parent task: T416145: Use type hints to validate user configuration variables.

Xqt renamed this task from isort: allow skipping add_future annotation imports per file to isort: allow skipping add future annotation imports per file.Fri, Feb 6, 10:23 AM

Change #1237462 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] isort: allow skipping add future annotation imports per file

https://gerrit.wikimedia.org/r/1237462

gerritbot added a project: Patch-For-Review.Fri, Feb 6, 10:31 AM

Change #1237462 merged by jenkins-bot:

[pywikibot/core@master] isort: allow skipping add future annotation imports per file

https://gerrit.wikimedia.org/r/1237462

Maintenance_bot removed a project: Patch-For-Review.Fri, Feb 6, 11:31 AM

Xqt closed this task as Resolved.Fri, Feb 6, 1:32 PM

JJMC89 awarded a token.Fri, Feb 6, 3:54 PM

Hi @JJMC89, I noticed you dislike this task. This also affects T416145. Since I really value your technical judgement, I’d like to understand your concerns better. Could you share what you think is problematic about it.

Xqt reopened this task as Open.Sun, Feb 8, 8:21 AM

Xqt added a project: Pywikibot-RfCs.

Its not technically problematic. I was just expressing my dislike of the inconsistency in type annotations it creates across the library. The better options is to drop support for EOL python3.9 now or wait until we do. (Also change globals().get('__annotations__', {}) to typing.get_type_hints(sys.modules[__name__]).)

In T416667#11598398, @JJMC89 wrote:

Its not technically problematic. I was just expressing my dislike of the inconsistency in type annotations it creates across the library. The better options is to drop support for EOL python3.9 now or wait until we do. (Also change globals().get('__annotations__', {}) to typing.get_type_hints(sys.modules[__name__]).)

Good catch, thanks a lot. I'll postpone the parent task to Pywikikibot 12.

Change #1239533 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] Only skip pwb.py from adding future annotations.

https://gerrit.wikimedia.org/r/1239533

gerritbot added a project: Patch-For-Review.Sun, Feb 15, 5:20 PM

Xqt closed this task as Resolved.Sun, Feb 15, 5:21 PM

Change #1239533 merged by jenkins-bot:

[pywikibot/core@master] Only skip pwb.py from adding future annotations.

https://gerrit.wikimedia.org/r/1239533

Maintenance_bot removed a project: Patch-For-Review.Sun, Feb 15, 6:30 PM