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.

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

Import names from typing directly rather than importing module #13761

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ repos:
name: Run ruff on the test cases
args:
- "--exit-non-zero-on-fix"
- "--select=FA,I,RUF100"
- "--select=FA,I,ICN001,RUF100"
- "--no-force-exclude"
- "--unsafe-fixes"
files: '.*test_cases/.+\.py$'
Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ select = [
"FURB169", # Compare the identities of `{object}` and None instead of their respective types
"FURB177", # Prefer `Path.cwd()` over `Path().resolve()` for current-directory lookups
"FURB187", # Use of assignment of `reversed` on list `{name}`
# Used for lint.flake8-import-conventions.aliases
"ICN001", # `{name}` should be imported as `{asname}`
# Autofixable flake8-use-pathlib only
"PTH201", # Do not pass the current directory explicitly to `Path`
"PTH210", # Invalid suffix passed to `.with_suffix()`
Expand Down Expand Up @@ -203,6 +205,8 @@ ignore = [
"PLC0414", # Import alias does not rename original package
]
"*_pb2.pyi" = [
# Special autogenerated typing --> typing_extensions aliases
"ICN001", # `{name}` should be imported as `{asname}`
# Leave the docstrings as-is, matching source
"D", # pydocstyle
# See comment on black's force-exclude config above
Expand All @@ -212,6 +216,11 @@ ignore = [
[tool.ruff.lint.pydocstyle]
convention = "pep257" # https://docs.astral.sh/ruff/settings/#lint_pydocstyle_convention

[tool.ruff.lint.flake8-import-conventions.aliases]
# Prevent aliasing these, as it causes false-negatives for certain rules
typing_extensions = "typing_extensions"
typing = "typing"

Comment on lines +219 to +223
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This prevents import typing as t

[tool.ruff.lint.isort]
split-on-trailing-comma = false
combine-as-imports = true
Expand Down
12 changes: 6 additions & 6 deletions stdlib/@tests/test_cases/check_re.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

import mmap
import re
import typing as t
from typing import AnyStr, Match, Optional
from typing_extensions import assert_type


def check_search(str_pat: re.Pattern[str], bytes_pat: re.Pattern[bytes]) -> None:
assert_type(str_pat.search("x"), t.Optional[t.Match[str]])
assert_type(bytes_pat.search(b"x"), t.Optional[t.Match[bytes]])
assert_type(bytes_pat.search(bytearray(b"x")), t.Optional[t.Match[bytes]])
assert_type(bytes_pat.search(mmap.mmap(0, 10)), t.Optional[t.Match[bytes]])
assert_type(str_pat.search("x"), Optional[Match[str]])
assert_type(bytes_pat.search(b"x"), Optional[Match[bytes]])
assert_type(bytes_pat.search(bytearray(b"x")), Optional[Match[bytes]])
assert_type(bytes_pat.search(mmap.mmap(0, 10)), Optional[Match[bytes]])


def check_search_with_AnyStr(pattern: re.Pattern[t.AnyStr], string: t.AnyStr) -> re.Match[t.AnyStr]:
def check_search_with_AnyStr(pattern: re.Pattern[AnyStr], string: AnyStr) -> re.Match[AnyStr]:
"""See issue #9591"""
match = pattern.search(string)
if match is None:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
from __future__ import annotations

import typing as t
from typing import Any, KeysView, TypeVar

KT = t.TypeVar("KT")
KT = TypeVar("KT")


class MyKeysView(t.KeysView[KT]):
class MyKeysView(KeysView[KT]):
pass


d: dict[t.Any, t.Any] = {}
d: dict[Any, Any] = {}
dict_keys = type(d.keys())

# This should not cause an error like `Member "register" is unknown`:
Expand Down
7 changes: 3 additions & 4 deletions stdlib/_typeshed/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# See the README.md file in this directory for more information.

import sys
import typing_extensions
from collections.abc import Awaitable, Callable, Iterable, Sequence, Set as AbstractSet, Sized
from dataclasses import Field
from os import PathLike
Expand All @@ -23,7 +22,7 @@ from typing import (
final,
overload,
)
from typing_extensions import Buffer, LiteralString, TypeAlias
from typing_extensions import Buffer, LiteralString, Self as _Self, TypeAlias

_KT = TypeVar("_KT")
_KT_co = TypeVar("_KT_co", covariant=True)
Expand Down Expand Up @@ -329,9 +328,9 @@ class structseq(Generic[_T_co]):
# The second parameter will accept a dict of any kind without raising an exception,
# but only has any meaning if you supply it a dict where the keys are strings.
# https://github.com/python/typeshed/pull/6560#discussion_r767149830
def __new__(cls, sequence: Iterable[_T_co], dict: dict[str, Any] = ...) -> typing_extensions.Self: ...
def __new__(cls, sequence: Iterable[_T_co], dict: dict[str, Any] = ...) -> _Self: ...
if sys.version_info >= (3, 13):
def __replace__(self, **kwargs: Any) -> typing_extensions.Self: ...
def __replace__(self, **kwargs: Any) -> _Self: ...

# Superset of typing.AnyStr that also includes LiteralString
AnyOrLiteralStr = TypeVar("AnyOrLiteralStr", str, bytes, LiteralString) # noqa: Y001
Expand Down
10 changes: 5 additions & 5 deletions stdlib/typing_extensions.pyi
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import abc
import enum
import sys
import typing
from _collections_abc import dict_items, dict_keys, dict_values
from _typeshed import IdentityFunction, Incomplete, Unused
from contextlib import AbstractAsyncContextManager as AsyncContextManager, AbstractContextManager as ContextManager
Expand Down Expand Up @@ -55,6 +54,7 @@ from typing import ( # noqa: Y022,Y037,Y038,Y039
Tuple as Tuple,
Type as Type,
TypedDict as TypedDict,
TypeVar as _TypeVar,
Union as Union,
ValuesView as ValuesView,
_Alias,
Expand Down Expand Up @@ -196,10 +196,10 @@ __all__ = [
"CapsuleType",
]

_T = typing.TypeVar("_T")
_F = typing.TypeVar("_F", bound=Callable[..., Any])
_TC = typing.TypeVar("_TC", bound=type[object])
_T_co = typing.TypeVar("_T_co", covariant=True) # Any type covariant containers.
_T = _TypeVar("_T")
_F = _TypeVar("_F", bound=Callable[..., Any])
_TC = _TypeVar("_TC", bound=type[object])
_T_co = _TypeVar("_T_co", covariant=True) # Any type covariant containers.

class _Final: ... # This should be imported from typing but that breaks pytype

Expand Down
4 changes: 2 additions & 2 deletions stubs/click-default-group/click_default_group.pyi
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import typing as t
from _typeshed import Incomplete
from collections.abc import Sequence

import click

Expand All @@ -23,7 +23,7 @@ class DefaultCommandFormatter:
formatter: click.HelpFormatter
mark: str
def __init__(self, group: click.Group, formatter: click.HelpFormatter, mark: str = ...) -> None: ...
def write_dl(self, rows: t.Sequence[tuple[str, str]], col_max: int = 30, col_spacing: int = -2) -> None: ...
def write_dl(self, rows: Sequence[tuple[str, str]], col_max: int = 30, col_spacing: int = -2) -> None: ...
def __getattr__(self, attr: str) -> Incomplete: ...
# __getattr__ used to ala-derive from click.HelpFormatter:
# indent_increment: int
Expand Down
11 changes: 5 additions & 6 deletions stubs/click-log/click_log/options.pyi
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import logging
import typing as t
from collections.abc import Callable
from typing import Any, TypeVar
from typing_extensions import TypeAlias

import click

_AnyCallable: TypeAlias = t.Callable[..., t.Any]
_FC = t.TypeVar("_FC", bound=_AnyCallable | click.Command)
_AnyCallable: TypeAlias = Callable[..., Any]
_FC = TypeVar("_FC", bound=_AnyCallable | click.Command)

def simple_verbosity_option(
logger: logging.Logger | str | None = None, *names: str, **kwargs: t.Any
) -> t.Callable[[_FC], _FC]: ...
def simple_verbosity_option(logger: logging.Logger | str | None = None, *names: str, **kwargs: Any) -> Callable[[_FC], _FC]: ...
10 changes: 6 additions & 4 deletions stubs/click-web/click_web/web_click_types.pyi
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import re
import typing as t
from typing import TypeVar

import click

_T = TypeVar("_T")

class EmailParamType(click.ParamType):
EMAIL_REGEX: re.Pattern[str]
def convert(self, value: t.Any, param: click.Parameter | None, ctx: click.Context | None) -> t.Any: ...
def convert(self, value: str, param: click.Parameter | None, ctx: click.Context | None) -> str: ...

class PasswordParamType(click.ParamType):
def convert(self, value: t.Any, param: click.Parameter | None, ctx: click.Context | None) -> t.Any: ...
def convert(self, value: _T, param: click.Parameter | None, ctx: click.Context | None) -> _T: ...

class TextAreaParamType(click.ParamType):
def convert(self, value: t.Any, param: click.Parameter | None, ctx: click.Context | None) -> t.Any: ...
def convert(self, value: _T, param: click.Parameter | None, ctx: click.Context | None) -> _T: ...
Comment on lines -8 to +16
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pyhedgehog since you added this stub in #13208
Was there a specific reason to have these as Any?


EMAIL_TYPE: EmailParamType
PASSWORD_TYPE: PasswordParamType
Expand Down
4 changes: 2 additions & 2 deletions stubs/corus/corus/third/WikiExtractor.pyi
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import typing
from _typeshed import Incomplete
from collections.abc import Generator
from math import (
Expand All @@ -14,6 +13,7 @@ from math import (
tan as tan,
trunc as trunc,
)
from typing import TypeVar

PY2: Incomplete
text_type = str
Expand Down Expand Up @@ -52,7 +52,7 @@ quote_quote: Incomplete
spaces: Incomplete
dots: Incomplete

_T = typing.TypeVar("_T")
_T = TypeVar("_T")

class Template(list[_T]):
@classmethod
Expand Down