Monday 28 October 2024

Mypy 1.13 Released

We’ve just uploaded mypy 1.13 to the Python Package Index (PyPI).

Mypy is a static type checker for Python. You can install it as follows:

    python3 -m pip install -U mypy

You can read the full documentation for this release on Read the Docs.

Note that unlike typical releases, Mypy 1.13 does not have any changes to type checking semantics from 1.12.1.

Improved Performance

Mypy 1.13 contains several performance improvements. Users can expect mypy to be 5-20% faster.

In environments with long search paths (such as environments using many editable installs), mypy can be significantly faster, e.g. 2.2x faster in the use case targeted by these improvements.

Mypy 1.13 allows use of the orjson library for handling the cache instead of the stdlib json, for improved performance. You can ensure the presence of orjson using the faster-cache extra:

    python3 -m pip install -U mypy[faster-cache]

Mypy may depend on orjson by default in the future.

These improvements were contributed by Shantanu.

List of changes:

  • Significantly speed up file handling error paths (Shantanu, PR 17920)
  • Use fast path in modulefinder more often (Shantanu, PR 17950)
  • Let mypyc optimise os.path.join (Shantanu, PR 17949)
  • Make is_sub_path faster (Shantanu, PR 17962)
  • Speed up stubs suggestions (Shantanu, PR 17965)
  • Use sha1 for hashing (Shantanu, PR 17953)
  • Use orjson instead of json, when available (Shantanu, PR 17955)
  • Add faster-cache extra, test in CI (Shantanu, PR 17978)

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Shantanu Jain
  • Jukka Lehtosalo

Monday 14 October 2024

Mypy 1.12 Released

We’ve just uploaded mypy 1.12 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes.

You can install it as follows:

    python3 -m pip install -U mypy

You can read the full documentation for this release on Read the Docs.

Support Python 3.12 Syntax for Generics (PEP 695)

Support for the new type parameter syntax introduced in Python 3.12 is now enabled by default, documented, and no longer experimental. It was available through a feature flag in mypy 1.11 as an experimental feature.

This example demonstrates the new syntax:

    # Generic function
    def f[T](x: T) -> T: ...

    reveal_type(f(1))  # Revealed type is 'int'

    # Generic class
    class C[T]:
        def __init__(self, x: T) -> None:
           self.x = x

    c = C('a')
    reveal_type(c.x)  # Revealed type is 'str'

    # Type alias
    type A[T] = C[list[T]]

For more information, refer to the documentation.

These improvements are included:

  • Document Python 3.12 type parameter syntax (Jukka Lehtosalo, PR 17816)
  • Further documentation updates (Jukka Lehtosalo, PR 17826)
  • Allow Self return types with contravariance (Jukka Lehtosalo, PR 17786)
  • Enable new type parameter syntax by default (Jukka Lehtosalo, PR 17798)
  • Generate error if new-style type alias used as base class (Jukka Lehtosalo, PR 17789)
  • Inherit variance if base class has explicit variance (Jukka Lehtosalo, PR 17787)
  • Fix crash on invalid type var reference (Jukka Lehtosalo, PR 17788)
  • Fix covariance of frozen dataclasses (Jukka Lehtosalo, PR 17783)
  • Allow covariance with attribute that has "_" name prefix (Jukka Lehtosalo, PR 17782)
  • Support Annotated[...] in new-style type aliases (Jukka Lehtosalo, PR 17777)
  • Fix nested generic classes (Jukka Lehtosalo, PR 17776)
  • Add detection and error reporting for the use of incorrect expressions within the scope of a type parameter and a type alias (Kirill Podoprigora, PR 17560)

Basic Support for Python 3.13

This release adds partial support for Python 3.13 features and compiled binaries for Python 3.13. Mypyc now also supports Python 3.13.

In particular, these features are supported:

  • Various new stdlib features and changes (through typeshed stub improvements)
  • typing.ReadOnly (see below for more)
  • typing.TypeIs (added in mypy 1.10, PEP 742)
  • Type parameter defaults when using the legacy syntax (PEP 696)

These features are not supported yet:

  • warnings.deprecated (PEP 702)
  • Type parameter defaults when using Python 3.12 type parameter syntax

Mypyc Support for Python 3.13

Mypyc now supports Python 3.13. This was contributed by Marc Mueller, with additional fixes by Jukka Lehtosalo. Free threaded Python 3.13 builds are not supported yet.

List of changes:

  • Add additional includes for Python 3.13 (Marc Mueller, PR 17506)
  • Add another include for Python 3.13 (Marc Mueller, PR 17509)
  • Fix ManagedDict functions for Python 3.13 (Marc Mueller, PR 17507)
  • Update mypyc test output for Python 3.13 (Marc Mueller, PR 17508)
  • Fix PyUnicode functions for Python 3.13 (Marc Mueller, PR 17504)
  • Fix _PyObject_LookupAttrId for Python 3.13 (Marc Mueller, PR 17505)
  • Fix _PyList_Extend for Python 3.13 (Marc Mueller, PR 17503)
  • Fix gen_is_coroutine for Python 3.13 (Marc Mueller, PR 17501)
  • Fix _PyObject_FastCall for Python 3.13 (Marc Mueller, PR 17502)
  • Avoid uses of _PyObject_CallMethodOneArg on 3.13 (Jukka Lehtosalo, PR 17526)
  • Don't rely on _PyType_CalculateMetaclass on 3.13 (Jukka Lehtosalo, PR 17525)
  • Don't use _PyUnicode_FastCopyCharacters on 3.13 (Jukka Lehtosalo, PR 17524)
  • Don't use _PyUnicode_EQ on 3.13, as it's no longer exported (Jukka Lehtosalo, PR 17523)

Inferring Unions for Conditional Expressions

Mypy now always tries to infer a union type for a conditional expression if left and right operand types are different. This results in more precise inferred types and lets mypy detect more issues. Example:

    s = "foo" if cond() else 1
    # Type of "s" is now "str | int" (it used to be "object")

Notably, if one of the operands has type Any, the type of a conditional expression is now <type> | Any. Previously the inferred type was just Any. The new type essentially indicates that the value can be of type <type>, and potentially of some (unknown) type.

Most operations performed on the result must also be valid for <type>.

Example where this is relevant:

    from typing import Any

    def func(a: Any, b: bool) -> None:
        x = a if b else None
        # Type of x is "Any | None"
        print(x.y)  # Error: None has no attribute "y"

This feature was contributed by Ivan Levkivskyi (PR 17427).

ReadOnly Support for TypedDict (PEP 705)

You can now use typing.ReadOnly to specity TypedDict items as read-only (PEP 705):

    from typing import TypedDict

    # Or "from typing ..." on Python 3.13
    from typing_extensions import ReadOnly

    class TD(TypedDict):
        a: int
        b: ReadOnly[int]

    d: TD = {"a": 1, "b": 2}
    d["a"] = 3  # OK
    d["b"] = 5  # Error: "b" is ReadOnly

This feature was contributed by Nikita Sobolev (PR 17644).

Python 3.8 End of Life Approaching

We are planning to drop support for Python 3.8 in the next mypy feature release or the one after that. Python 3.8 reaches end of life in October 2024.

Planned Changes to Defaults

We are planning to enable --local-partial-types by default in mypy 2.0. This will often require at least minor code changes. This option is implicitly enabled by mypy daemon, so this makes the behavior of daemon and non-daemon modes consistent.

We recommend that mypy users start using local partial types soon (or to explicitly disable them) to prepare for the change.

This can also be configured in a mypy configuration file:

    local_partial_types = True

For more information, refer to the documentation.

Documentation Updates

Mypy documentation now uses modern syntax variants and imports in many examples. Some examples no longer work on Python 3.8, which is the earliest Python version that mypy supports.

Notably, Iterable and other protocols/ABCs are imported from collections.abc instead of typing:

    from collections.abc import Iterable, Callable

Examples also avoid the upper-case aliases to built-in types: list[str] is used instead of List[str]. The X | Y union type syntax introduced in Python 3.10 is also now prevalent.

List of documentation updates:

  • Document --output=json CLI option (Edgar Ramírez Mondragón, PR 17611)
  • Update various references to deprecated type aliases in docs (Jukka Lehtosalo, PR 17829)
  • Make "X | Y" union syntax more prominent in documentation (Jukka Lehtosalo, PR 17835)
  • Discuss upper bounds before self types in documentation (Jukka Lehtosalo, PR 17827)
  • Make changelog visible in mypy documentation (quinn-sasha, PR 17742)
  • List all incomplete features in --enable-incomplete-feature docs (sobolevn, PR 17633)
  • Remove the explicit setting of a pygments theme (Pradyun Gedam, PR 17571)
  • Document ReadOnly with TypedDict (Jukka Lehtosalo, PR 17905)
  • Document TypeIs (Chelsea Durazo, PR 17821)

Experimental Inline TypedDict Syntax

Mypy now supports a non-standard, experimental syntax for defining anonymous TypedDicts.

Example:

    def func(n: str, y: int) -> {"name": str, "year": int}:
        return {"name": n, "year": y}

The feature is disabled by default. Use --enable-incomplete-feature=InlineTypedDict to enable it. We might remove this feature in a future release.

This feature was contributed by Ivan Levkivskyi (PR 17457).

Stubgen Improvements

  • Fix crash on literal class-level keywords (sobolevn, PR 17663)
  • Stubgen add --version (sobolevn, PR 17662)
  • Fix stubgen --no-analysis/--parse-only docs (sobolevn, PR 17632)
  • Include keyword only args when generating signatures in stubgenc (Eric Mark Martin, PR 17448)
  • Add support for detecting Literal types when extracting types from docstrings (Michael Carlstrom, PR 17441)
  • Use Generator type var defaults (Sebastian Rittau, PR 17670)

Stubtest Improvements

  • Add support for cached_property (Ali Hamdan, PR 17626)
  • Add enable_incomplete_feature validation to stubtest (sobolevn, PR 17635)
  • Fix error code handling in stubtest with --mypy-config-file (sobolevn, PR 17629)

Other Notables Fixes and Improvements

  • Report error if using unsupported type parameter defaults (Jukka Lehtosalo, PR 17876)
  • Fix re-processing cross-reference in mypy daemon when node kind changes (Ivan Levkivskyi, PR 17883)
  • Don't use equality to narrow when value is IntEnum/StrEnum (Jukka Lehtosalo, PR 17866)
  • Don't consider None vs IntEnum comparison ambiguous (Jukka Lehtosalo, PR 17877)
  • Fix narrowing of IntEnum and StrEnum types (Jukka Lehtosalo, PR 17874)
  • Filter overload items based on self type during type inference (Jukka Lehtosalo, PR 17873)
  • Enable negative narrowing of union TypeVar upper bounds (Brian Schubert, PR 17850)
  • Fix issue with member expression formatting (Brian Schubert, PR 17848)
  • Avoid type size explosion when expanding types (Jukka Lehtosalo, PR 17842)
  • Fix negative narrowing of tuples in match statement (Brian Schubert, PR 17817)
  • Narrow falsey str/bytes/int to literal type (Brian Schubert, PR 17818)
  • Test against latest Python 3.13, make testing 3.14 easy (Shantanu, PR 17812)
  • Reject ParamSpec-typed callables calls with insufficient arguments (Stanislav Terliakov, PR 17323)
  • Fix crash when passing too many type arguments to generic base class accepting single ParamSpec (Brian Schubert, PR 17770)
  • Fix TypeVar upper bounds sometimes not being displayed in pretty callables (Brian Schubert, PR 17802)
  • Added error code for overlapping function signatures (Katrina Connors, PR 17597)
  • Check for truthy-bool in not ... unary expressions (sobolevn, PR 17773)
  • Add missing lines-covered and lines-valid attributes (Soubhik Kumar Mitra, PR 17738)
  • Fix another crash scenario with recursive tuple types (Ivan Levkivskyi, PR 17708)
  • Resolve TypeVar upper bounds in functools.partial (Shantanu, PR 17660)
  • Always reset binder when checking deferred nodes (Ivan Levkivskyi, PR 17643)
  • Fix crash on a callable attribute with single unpack (Ivan Levkivskyi, PR 17641)
  • Fix mismatched signature between checker plugin API and implementation (bzoracler, PR 17343)
  • Indexing a type also produces a GenericAlias (Shantanu, PR 17546)
  • Fix crash on self-type in callable protocol (Ivan Levkivskyi, PR 17499)
  • Fix crash on NamedTuple with method and error in function (Ivan Levkivskyi, PR 17498)
  • Add __replace__ for dataclasses in 3.13 (Max Muoto, PR 17469)
  • Fix help message for --no-namespace-packages (Raphael Krupinski, PR 17472)
  • Fix typechecking for async generators (Danny Yang, PR 17452)
  • Fix strict optional handling in attrs plugin (Ivan Levkivskyi, PR 17451)
  • Allow mixing ParamSpec and TypeVarTuple in Generic (Ivan Levkivskyi, PR 17450)
  • Improvements to functools.partial of types (Shantanu, PR 17898)
  • Make ReadOnly TypedDict items covariant (Jukka Lehtosalo, PR 17904)
  • Fix union callees with functools.partial (Jukka Lehtosalo, PR 17903)
  • Improve handling of generic functions with functools.partial (Ivan Levkivskyi, PR 17925)

Typeshed Updates

Please see git log for full list of standard library typeshed stub changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Ali Hamdan
  • Anders Kaseorg
  • Bénédikt Tran
  • Brian Schubert
  • bzoracler
  • Chelsea Durazo
  • Danny Yang
  • Edgar Ramírez Mondragón
  • Eric Mark Martin
  • InSync
  • Ivan Levkivskyi
  • Jordandev678
  • Katrina Connors
  • Kirill Podoprigora
  • Marc Mueller
  • Max Muoto
  • Max Murin
  • Michael Carlstrom
  • Michael I Chen
  • Pradyun Gedam
  • quinn-sasha
  • Raphael Krupinski
  • Sebastian Rittau
  • Shantanu
  • sobolevn
  • Soubhik Kumar Mitra
  • Stanislav Terliakov
  • wyattscarpenter

I’d also like to thank my employer, Dropbox, for supporting mypy development.

Friday 19 July 2024

Mypy 1.11 Released

We’ve just uploaded mypy 1.11 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes. You can install it as follows:

    python3 -m pip install -U mypy

You can read the full documentation for this release on Read the Docs.

Support Python 3.12 Syntax for Generics (PEP 695)

Mypy now supports the new type parameter syntax introduced in Python 3.12 (PEP 695).

This feature is still experimental and must be enabled with the --enable-incomplete-feature=NewGenericSyntax flag, or with enable_incomplete_feature = NewGenericSyntax in the mypy configuration file.

We plan to enable this by default in the next mypy feature release.

This example demonstrates the new syntax:

    # Generic function
    def fT -> T: ...
    
    reveal_type(f(1))  # Revealed type is 'int'
    
    # Generic class
    class C[T]:
        def __init__(self, x: T) -> None:
           self.x = x
    
    c = C('a')
    reveal_type(c.x)  # Revealed type is 'str'
    
    # Type alias
    type A[T] = C[list[T]]

This feature was contributed by Jukka Lehtosalo.

Support for functools.partial

Mypy now type checks uses of functools.partial. Previously mypy would accept arbitrary arguments.

This example will now produce an error:

    from functools import partial
    
    def f(a: int, b: str) -> None: ...
    
    g = partial(f, 1)
    
    # Argument has incompatible type "int"; expected "str"
    g(11)

This feature was contributed by Shantanu (PR 16939).

Stricter Checks for Untyped Overrides

Past mypy versions didn't check if untyped methods were compatible with overridden methods. This would result in false negatives. Now mypy performs these checks when using --check-untyped-defs.

For example, this now generates an error if using --check-untyped-defs:

    class Base:
        def f(self, x: int = 0) -> None: ...
    
    class Derived(Base):
        # Signature incompatible with "Base"
        def f(self): ...

This feature was contributed by Steven Troxler (PR 17276).

Type Inference Improvements

The new polymorphic inference algorithm introduced in mypy 1.5 is now used in more situations. This improves type inference involving generic higher-order functions, in particular.

This feature was contributed by Ivan Levkivskyi (PR 17348).

Mypy now uses unions of tuple item types in certain contexts to enable more precise inferred types. Example:

    for x in (1, 'x'):
        # Previously inferred as 'object'
        reveal_type(x)  # Revealed type is 'int | str'

This was also contributed by Ivan Levkivskyi (PR 17408).

Improvements to Detection of Overlapping Overloads

The details of how mypy checks if two @overload signatures are unsafely overlapping were overhauled. This both fixes some false positives, and allows mypy to detect additional unsafe signatures.

This feature was contributed by Ivan Levkivskyi (PR 17392).

Better Support for Type Hints in Expressions

Mypy now allows more expressions that evaluate to valid type annotations in all expression contexts. The inferred types of these expressions are also sometimes more precise. Previously they were often object.

This example uses a union type that includes a callable type as an expression, and it no longer generates an error:

    from typing import Callable
    
    print(Callable[[], int] | None)  # No error

This feature was contributed by Jukka Lehtosalo (PR 17404).

Mypyc Improvements

Mypyc now supports the new syntax for generics introduced in Python 3.12 (see above). Another notable improvement is signficantly faster basic operations on int values.

  • Support Python 3.12 syntax for generic functions and classes (Jukka Lehtosalo, PR 17357)
  • Support Python 3.12 type alias syntax (Jukka Lehtosalo, PR 17384)
  • Fix ParamSpec (Shantanu, PR 17309)
  • Inline fast paths of integer unboxing operations (Jukka Lehtosalo, PR 17266)
  • Inline tagged integer arithmetic and bitwise operations (Jukka Lehtosalo, PR 17265)
  • Allow specifying primitives as pure (Jukka Lehtosalo, PR 17263)

Changes to Stubtest

  • Ignore _ios_support (Alex Waygood, PR 17270)
  • Improve support for Python 3.13 (Shantanu, PR 17261)

Changes to Stubgen

  • Gracefully handle invalid Optional and recognize aliases to PEP 604 unions (Ali Hamdan, PR 17386)
  • Fix for Python 3.13 (Jelle Zijlstra, PR 17290)
  • Preserve enum value initialisers (Shantanu, PR 17125)

Miscellaneous New Features

  • Add error format support and JSON output option via --output json (Tushar Sadhwani, PR 11396)
  • Support enum.member in Python 3.11+ (Nikita Sobolev, PR 17382)
  • Support enum.nonmember in Python 3.11+ (Nikita Sobolev, PR 17376)
  • Support namedtuple.__replace__ in Python 3.13 (Shantanu, PR 17259)
  • Support rename=True in collections.namedtuple (Jelle Zijlstra, PR 17247)
  • Add support for __spec__ (Shantanu, PR 14739)

Changes to Error Reporting

  • Mention --enable-incomplete-feature=NewGenericSyntax in messages (Shantanu, PR 17462)
  • Do not report plugin-generated methods with explicit-override (sobolevn, PR 17433)
  • Use and display namespaces for function type variables (Ivan Levkivskyi, PR 17311)
  • Fix false positive for Final local scope variable in Protocol (GiorgosPapoutsakis, PR 17308)
  • Use Never in more messages, use ambiguous in join (Shantanu, PR 17304)
  • Log full path to config file in verbose output (dexterkennedy, PR 17180)
  • Added [prop-decorator] code for unsupported property decorators (Christopher Barber, PR 14461">16571)
  • Suppress second error message with := and [truthy-bool] (Nikita Sobolev, PR 15941)
  • Generate error for assignment of functional Enum to variable of different name (Shantanu, PR 16805)
  • Fix error reporting on cached run after uninstallation of third party library (Shantanu, PR 17420)

Fixes for Crashes

  • Fix daemon crash on invalid type in TypedDict (Ivan Levkivskyi, PR 17495)
  • Fix crash and bugs related to partial() (Ivan Levkivskyi, PR 17423)
  • Fix crash when overriding with unpacked TypedDict (Ivan Levkivskyi, PR 17359)
  • Fix crash on TypedDict unpacking for ParamSpec (Ivan Levkivskyi, PR 17358)
  • Fix crash involving recursive union of tuples (Ivan Levkivskyi, PR 17353)
  • Fix crash on invalid callable property override (Ivan Levkivskyi, PR 17352)
  • Fix crash on unpacking self in NamedTuple (Ivan Levkivskyi, PR 17351)
  • Fix crash on recursive alias with an optional type (Ivan Levkivskyi, PR 17350)
  • Fix crash on type comment inside generic definitions (Bénédikt Tran, PR 16849)

Changes to Documentation

  • Use inline config in documentation for optional error codes (Shantanu, PR 17374)
  • Use lower-case generics in documentation (Seo Sanghyeon, PR 17176)
  • Add documentation for show-error-code-links (GiorgosPapoutsakis, PR 17144)
  • Update CONTRIBUTING.md to include commands for Windows (GiorgosPapoutsakis, PR 17142)

Other Notable Improvements and Fixes

  • Fix ParamSpec inference against TypeVarTuple (Ivan Levkivskyi, PR 17431)
  • Fix explicit type for partial (Ivan Levkivskyi, PR 17424)
  • Always allow lambda calls (Ivan Levkivskyi, PR 17430)
  • Fix isinstance checks with PEP 604 unions containing None (Shantanu, PR 17415)
  • Fix self-referential upper bound in new-style type variables (Ivan Levkivskyi, PR 17407)
  • Consider overlap between instances and callables (Ivan Levkivskyi, PR 17389)
  • Allow new-style self-types in classmethods (Ivan Levkivskyi, PR 17381)
  • Fix isinstance with type aliases to PEP 604 unions (Shantanu, PR 17371)
  • Properly handle unpacks in overlap checks (Ivan Levkivskyi, PR 17356)
  • Fix type application for classes with generic constructors (Ivan Levkivskyi, PR 17354)
  • Update typing_extensions to >=4.6.0 to fix Python 3.12 error (Ben Brown, PR 17312)
  • Avoid "does not return" error in lambda (Shantanu, PR 17294)
  • Fix bug with descriptors in non-strict-optional mode (Max Murin, PR 17293)
  • Don’t leak unreachability from lambda body to surrounding scope (Anders Kaseorg, PR 17287)
  • Fix issues with non-ASCII characters on Windows (Alexander Leopold Shon, PR 17275)
  • Fix for type narrowing of negative integer literals (gilesgc, PR 17256)
  • Fix confusion between .py and .pyi files in mypy daemon (Valentin Stanciu, PR 17245)
  • Fix type of tuple[X, Y] expression (urnest, PR 17235)
  • Don't forget that a TypedDict was wrapped in Unpack after a name-defined error occurred (Christoph Tyralla, PR 17226)
  • Mark annotated argument as having an explicit, not inferred type (bzoracler, PR 17217)
  • Don't consider Enum private attributes as enum members (Ali Hamdan, PR 17182)
  • Fix Literal strings containing pipe characters (Jelle Zijlstra, PR 17148)

Typeshed Updates

Please see git log for full list of standard library typeshed stub changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alex Waygood
  • Alexander Leopold Shon
  • Ali Hamdan
  • Anders Kaseorg
  • Ben Brown
  • Bénédikt Tran
  • bzoracler
  • Christoph Tyralla
  • Christopher Barber
  • dexterkennedy
  • gilesgc
  • GiorgosPapoutsakis
  • Ivan Levkivskyi
  • Jelle Zijlstra
  • Jukka Lehtosalo
  • Marc Mueller
  • Matthieu Devlin
  • Michael R. Crusoe
  • Nikita Sobolev
  • Seo Sanghyeon
  • Shantanu
  • sobolevn
  • Steven Troxler
  • Tadeu Manoel
  • Tamir Duberstein
  • Tushar Sadhwani
  • urnest
  • Valentin Stanciu

I’d also like to thank my employer, Dropbox, for supporting mypy development.

Wednesday 24 April 2024

Mypy 1.10 Released

Mypy 1.10 Released

We’ve just uploaded mypy 1.10 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes. You can install it as follows:

    python3 -m pip install -U mypy

You can read the full documentation for this release on Read the Docs.

Support TypeIs (PEP 742)

Mypy now supports TypeIs (PEP 742), which allows functions to narrow the type of a value, similar to isinstance(). Unlike TypeGuard, TypeIs can narrow in both the if and else branches of an if statement:

    from typing_extensions import TypeIs
    
    def is_str(s: object) -> TypeIs[str]:
        return isinstance(s, str)
    
    def f(o: str | int) -> None:
        if is_str(o):
            # Type of o is 'str'
            ...
        else:
            # Type of o is 'int'
            ...
TypeIs will be added to the typing module in Python 3.13, but it can be used on earlier Python versions by importing it from typing_extensions.

This feature was contributed by Jelle Zijlstra (PR 16898).

Support TypeVar Defaults (PEP 696)

PEP 696 adds support for type parameter defaults.

Example:

    from typing import Generic
    from typing_extensions import TypeVar
    
    T = TypeVar("T", default=int)
    
    class C(Generic[T]):
       ...
    
    x: C = ...
    y: C[str] = ...
    reveal_type(x)  # C[int], because of the default
    reveal_type(y)  # C[str]

TypeVar defaults will be added to the typing module in Python 3.13, but they can be used with earlier Python releases by importing TypeVar from typing_extensions.

This feature was contributed by Marc Mueller (PR 16878 and PR 16925).

Support TypeAliasType (PEP 695)

As part of the initial steps towards implementing PEP 695, mypy now supports TypeAliasType. TypeAliasType provides a backport of the new type statement in Python 3.12.

    type ListOrSet[T] = list[T] | set[T]
is equivalent to:
    T = TypeVar("T")
    ListOrSet = TypeAliasType("ListOrSet", list[T] | set[T], type_params=(T,))

Example of use in mypy:

    from typing_extensions import TypeAliasType, TypeVar
    
    NewUnionType = TypeAliasType("NewUnionType", int | str)
    x: NewUnionType = 42
    y: NewUnionType = 'a'
    z: NewUnionType = object()
    # error: Incompatible types in assignment (expression has type "object",
    # variable has type "int | str")  [assignment]
    
    T = TypeVar("T")
    ListOrSet = TypeAliasType("ListOrSet", list[T] | set[T], type_params=(T,))
    a: ListOrSet[int] = [1, 2]
    b: ListOrSet[str] = {'a', 'b'}
    c: ListOrSet[str] = 'test'
    # error: Incompatible types in assignment (expression has type "str",
    # variable has type "list[str] | set[str]")  [assignment]
TypeAliasType was added to the typing module in Python 3.12, but it can be used with earlier Python releases by importing from typing_extensions.

This feature was contributed by Ali Hamdan (PR 16926, PR 17038 and PR 17053)

Detect Additional Unsafe Uses of super()

Mypy will reject unsafe uses of super() more consistently, when the target has a trivial (empty) body. Example:

    class Proto(Protocol):
        def method(self) -> int: ...
    
    class Sub(Proto):
        def method(self) -> int:
            return super().meth()  # Error (unsafe)

This feature was contributed by Shantanu (PR 16756).

Stubgen Improvements

  • Preserve empty tuple annotation (Ali Hamdan, PR 16907)
  • Add support for PEP 570 positional-only parameters (Ali Hamdan, PR 16904)
  • Replace obsolete typing aliases with builtin containers (Ali Hamdan, PR 16780)
  • Fix generated dataclass __init__ signature (Ali Hamdan, PR 16906)

Mypyc Improvements

  • Provide an easier way to define IR-to-IR transforms (Jukka Lehtosalo, PR 16998)
  • Implement lowering pass and add primitives for int (in)equality (Jukka Lehtosalo, PR 17027)
  • Implement lowering for remaining tagged integer comparisons (Jukka Lehtosalo, PR 17040)
  • Optimize away some bool/bit registers (Jukka Lehtosalo, PR 17022)
  • Remangle redefined names produced by async with (Richard Si, PR 16408)
  • Optimize TYPE_CHECKING to False at Runtime (Srinivas Lade, PR 16263)
  • Fix compilation of unreachable comprehensions (Richard Si, PR 15721)
  • Don't crash on non-inlinable final local reads (Richard Si, PR 15719)

Documentation Improvements

  • Import TypedDict from typing instead of typing_extensions (Riccardo Di Maio, PR 16958)
  • Add missing mutable-override to section title (James Braza, PR 16886)

Error Reporting Improvements

  • Use lower-case generics more consistently in error messages (Jukka Lehtosalo, PR 17035)

Other Notable Changes and Fixes

  • Fix incorrect inferred type when accessing descriptor on union type (Matthieu Devlin, PR 16604)
  • Fix crash when expanding invalid Unpack in a Callable alias (Ali Hamdan, PR 17028)
  • Fix false positive when string formatting with string enum (roberfi, PR 16555)
  • Narrow individual items when matching a tuple to a sequence pattern (Loïc Simon, PR 16905)
  • Fix false positive from type variable within TypeGuard or TypeIs (Evgeniy Slobodkin, PR 17071)
  • Improve yield from inference for unions of generators (Shantanu, PR 16717)
  • Fix emulating hash method logic in attrs classes (Hashem, PR 17016)
  • Add reverted typeshed commit that uses ParamSpec for functools.wraps (Tamir Duberstein, PR 16942)
  • Fix type narrowing for types.EllipsisType (Shantanu, PR 17003)
  • Fix single item enum match type exhaustion (Oskari Lehto, PR 16966)
  • Improve type inference with empty collections (Marc Mueller, PR 16994)
  • Fix override checking for decorated property (Shantanu, PR 16856)
  • Fix narrowing on match with function subject (Edward Paget, PR 16503)
  • Allow +N within Literal[...] (Spencer Brown, PR 16910)
  • Experimental: Support TypedDict within type[...] (Marc Mueller, PR 16963)
  • Experimtental: Fix issue with TypedDict with optional keys in type[...] (Marc Mueller, PR 17068)

Typeshed Updates

Please see git log for full list of standard library typeshed stub changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alex Waygood
  • Ali Hamdan
  • Edward Paget
  • Evgeniy Slobodkin
  • Hashem
  • hesam
  • Hugo van Kemenade
  • Ihor
  • James Braza
  • Jelle Zijlstra
  • jhance
  • Jukka Lehtosalo
  • Loïc Simon
  • Marc Mueller
  • Matthieu Devlin
  • Michael R. Crusoe
  • Nikita Sobolev
  • Oskari Lehto
  • Riccardo Di Maio
  • Richard Si
  • roberfi
  • Roman Solomatin
  • Sam Xifaras
  • Shantanu
  • Spencer Brown
  • Srinivas Lade
  • Tamir Duberstein
  • youkaichao

I’d also like to thank my employer, Dropbox, for supporting mypy development.

Friday 8 March 2024

Mypy 1.9 Released

 

Mypy 1.9 Released

We’ve just uploaded mypy 1.9 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes. You can install it as follows:

    python3 -m pip install -U mypy

You can read the full documentation for this release on Read the Docs.

Breaking Changes

Because the version of typeshed we use in mypy 1.9 doesn't support 3.7, neither does mypy 1.9. (Jared Hance, PR 16883)

We are planning to enable local partial types (enabled via the --local-partial-types flag) later this year by default. This change was announced years ago, but now it's finally happening. This is a major backward-incompatible change, so we'll probably include it as part of the upcoming mypy 2.0 release. This makes daemon and non-daemon mypy runs have the same behavior by default.

Local partial types can also be enabled in the mypy config file:

    local_partial_types = True

We are looking at providing a tool to make it easier to migrate projects to use --local-partial-types, but it's not yet clear whether this is practical. The migration usually involves adding some explicit type annotations to module-level and class-level variables.

Basic Support for Type Parameter Defaults (PEP 696)

This release contains new experimental support for type parameter defaults (PEP 696). Please try it out! This feature was contributed by Marc Mueller.

Since this feature will be officially introduced in the next Python feature release (3.13), you will need to import TypeVar, ParamSpec or TypeVarTuple from typing_extensions to use defaults for now.

This example adapted from the PEP defines a default for BotT:

    from typing import Generic
    from typing_extensions import TypeVar
    
    class Bot: ...
    
    <p>BotT = TypeVar("BotT", bound=Bot, default=Bot)
    
    class Context(Generic[BotT]):
        bot: BotT
    
    class MyBot(Bot): ...
    
    # type is Bot (the default)
    reveal_type(Context().bot)
    # type is MyBot
    reveal_type(ContextMyBot.bot)

Type-checking Improvements

  • Fix missing type store for overloads (Marc Mueller, PR 16803)
  • Fix 'WriteToConn' object has no attribute 'flush' (Charlie Denton, PR 16801)
  • Improve TypeAlias error messages (Marc Mueller, PR 16831)
  • Support narrowing unions that include type[None] (Christoph Tyralla, PR 16315)
  • Support TypedDict functional syntax as class base type (anniel-stripe, PR 16703)
  • Accept multiline quoted annotations (Shantanu, PR 16765)
  • Allow unary + in Literal (Jelle Zijlstra, PR 16729)
  • Substitute type variables in return type of static methods (Kouroche Bouchiat, PR 16670)
  • Consider TypeVarTuple to be invariant (Marc Mueller, PR 16759)
  • Add alias support to field() in attrs plugin (Nikita Sobolev, PR 16610)
  • Improve attrs hashability detection (Tin Tvrtković, PR 16556)

Performance Improvements

  • Speed up finding function type variables (Jukka Lehtosalo, PR 16562)

Documentation Updates

  • Document supported values for --enable-incomplete-feature in "mypy --help" (Froger David, PR 16661)
  • Update new type system discussion links (thomaswhaley, PR 16841)
  • Add missing class instantiation to cheat sheet (Aleksi Tarvainen, PR 16817)
  • Document how evil --no-strict-optional is (Shantanu, PR 16731)
  • Improve mypy daemon documentation note about local partial types (Makonnen Makonnen, PR 16782)
  • Fix numbering error (Stefanie Molin, PR 16838)
  • Various documentation improvements (Shantanu, PR 16836)

Stubtest Improvements

  • Ignore private function/method parameters when they are missing from the stub (private parameter names start with a single underscore and have a default, PR 16507)
  • Ignore a new protocol dunder (Alex Waygood, PR 16895)
  • Private parameters can be omitted (Sebastian Rittau, PR 16507)
  • Add support for setting enum members to "..." (Jelle Zijlstra, PR 16807)
  • Adjust symbol table logic (Shantanu, PR 16823)
  • Fix posisitional-only handling in overload resolution (Shantanu, PR 16750)

Stubgen Improvements

  • Fix crash on star unpack of TypeVarTuple (Ali Hamdan, PR 16869)
  • Use PEP 604 unions everywhere (Ali Hamdan, PR 16519)
  • Do not ignore property deleter (Ali Hamdan, PR 16781)
  • Support type stub generation for staticmethod (WeilerMarcel, PR 14934)

Acknowledgements

​Thanks to all mypy contributors who contributed to this release:

  • Aleksi Tarvainen
  • Alex Waygood
  • Ali Hamdan
  • anniel-stripe
  • Charlie Denton
  • Christoph Tyralla
  • Dheeraj
  • Fabian Keller
  • Fabian Lewis
  • Froger David
  • Ihor
  • Jared Hance
  • Jelle Zijlstra
  • Jukka Lehtosalo
  • Kouroche Bouchiat
  • Lukas Geiger
  • Maarten Huijsmans
  • Makonnen Makonnen
  • Marc Mueller
  • Nikita Sobolev
  • Sebastian Rittau
  • Shantanu
  • Stefanie Molin
  • Stephen Morton
  • thomaswhaley
  • Tin Tvrtković
  • WeilerMarcel
  • Wesley Collin Wright
  • zipperer

I’d also like to thank my employer, Dropbox, for supporting mypy development.