Thursday, 29 May 2025

Mypy 1.16 Released

We’ve just uploaded mypy 1.16 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features 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.

Different Property Getter and Setter Types

Mypy now supports using different types for a property getter and setter:

class A:
    _value: int

    @property
    def foo(self) -> int:
        return self._value

    @foo.setter
    def foo(self, x: str | int) -> None:
        try:
            self._value = int(x)
        except ValueError:
            raise Exception(f"'{x}' not valid value for 'foo'")

This was contributed by Ivan Levkivskyi (PR 18510).

Flexible Variable Redefinitions (Experimental)

Mypy now allows unannotated variables to be freely redefined with different types when using the experimental --allow-redefinition-new flag. You will also need to enable --local-partial-types. Mypy will now infer a union type when different types are assigned to a variable:

# mypy: allow-redefinition-new, local-partial-types

def f(n: int, b: bool) -> int | str:
    if b:
        x = n
    else:
        x = str(n)
    # Type of 'x' is int | str here.
    return x

Without the new flag, mypy only supports inferring optional types (X | None) from multiple assignments, but now mypy can infer arbitrary union types.

An unannotated variable can now also have different types in different code locations:

# mypy: allow-redefinition-new, local-partial-types
...

if cond():
    for x in range(n):
        # Type of 'x' is 'int' here
        ...
else:
    for x in ['a', 'b']:
        # Type of 'x' is 'str' here
        ...

We are planning to turn this flag on by default in mypy 2.0, along with --local-partial-types. The feature is still experimental and has known issues, and the semantics may still change in the future. You may need to update or add type annotations when switching to the new behavior, but if you encounter anything unexpected, please create a GitHub issue.

This was contributed by Jukka Lehtosalo (PR 18727, PR 19153).

Stricter Type Checking with Imprecise Types

Mypy can now detect additional errors in code that uses Any types or has missing function annotations.

When calling dict.get(x, None) on an object of type dict[str, Any], this now results in an optional type (in the past it was Any):

def f(d: dict[str, Any]) -> int:
    # Error: Return value is "Any | None" but expected "int"
    return d.get("x", None)

Type narrowing using assignments can result in more precise types in the presence of Any types:

def foo(): ...

def bar(n: int) -> None:
    x = foo()
    # Type of 'x' is 'Any' here
    if n > 5:
        x = str(n)
        # Type of 'x' is 'str' here

When using --check-untyped-defs, unannotated overrides are now checked more strictly against superclass definitions.

Related PRs:

  • Use union types instead of join in binder (Ivan Levkivskyi, PR 18538)
  • Check superclass compatibility of untyped methods if --check-untyped-defs is set (Stanislav Terliakov, PR 18970)

Improvements to Attribute Resolution

This release includes several fixes to inconsistent resolution of attribute, method and descriptor types.

  • Consolidate descriptor handling (Ivan Levkivskyi, PR 18831)
  • Make multiple inheritance checking use common semantics (Ivan Levkivskyi, PR 18876)
  • Make method override checking use common semantics (Ivan Levkivskyi, PR 18870)
  • Fix descriptor overload selection (Ivan Levkivskyi, PR 18868)
  • Handle union types when binding self (Ivan Levkivskyi, PR 18867)
  • Make variable override checking use common semantics (Ivan Levkivskyi, PR 18847)
  • Make descriptor handling behave consistently (Ivan Levkivskyi, PR 18831)

Make Implementation for Abstract Overloads Optional

The implementation can now be omitted for abstract overloaded methods, even outside stubs:

from abc import abstractmethod
from typing import overload

class C:
    @abstractmethod
    @overload
    def foo(self, x: int) -> int: ...

    @abstractmethod
    @overload
    def foo(self, x: str) -> str: ...

    # No implementation required for "foo"

This was contributed by Ivan Levkivskyi (PR 18882).

Option to Exclude Everything in .gitignore

You can now use --exclude-gitignore to exclude everything in a .gitignore file from the mypy build. This behaves similar to excluding the paths using --exclude. We might enable this by default in a future mypy release.

This was contributed by Ivan Levkivskyi (PR 18696).

Selectively Disable Deprecated Warnings

It's now possible to selectively disable warnings generated from warnings.deprecated using the --deprecated-calls-exclude option:

# mypy --enable-error-code deprecated
#      --deprecated-calls-exclude=foo.A
import foo

foo.A().func()  # OK, the deprecated warning is ignored
# file foo.py

from typing_extensions import deprecated

class A:
    @deprecated("Use A.func2 instead")
    def func(self): pass

    ...

Contributed by Marc Mueller (PR 18641)

Annotating Native/Non-Native Classes in Mypyc

You can now declare a class as a non-native class when compiling with mypyc. Unlike native classes, which are extension classes and have an immutable structure, non-native classes are normal Python classes at runtime and are fully dynamic. Example:

from mypy_extensions import mypyc_attr

@mypyc_attr(native_class=False)
class NonNativeClass:
    ...

o = NonNativeClass()

# Ok, even if attribute "foo" not declared in class body
setattr(o, "foo", 1)

Classes are native by default in compiled modules, but classes that use certain features (such as most metaclasses) are implicitly non-native.

You can also explicitly declare a class as native. In this case mypyc will generate an error if it can't compile the class as a native class, instead of falling back to a non-native class:

from mypy_extensions import mypyc_attr
from foo import MyMeta

# Error: Unsupported metaclass for a native class
@mypyc_attr(native_class=True)
class C(metaclass=MyMeta):
    ...

Since native classes are significantly more efficient that non-native classes, you may want to ensure that certain classes always compiled as native classes.

This feature was contributed by Valentin Stanciu (PR 18802).

Mypyc Fixes and Improvements

  • Improve documentation of native and non-native classes (Jukka Lehtosalo, PR 19154)
  • Fix compilation when using Python 3.13 debug build (Valentin Stanciu, PR 19045)
  • Show the reason why a class can't be a native class (Valentin Stanciu, PR 19016)
  • Support await/yield while temporary values are live (Michael J. Sullivan, PR 16305)
  • Fix spilling values with overlapping error values (Jukka Lehtosalo, PR 18961)
  • Fix reference count of spilled register in async def (Jukka Lehtosalo, PR 18957)
  • Add basic optimization for sorted (Marc Mueller, PR 18902)
  • Fix access of class object in a type annotation (Advait Dixit, PR 18874)
  • Optimize list.__imul__ and tuple.__mul__ (Marc Mueller, PR 18887)
  • Optimize list.__add__, list.__iadd__ and tuple.__add__ (Marc Mueller, PR 18845)
  • Add and implement primitive list.copy() (exertustfm, PR 18771)
  • Optimize builtins.repr (Marc Mueller, PR 18844)
  • Support iterating over keys/values/items of dict-bound TypeVar and ParamSpec.kwargs (Stanislav Terliakov, PR 18789)
  • Add efficient primitives for str.strip() etc. (Advait Dixit, PR 18742)
  • Document that strip() etc. are optimized (Jukka Lehtosalo, PR 18793)
  • Fix mypyc crash with enum type aliases (Valentin Stanciu, PR 18725)
  • Optimize str.find and str.rfind (Marc Mueller, PR 18709)
  • Optimize str.__contains__ (Marc Mueller, PR 18705)
  • Fix order of steal/unborrow in tuple unpacking (Ivan Levkivskyi, PR 18732)
  • Optimize str.partition and str.rpartition (Marc Mueller, PR 18702)
  • Optimize str.startswith and str.endswith with tuple argument (Marc Mueller, PR 18678)
  • Improve str.startswith and str.endswith with tuple argument (Marc Mueller, PR 18703)
  • pythoncapi_compat: don't define Py_NULL if it is already defined (Michael R. Crusoe, PR 18699)
  • Optimize str.splitlines (Marc Mueller, PR 18677)
  • Mark dict.setdefault as optimized (Marc Mueller, PR 18685)
  • Support __del__ methods (Advait Dixit, PR 18519)
  • Optimize str.rsplit (Marc Mueller, PR 18673)
  • Optimize str.removeprefix and str.removesuffix (Marc Mueller, PR 18672)
  • Recognize literal types in __match_args__ (Stanislav Terliakov, PR 18636)
  • Fix non extension classes with attribute annotations using forward references (Valentin Stanciu, PR 18577)
  • Use lower-case generic types such as list[t] in documentation (Jukka Lehtosalo, PR 18576)
  • Improve support for frozenset (Marc Mueller, PR 18571)
  • Fix wheel build for cp313-win (Marc Mueller, PR 18560)
  • Reduce impact of immortality (introduced in Python 3.12) on reference counting performance (Jukka Lehtosalo, PR 18459)
  • Update math error messages for 3.14 (Marc Mueller, PR 18534)
  • Update math error messages for 3.14 (2) (Marc Mueller, PR 18949)
  • Replace deprecated _PyLong_new with PyLongWriter API (Marc Mueller, PR 18532)

Fixes to Crashes

  • Traverse module ancestors when traversing reachable graph nodes during dmypy update (Stanislav Terliakov, PR 18906)
  • Fix crash on multiple unpacks in a bare type application (Stanislav Terliakov, PR 18857)
  • Prevent crash when enum/TypedDict call is stored as a class attribute (Stanislav Terliakov, PR 18861)
  • Fix crash on multiple unpacks in a bare type application (Stanislav Terliakov, PR 18857)
  • Fix crash on type inference against non-normal callables (Ivan Levkivskyi, PR 18858)
  • Fix crash on decorated getter in settable property (Ivan Levkivskyi, PR 18787)
  • Fix crash on callable with *args and suffix against Any (Ivan Levkivskyi, PR 18781)
  • Fix crash on deferred supertype and setter override (Ivan Levkivskyi, PR 18649)
  • Fix crashes on incorrectly detected recursive aliases (Ivan Levkivskyi, PR 18625)
  • Report that NamedTuple and dataclass are incompatile instead of crashing (Christoph Tyralla, PR 18633)
  • Fix mypy daemon crash (Valentin Stanciu, PR 19087)

Performance Improvements

These are specific to mypy. Mypyc-related performance improvements are discussed elsewhere.

  • Speed up binding self in trivial cases (Ivan Levkivskyi, PR 19024)
  • Small constraint solver optimization (Aaron Gokaslan, PR 18688)

Documentation Updates

  • Improve documentation of --strict (lenayoung8, PR 18903)
  • Remove a note about from __future__ import annotations (Ageev Maxim, PR 18915)
  • Improve documentation on type narrowing (Tim Hoffmann, PR 18767)
  • Fix metaclass usage example (Georg, PR 18686)
  • Update documentation on extra_checks flag (Ivan Levkivskyi, PR 18537)

Stubgen Improvements

  • Fix TypeAlias handling (Alexey Makridenko, PR 18960)
  • Handle arg=None in C extension modules (Anthony Sottile, PR 18768)
  • Fix valid type detection to allow pipe unions (Chad Dombrova, PR 18726)
  • Include simple decorators in stub files (Marc Mueller, PR 18489)
  • Support positional and keyword-only arguments in stubdoc (Paul Ganssle, PR 18762)
  • Fall back to Incomplete if we are unable to determine the module name (Stanislav Terliakov, PR 19084)

Stubtest Improvements

  • Make stubtest ignore __slotnames__ (Nick Pope, PR 19077)
  • Fix stubtest tests on 3.14 (Jelle Zijlstra, PR 19074)
  • Support for strict_bytes in stubtest (Joren Hammudoglu, PR 19002)
  • Understand override (Shantanu, PR 18815)
  • Better checking of runtime arguments with dunder names (Shantanu, PR 18756)
  • Ignore setattr and delattr inherited from object (Stephen Morton, PR 18325)

Miscellaneous Fixes and Improvements

  • Add --strict-bytes to --strict (wyattscarpenter, PR 19049)
  • Admit that Final variables are never redefined (Stanislav Terliakov, PR 19083)
  • Add special support for @django.cached_property needed in django-stubs (sobolevn, PR 18959)
  • Do not narrow types to Never with binder (Ivan Levkivskyi, PR 18972)
  • Local forward references should precede global forward references (Ivan Levkivskyi, PR 19000)
  • Do not cache module lookup results in incremental mode that may become invalid (Stanislav Terliakov, PR 19044)
  • Only consider meta variables in ambiguous "any of" constraints (Stanislav Terliakov, PR 18986)
  • Allow accessing __init__ on final classes and when __init__ is final (Stanislav Terliakov, PR 19035)
  • Treat varargs as positional-only (A5rocks, PR 19022)
  • Enable colored output for argparse help in Python 3.14 (Marc Mueller, PR 19021)
  • Fix argparse for Python 3.14 (Marc Mueller, PR 19020)
  • dmypy suggest can now suggest through contextmanager-based decorators (Anthony Sottile, PR 18948)
  • Fix __r<magic_methods>__ being used under the same __<magic_method>__ hook (Arnav Jain, PR 18995)
  • Prioritize .pyi from -stubs packages over bundled .pyi (Joren Hammudoglu, PR 19001)
  • Fix missing subtype check case for type[T] (Stanislav Terliakov, PR 18975)
  • Fixes to the detection of redundant casts (Anthony Sottile, PR 18588)
  • Make some parse errors non-blocking (Shantanu, PR 18941)
  • Fix PEP 695 type alias with a mix of type arguments (PEP 696) (Marc Mueller, PR 18919)
  • Allow deeper recursion in mypy daemon, better error reporting (Carter Dodd, PR 17707)
  • Fix swapped errors for frozen/non-frozen dataclass inheritance (Nazrawi Demeke, PR 18918)
  • Fix incremental issue with namespace packages (Shantanu, PR 18907)
  • Exclude irrelevant members when narrowing union overlapping with enum (Stanislav Terliakov, PR 18897)
  • Flatten union before contracting literals when checking subtyping (Stanislav Terliakov, PR 18898)
  • Do not add kw_only dataclass fields to __match_args__ (sobolevn, PR 18892)
  • Fix error message when returning long tuple with type mismatch (Thomas Mattone, PR 18881)
  • Treat TypedDict (old-style) aliases as regular TypedDicts (Stanislav Terliakov, PR 18852)
  • Warn about unused type: ignore comments when error code is disabled (Brian Schubert, PR 18849)
  • Reject duplicate ParamSpec.{args,kwargs} at call site (Stanislav Terliakov, PR 18854)
  • Make detection of enum members more consistent (sobolevn, PR 18675)
  • Admit that **kwargs mapping subtypes may have no direct type parameters (Stanislav Terliakov, PR 18850)
  • Don't suggest types-setuptools for pkg_resources (Shantanu, PR 18840)
  • Suggest scipy-stubs for scipy as non-typeshed stub package (Joren Hammudoglu, PR 18832)
  • Narrow tagged unions in match statements (Gene Parmesan Thomas, PR 18791)
  • Consistently store settable property type (Ivan Levkivskyi, PR 18774)
  • Do not blindly undefer on leaving function (Ivan Levkivskyi, PR 18674)
  • Process superclass methods before subclass methods in semanal (Ivan Levkivskyi, PR 18723)
  • Only defer top-level functions (Ivan Levkivskyi, PR 18718)
  • Add one more type-checking pass (Ivan Levkivskyi, PR 18717)
  • Properly account for member and nonmember in enums (sobolevn, PR 18559)
  • Fix instance vs tuple subtyping edge case (Ivan Levkivskyi, PR 18664)
  • Improve handling of Any/object in variadic generics (Ivan Levkivskyi, PR 18643)
  • Fix handling of named tuples in class match pattern (Ivan Levkivskyi, PR 18663)
  • Fix regression for user config files (Shantanu, PR 18656)
  • Fix dmypy socket issue on GNU/Hurd (Mattias Ellert, PR 18630)
  • Don't assume that for loop body index variable is always set (Jukka Lehtosalo, PR 18631)
  • Fix overlap check for variadic generics (Ivan Levkivskyi, PR 18638)
  • Improve support for functools.partial of overloaded callable protocol (Shantanu, PR 18639)
  • Allow lambdas in except* clauses (Stanislav Terliakov, PR 18620)
  • Fix trailing commas in many multiline string options in pyproject.toml (sobolevn, PR 18624)
  • Allow trailing commas for files setting in mypy.ini and setup.ini (sobolevn, PR 18621)
  • Fix "not callable" issue for @dataclass(frozen=True) with Final attr (sobolevn, PR 18572)
  • Add missing TypedDict special case when checking member access (Stanislav Terliakov, PR 18604)
  • Use lower case list and dict in invariance notes (Jukka Lehtosalo, PR 18594)
  • Fix inference when class and instance match protocol (Ivan Levkivskyi, PR 18587)
  • Remove support for builtins.Any (Marc Mueller, PR 18578)
  • Update the overlapping check for tuples to account for NamedTuples (A5rocks, PR 18564)
  • Fix @deprecated (PEP 702) with normal overloaded methods (Christoph Tyralla, PR 18477)
  • Start propagating end columns/lines for type-arg errors (A5rocks, PR 18533)
  • Improve handling of type(x) is Foo checks (Stanislav Terliakov, PR 18486)
  • Suggest typing.Literal for exit-return error messages (Marc Mueller, PR 18541)
  • Allow redefinitions in except/else/finally (Stanislav Terliakov, PR 18515)
  • Disallow setting Python version using inline config (Shantanu, PR 18497)
  • Improve type inference in tuple multiplication plugin (Shantanu, PR 18521)
  • Add missing line number to yield from with wrong type (Stanislav Terliakov, PR 18518)
  • Hint at argument names when formatting callables with compatible return types in error messages (Stanislav Terliakov, PR 18495)
  • Add better naming and improve compatibility for ad hoc intersections of instances (Christoph Tyralla, PR 18506)

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • A5rocks
  • Aaron Gokaslan
  • Advait Dixit
  • Ageev Maxim
  • Alexey Makridenko
  • Ali Hamdan
  • Anthony Sottile
  • Arnav Jain
  • Brian Schubert
  • bzoracler
  • Carter Dodd
  • Chad Dombrova
  • Christoph Tyralla
  • Dimitri Papadopoulos Orfanos
  • Emma Smith
  • exertustfm
  • Gene Parmesan Thomas
  • Georg
  • Ivan Levkivskyi
  • Jared Hance
  • Jelle Zijlstra
  • Joren Hammudoglu
  • lenayoung8
  • Marc Mueller
  • Mattias Ellert
  • Michael J. Sullivan
  • Michael R. Crusoe
  • Nazrawi Demeke
  • Nick Pope
  • Paul Ganssle
  • Shantanu
  • sobolevn
  • Stanislav Terliakov
  • Stephen Morton
  • Thomas Mattone
  • Tim Hoffmann
  • Tim Ruffing
  • Valentin Stanciu
  • Wesley Collin Wright
  • wyattscarpenter

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

Tuesday, 4 February 2025

Mypy 1.15 Released

Mypy 1.15 Released

We’ve just uploaded mypy 1.15 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.

Performance Improvements

Mypy is up to 40% faster in some use cases. This improvement comes largely from tuning the performance of the garbage collector. Additionally, the release includes several micro-optimizations that may be impactful for large projects.

Contributed by Jukka Lehtosalo (PR 18306, PR 18302, PR 18298, PR 18299).

Mypyc Accelerated Mypy Wheels for ARM Linux

For best performance, mypy can be compiled to C extension modules using mypyc. This makes mypy 3-5x faster than when interpreted with pure Python. We now build and upload mypyc accelerated mypy wheels for manylinux_aarch64 to PyPI, making it easy for Linux users on ARM platforms to realise this speedup -- just pip install the latest mypy.

Contributed by Christian Bundy and Marc Mueller (PR mypy_mypyc-wheels#76, PR mypy_mypyc-wheels#89).

--strict-bytes

By default, mypy treats bytearray and memoryview values as assignable to the bytes type, for historical reasons. Use the --strict-bytes flag to disable this behavior. PEP 688 specified the removal of this special case. The flag will be enabled by default in mypy 2.0.

Contributed by Ali Hamdan (PR 18263) and Shantanu Jain (PR 13952).

Improvements to Reachability Analysis and Partial Type Handling in Loops

This change results in mypy better modelling control flow within loops and hence detecting several previously ignored issues. In some cases, this change may require additional explicit variable annotations.

Contributed by Christoph Tyralla (PR 18180, PR 18433). (Speaking of partial types, remember that we plan to enable --local-partial-types by default in mypy 2.0.)

Better Discovery of Configuration Files

Mypy will now walk up the filesystem (up until a repository or file system root) to discover configuration files. See the mypy configuration file documentation for more details.

Contributed by Mikhail Shiryaev and Shantanu Jain (PR 16965, PR 18482)

Better Line Numbers for Decorators and Slice Expressions

Mypy now uses more correct line numbers for decorators and slice expressions. In some cases, you may have to change the location of a # type: ignore comment.

Contributed by Shantanu Jain (PR 18392, PR 18397).

Drop Support for Python 3.8

Mypy no longer supports running with Python 3.8, which has reached end-of-life. When running mypy with Python 3.9+, it is still possible to type check code that needs to support Python 3.8 with the --python-version 3.8 argument. Support for this will be dropped in the first half of 2025!

Contributed by Marc Mueller (PR 17492).

Mypyc Improvements

  • Fix __init__ for classes with @attr.s(slots=True) (Advait Dixit, PR 18447)
  • Report error for nested class instead of crashing (Valentin Stanciu, PR 18460)
  • Fix InitVar for dataclasses (Advait Dixit, PR 18319)
  • Remove unnecessary mypyc files from wheels (Marc Mueller, PR 18416)
  • Fix issues with relative imports (Advait Dixit, PR 18286)
  • Add faster primitive for some list get item operations (Jukka Lehtosalo, PR 18136)
  • Fix iteration over NamedTuple objects (Advait Dixit, PR 18254)
  • Mark mypyc package with py.typed (bzoracler, PR 18253)
  • Fix list index while checking for Enum class (Advait Dixit, PR 18426)

Stubgen Improvements

  • Improve dataclass init signatures (Marc Mueller, PR 18430)
  • Preserve dataclass_transform decorator (Marc Mueller, PR 18418)
  • Fix UnpackType for 3.11+ (Marc Mueller, PR 18421)
  • Improve self annotations (Marc Mueller, PR 18420)
  • Print InspectError traceback in stubgen walk_packages when verbose is specified (Gareth, PR 18224)

Stubtest Improvements

  • Fix crash with numpy array default values (Ali Hamdan, PR 18353)
  • Distinguish metaclass attributes from class attributes (Stephen Morton, PR 18314)

Fixes to Crashes

  • Prevent crash with Unpack of a fixed tuple in PEP695 type alias (Stanislav Terliakov, PR 18451)
  • Fix crash with --cache-fine-grained --cache-dir=/dev/null (Shantanu, PR 18457)
  • Prevent crashing when match arms use name of existing callable (Stanislav Terliakov, PR 18449)
  • Gracefully handle encoding errors when writing to stdout (Brian Schubert, PR 18292)
  • Prevent crash on generic NamedTuple with unresolved typevar bound (Stanislav Terliakov, PR 18585)

Documentation Updates

  • Add inline tabs to documentation (Marc Mueller, PR 18262)
  • Document any TYPE_CHECKING name works (Shantanu, PR 18443)
  • Update documentation to not mention 3.8 where possible (sobolevn, PR 18455)
  • Mention ignore_errors in exclude documentation (Shantanu, PR 18412)
  • Add Self misuse to common issues (Shantanu, PR 18261)

Other Notable Fixes and Improvements

  • Fix literal context for ternary expressions (Ivan Levkivskyi, PR 18545)
  • Ignore dataclass.__replace__ LSP violations (Marc Mueller, PR 18464)
  • Bind self to the class being defined when checking multiple inheritance (Stanislav Terliakov, PR 18465)
  • Fix attribute type resolution with multiple inheritance (Stanislav Terliakov, PR 18415)
  • Improve security of our GitHub Actions (sobolevn, PR 18413)
  • Unwrap type[Union[...]] when solving type variable constraints (Stanislav Terliakov, PR 18266)
  • Allow Any to match sequence patterns in match/case (Stanislav Terliakov, PR 18448)
  • Fix parent generics mapping when overriding generic attribute with property (Stanislav Terliakov, PR 18441)
  • Add dedicated error code for explicit Any (Shantanu, PR 18398)
  • Reject invalid ParamSpec locations (Stanislav Terliakov, PR 18278)
  • Stop suggesting stubs that have been removed from typeshed (Shantanu, PR 18373)
  • Allow inverting --local-partial-types (Shantanu, PR 18377)
  • Allow to use Final and ClassVar after Python 3.13 (정승원, PR 18358)
  • Update suggestions to include latest stubs in typeshed (Shantanu, PR 18366)
  • Fix --install-types masking failure details (wyattscarpenter, PR 17485)
  • Reject promotions when checking against protocols (Christoph Tyralla, PR 18360)
  • Don't erase type object arguments in diagnostics (Shantanu, PR 18352)
  • Clarify status in dmypy status output (Kcornw, PR 18331)
  • Disallow no-argument generic aliases when using PEP 613 explicit aliases (Brian Schubert, PR 18173)
  • Suppress errors for unreachable branches in conditional expressions (Brian Schubert, PR 18295)
  • Do not allow ClassVar and Final in TypedDict and NamedTuple (sobolevn, PR 18281)
  • Report error if not enough or too many types provided to TypeAliasType (bzoracler, PR 18308)
  • Use more precise context for TypedDict plugin errors (Brian Schubert, PR 18293)
  • Use more precise context for invalid type argument errors (Brian Schubert, PR 18290)
  • Do not allow type[] to contain Literal types (sobolevn, PR 18276)
  • Allow bytearray/bytes comparisons with --strict-bytes (Jukka Lehtosalo, PR 18255)

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Advait Dixit
  • Ali Hamdan
  • Brian Schubert
  • bzoracler
  • Cameron Matsui
  • Christoph Tyralla
  • Gareth
  • Ivan Levkivskyi
  • Jukka Lehtosalo
  • Kcornw
  • Marc Mueller
  • Mikhail f. Shiryaev
  • Shantanu
  • sobolevn
  • Stanislav Terliakov
  • Stephen Morton
  • Valentin Stanciu
  • Viktor Szépe
  • wyattscarpenter
  • 정승원

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

Friday, 20 December 2024

Mypy 1.14 Released

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

Mypy is a static type checker for Python. This release includes new features 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.

Change to Enum Membership Semantics

As per the updated typing specification for enums, enum members must be left unannotated.

class Pet(Enum):
    CAT = 1  # Member attribute
    DOG = 2  # Member attribute

    # New error: Enum members must be left unannotated
    WOLF: int = 3

    species: str  # Considered a non-member attribute

In particular, the specification change can result in issues in type stubs (.pyi files), since historically it was common to leave the value absent:

# In a type stub (.pyi file)

class Pet(Enum):
    # Change in semantics: previously considered members,
    # now non-member attributes
    CAT: int
    DOG: int

    # Mypy will now issue a warning if it detects this
    # situation in type stubs:
    # > Detected enum "Pet" in a type stub with zero
    # > members. There is a chance this is due to a recent
    # > change in the semantics of enum membership. If so,
    # > use member = value to mark an enum member,
    # > instead of member: type

class Pet(Enum):
    # As per the specification, you should now do one of
    # the following:
    DOG = 1  # Member attribute with value 1 and known type
    WOLF = cast(int, ...)  # Member attribute with unknown
                           # value but known type
    LION = ...  # Member attribute with unknown value and
                # unknown type

Contributed by Terence Honles (PR 17207) and

Shantanu Jain (PR 18068).

Support for @deprecated Decorator (PEP 702)

Mypy can now issue errors or notes when code imports a deprecated feature explicitly with a from mod import depr statement, or uses a deprecated feature imported otherwise or defined locally. Features are considered deprecated when decorated with warnings.deprecated, as specified in PEP 702.

You can enable the error code via --enable-error-code=deprecated on the mypy command line or enable_error_code = deprecated in the mypy config file.

Use the command line flag --report-deprecated-as-note or config file option report_deprecated_as_note=True to turn all such errors into notes.

Deprecation errors will be enabled by default in a future mypy version.

This feature was contributed by Christoph Tyralla.

List of changes:

  • Add basic support for PEP 702 (@deprecated) (Christoph Tyralla, PR 17476)
  • Support descriptors with @deprecated (Christoph Tyralla, PR 18090)
  • Make "deprecated" note an error, disabled by default (Valentin Stanciu, PR 18192)
  • Consider all possible type positions with @deprecated (Christoph Tyralla, PR 17926)
  • Improve the handling of explicit type annotations in assignment statements with @deprecated (Christoph Tyralla, PR 17899)

Optionally Analyzing Untyped Modules

Mypy normally doesn't analyze imports from third-party modules (installed using pip, for example) if there are no stubs or a py.typed marker file. To force mypy to analyze these imports, you can now use the --follow-untyped-imports flag or set the follow_untyped_imports config file option to True. This can be set either in the global section of your mypy config file, or individually on a per-module basis.

This feature was contributed by Jannick Kremer.

List of changes:

  • Implement flag to allow type checking of untyped modules (Jannick Kremer, PR 17712)
  • Warn about --follow-untyped-imports (Shantanu, PR 18249)

Support New Style Type Variable Defaults (PEP 696)

Mypy now supports type variable defaults using the new syntax described in PEP 696, which was introduced in Python 3.13. Example:

@dataclass
class Box[T = int]:  # Set default for "T"
    value: T | None = None

reveal_type(Box())                      # type is Box[int], since it's the default
reveal_type(Box(value="Hello World!"))  # type is Box[str]

This feature was contributed by Marc Mueller (PR 17985).

Improved For Loop Index Variable Type Narrowing

Mypy now preserves the literal type of for loop index variables, to support TypedDict lookups. Example:

from typing import TypedDict

class X(TypedDict):
    hourly: int
    daily: int

def func(x: X) -> int:
    s = 0
    for var in ("hourly", "daily"):
        # "Union[Literal['hourly']?, Literal['daily']?]"
        reveal_type(var)

        # x[var] no longer triggers a literal-required error
        s += x[var]
    return s

This was contributed by Marc Mueller (PR 18014).

Mypyc Improvements

  • Document optimized bytes operations and additional str operations (Jukka Lehtosalo, PR 18242)
  • Add primitives and specialization for ord() (Jukka Lehtosalo, PR 18240)
  • Optimize str.encode with specializations for common used encodings (Valentin Stanciu, PR 18232)
  • Fix fall back to generic operation for staticmethod and classmethod (Advait Dixit, PR 18228)
  • Support unicode surrogates in string literals (Jukka Lehtosalo, PR 18209)
  • Fix index variable in for loop with builtins.enumerate (Advait Dixit, PR 18202)
  • Fix check for enum classes (Advait Dixit, PR 18178)
  • Fix loading type from imported modules (Advait Dixit, PR 18158)
  • Fix initializers of final attributes in class body (Jared Hance, PR 18031)
  • Fix name generation for modules with similar full names (aatle, PR 18001)
  • Fix relative imports in __init__.py (Shantanu, PR 17979)
  • Optimize dunder methods (jairov4, PR 17934)
  • Replace deprecated _PyDict_GetItemStringWithError (Marc Mueller, PR 17930)
  • Fix wheel build for cp313-win (Marc Mueller, PR 17941)
  • Use public PyGen_GetCode instead of vendored implementation (Marc Mueller, PR 17931)
  • Optimize calls to final classes (jairov4, PR 17886)
  • Support ellipsis (...) expressions in class bodies (Newbyte, PR 17923)
  • Sync pythoncapi_compat.h (Marc Mueller, PR 17929)
  • Add runtests.py mypyc-fast for running fast mypyc tests (Jukka Lehtosalo, PR 17906)

Stubgen Improvements

  • Do not include mypy generated symbols (Ali Hamdan, PR 18137)
  • Fix FunctionContext.fullname for nested classes (Chad Dombrova, PR 17963)
  • Add flagfile support (Ruslan Sayfutdinov, PR 18061)
  • Add support for PEP 695 and PEP 696 syntax (Ali Hamdan, PR 18054)

Stubtest Improvements

  • Allow the use of --show-traceback and --pdb with stubtest (Stephen Morton, PR 18037)
  • Verify __all__ exists in stub (Sebastian Rittau, PR 18005)
  • Stop telling people to use double underscores (Jelle Zijlstra, PR 17897)

Documentation Updates

  • Update config file documentation (sobolevn, PR 18103)
  • Improve contributor documentation for Windows (ag-tafe, PR 18097)
  • Correct note about --disallow-any-generics flag in documentation (Abel Sen, PR 18055)
  • Further caution against --follow-imports=skip (Shantanu, PR 18048)
  • Fix the edit page buttton link in documentation (Kanishk Pachauri, PR 17933)

Other Notables Fixes and Improvements

  • Show Protocol __call__ for arguments with incompatible types (MechanicalConstruct, PR 18214)
  • Make join and meet symmetric with strict_optional (MechanicalConstruct, PR 18227)
  • Preserve block unreachablility when checking function definitions with constrained TypeVars (Brian Schubert, PR 18217)
  • Do not include non-init fields in the synthesized __replace__ method for dataclasses (Victorien, PR 18221)
  • Disallow TypeVar constraints parameterized by type variables (Brian Schubert, PR 18186)
  • Always complain about invalid varargs and varkwargs (Shantanu, PR 18207)
  • Set default strict_optional state to True (Shantanu, PR 18198)
  • Preserve type variable default None in type alias (Sukhorosov Aleksey, PR 18197)
  • Add checks for invalid usage of continue/break/return in except* block (coldwolverine, PR 18132)
  • Do not consider bare TypeVar not overlapping with None for reachability analysis (Stanislav Terliakov, PR 18138)
  • Special case types.DynamicClassAttribute as property-like (Stephen Morton, PR 18150)
  • Disallow bare ParamSpec in type aliases (Brian Schubert, PR 18174)
  • Move long_description metadata to pyproject.toml (Marc Mueller, PR 18172)
  • Support ==-based narrowing of Optional (Christoph Tyralla, PR 18163)
  • Allow TypedDict assignment of Required item to NotRequired ReadOnly item (Brian Schubert, PR 18164)
  • Allow nesting of Annotated with TypedDict special forms inside TypedDicts (Brian Schubert, PR 18165)
  • Infer generic type arguments for slice expressions (Brian Schubert, PR 18160)
  • Fix checking of match sequence pattern against bounded type variables (Brian Schubert, PR 18091)
  • Fix incorrect truthyness for Enum types and literals (David Salvisberg, PR 17337)
  • Move static project metadata to pyproject.toml (Marc Mueller, PR 18146)
  • Fallback to stdlib json if integer exceeds 64-bit range (q0w, PR 18148)
  • Fix 'or' pattern structural matching exhaustiveness (yihong, PR 18119)
  • Fix type inference of positional parameter in class pattern involving builtin subtype (Brian Schubert, PR 18141)
  • Fix [override] error with no line number when argument node has no line number (Brian Schubert, PR 18122)
  • Fix some dmypy crashes (Ivan Levkivskyi, PR 18098)
  • Fix subtyping between instance type and overloaded (Shantanu, PR 18102)
  • Clean up new_semantic_analyzer config (Shantanu, PR 18071)
  • Issue warning for enum with no members in stub (Shantanu, PR 18068)
  • Fix enum attributes are not members (Terence Honles, PR 17207)
  • Fix crash when checking slice expression with step 0 in tuple index (Brian Schubert, PR 18063)
  • Allow union-with-callable attributes to be overridden by methods (Brian Schubert, PR 18018)
  • Emit [mutable-override] for covariant override of attribute with method (Brian Schubert, PR 18058)
  • Support ParamSpec mapping with functools.partial (Stanislav Terliakov, PR 17355)
  • Fix approved stub ignore, remove normpath (Shantanu, PR 18045)
  • Make disallow-any-unimported flag invertible (Séamus Ó Ceanainn, PR 18030)
  • Filter to possible package paths before trying to resolve a module (falsedrow, PR 18038)
  • Fix overlap check for ParamSpec types (Jukka Lehtosalo, PR 18040)
  • Do not prioritize ParamSpec signatures during overload resolution (Stanislav Terliakov, PR 18033)
  • Fix ternary union for literals (Ivan Levkivskyi, PR 18023)
  • Fix compatibility checks for conditional function definitions using decorators (Brian Schubert, PR 18020)
  • TypeGuard should be bool not Any when matching TypeVar (Evgeniy Slobodkin, PR 17145)
  • Fix convert-cache tool (Shantanu, PR 17974)
  • Fix generator comprehension with mypyc (Shantanu, PR 17969)
  • Fix crash issue when using shadowfile with pretty (Max Chang, PR 17894)
  • Fix multiple nested classes with new generics syntax (Max Chang, PR 17820)
  • Better error for mypy -p package without py.typed (Joe Gordon, PR 17908)
  • Emit error for raise NotImplemented (Brian Schubert, PR 17890)
  • Add is_lvalue attribute to AttributeContext (Brian Schubert, PR 17881)

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • aatle
  • Abel Sen
  • Advait Dixit
  • ag-tafe
  • Alex Waygood
  • Ali Hamdan
  • Brian Schubert
  • Carlton Gibson
  • Chad Dombrova
  • Chelsea Durazo
  • chiri
  • Christoph Tyralla
  • coldwolverine
  • David Salvisberg
  • Ekin Dursun
  • Evgeniy Slobodkin
  • falsedrow
  • Gaurav Giri
  • Ihor
  • Ivan Levkivskyi
  • jairov4
  • Jannick Kremer
  • Jared Hance
  • Jelle Zijlstra
  • jianghuyiyuan
  • Joe Gordon
  • John Doknjas
  • Jukka Lehtosalo
  • Kanishk Pachauri
  • Marc Mueller
  • Max Chang
  • MechanicalConstruct
  • Newbyte
  • q0w
  • Ruslan Sayfutdinov
  • Sebastian Rittau
  • Shantanu
  • sobolevn
  • Stanislav Terliakov
  • Stephen Morton
  • Sukhorosov Aleksey
  • Séamus Ó Ceanainn
  • Terence Honles
  • Valentin Stanciu
  • vasiliy
  • Victorien
  • yihong

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

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.