Thursday 21 December 2023

Mypy 1.8 Released

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

Type-checking Improvements

  • Do not intersect types in isinstance checks if at least one is final (Christoph Tyralla, PR 16330)
  • Detect that @final class without __bool__ cannot have falsey instances (Ilya Priven, PR 16566)
  • Do not allow TypedDict classes with extra keywords (Nikita Sobolev, PR 16438)
  • Do not allow class-level keywords for NamedTuple (Nikita Sobolev, PR 16526)
  • Make imprecise constraints handling more robust (Ivan Levkivskyi, PR 16502)
  • Fix strict-optional in extending generic TypedDict (Ivan Levkivskyi, PR 16398)
  • Allow type ignores of PEP 695 constructs (Shantanu, PR 16608)
  • Enable type_check_only support for TypedDict and NamedTuple (Nikita Sobolev, PR 16469)

Performance Improvements

  • Add fast path to analyzing special form assignments (Jukka Lehtosalo, PR 16561)

Improvements to Error Reporting

  • Don't show documentation links for plugin error codes (Ivan Levkivskyi, PR 16383)
  • Improve error messages for super checks and add more tests (Nikita Sobolev, PR 16393)
  • Add error code for mutable covariant override (Ivan Levkivskyi, PR 16399)

Stubgen Improvements

  • Preserve simple defaults in function signatures (Ali Hamdan, PR 15355)
  • Include __all__ in output (Jelle Zijlstra, PR 16356)
  • Fix stubgen regressions with pybind11 and mypy 1.7 (Chad Dombrova, PR 16504)

Stubtest Improvements

  • Improve handling of unrepresentable defaults (Jelle Zijlstra, PR 16433)
  • Print more helpful errors if a function is missing from stub (Alex Waygood, PR 16517)
  • Support @type_check_only decorator (Nikita Sobolev, PR 16422)
  • Warn about missing __del__ (Shantanu, PR 16456)
  • Fix crashes with some uses of final and deprecated (Shantanu, PR 16457)

Fixes to Crashes

  • Fix crash with type alias to Callable[[Unpack[Tuple[Any, ...]]], Any] (Alex Waygood, PR 16541)
  • Fix crash on TypeGuard in __call__ (Ivan Levkivskyi, PR 16516)
  • Fix crash on invalid enum in method (Ivan Levkivskyi, PR 16511)
  • Fix crash on unimported Any in TypedDict (Ivan Levkivskyi, PR 16510)

Documentation Updates

  • Update soft-error-limit default value to -1 (Sveinung Gundersen, PR 16542)
  • Support Sphinx 7.x (Michael R. Crusoe, PR 16460)

Other Notable Changes and Fixes

  • Allow mypy to output a junit file with per-file results (Matthew Wright, PR 16388)

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
  • Chad Dombrova
  • Christoph Tyralla
  • Ilya Priven
  • Ivan Levkivskyi
  • Jelle Zijlstra
  • Jukka Lehtosalo
  • Marcel Telka
  • Matthew Wright
  • Michael R. Crusoe
  • Nikita Sobolev
  • Ole Peder Brandtzæg
  • robjhornby
  • Shantanu
  • Sveinung Gundersen
  • Valentin Stanciu

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

Posted by Wesley Collin Wright

Friday 10 November 2023

Mypy 1.7 Released

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

Using TypedDict for **kwargs Typing

Mypy now has support for using Unpack[...] with a TypedDict type to annotate **kwargs arguments enabled by default. Example:

    # Or 'from typing_extensions import ...'
    from typing import TypedDict, Unpack
    
    class Person(TypedDict):
        name: str
        age: int
    
    def foo(**kwargs: Unpack[Person]) -> None:
        ...
    
    foo(name="x", age=1)  # Ok
    foo(name=1)  # Error

The definition of foo above is equivalent to the one below, with keyword-only arguments name and age:

    def foo(*, name: str, age: int) -> None:
        ...

Refer to PEP 692 for more information. Note that unlike in the current version of the PEP, mypy always treats signatures with Unpack[SomeTypedDict] as equivalent to their expanded forms with explicit keyword arguments, and there aren't special type checking rules for TypedDict arguments.

This was contributed by Ivan Levkivskyi back in 2022 (PR 13471).

TypeVarTuple Support Enabled (Experimental)

Mypy now has support for variadic generics (TypeVarTuple) enabled by default, as an experimental feature. Refer to PEP 646 for the details.

TypeVarTuple was implemented by Jared Hance and Ivan Levkivskyi over several mypy releases, with help from Jukka Lehtosalo.

Changes included in this release:

  • Fix handling of tuple type context with unpacks (Ivan Levkivskyi, PR 16444)
  • Handle TypeVarTuples when checking overload constraints (robjhornby, PR 16428)
  • Enable Unpack/TypeVarTuple support (Ivan Levkivskyi, PR 16354)
  • Fix crash on unpack call special-casing (Ivan Levkivskyi, PR 16381)
  • Some final touches for variadic types support (Ivan Levkivskyi, PR 16334)
  • Support PEP-646 and PEP-692 in the same callable (Ivan Levkivskyi, PR 16294)
  • Support new * syntax for variadic types (Ivan Levkivskyi, PR 16242)
  • Correctly handle variadic instances with empty arguments (Ivan Levkivskyi, PR 16238)
  • Correctly handle runtime type applications of variadic types (Ivan Levkivskyi, PR 16240)
  • Support variadic tuple packing/unpacking (Ivan Levkivskyi, PR 16205)
  • Better support for variadic calls and indexing (Ivan Levkivskyi, PR 16131)
  • Subtyping and inference of user-defined variadic types (Ivan Levkivskyi, PR 16076)
  • Complete type analysis of variadic types (Ivan Levkivskyi, PR 15991)

New Way of Installing Mypyc Dependencies

If you want to install package dependencies needed by mypyc (not just mypy), you should now install mypy[mypyc] instead of just mypy:

    python3 -m pip install -U 'mypy[mypyc]'

Mypy has many more users than mypyc, so always installing mypyc dependencies would often bring unnecessary dependencies.

This change was contributed by Shantanu (PR 16229).

New Rules for Re-exports

Mypy no longer considers an import such as import a.b as b as an explicit re-export. The old behavior was arguably inconsistent and surprising. This may impact some stub packages, such as older versions of types-six. You can change the import to from a import b as b, if treating the import as a re-export was intentional.

This change was contributed by Anders Kaseorg (PR 14086).

Improved Type Inference

The new type inference algorithm that was recently introduced to mypy (but was not enabled by default) is now enabled by default. It improves type inference of calls to generic callables where an argument is also a generic callable, in particular. You can use --old-type-inference to disable the new behavior.

The new algorithm can (rarely) produce different error messages, different error codes, or errors reported on different lines. This is more likely in cases where generic types were used incorrectly.

The new type inference algorithm was contributed by Ivan Levkivskyi. PR 16345 enabled it by default.

Narrowing Tuple Types Using len()

Mypy now can narrow tuple types using len() checks. Example:

    def f(t: tuple[int, int] | tuple[int, int, int]) -> None:
        if len(t) == 2:
            a, b = t   # Ok
        ...

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

More Precise Tuple Lengths (Experimental)

Mypy supports experimental, more precise checking of tuple type lengths through --enable-incomplete-feature=PreciseTupleTypes. Refer to the documentation for more information.

More generally, we are planning to use --enable-incomplete-feature to introduce experimental features that would benefit from community feedback.

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

Mypy Changelog

We now maintain a changelog in the mypy Git repository. It mirrors the contents of mypy release blog posts. We will continue to also publish release blog posts. In the future, release blog posts will be created based on the changelog near a release date.

This was contributed by Shantanu (PR 16280).

Mypy Daemon Improvements

  • Fix daemon crash caused by deleted submodule (Jukka Lehtosalo, PR 16370)
  • Fix file reloading in dmypy with --export-types (Ivan Levkivskyi, PR 16359)
  • Fix dmypy inspect on Windows (Ivan Levkivskyi, PR 16355)
  • Fix dmypy inspect for namespace packages (Ivan Levkivskyi, PR 16357)
  • Fix return type change to optional in generic function (Jukka Lehtosalo, PR 16342)
  • Fix daemon false positives related to module-level __getattr__ (Jukka Lehtosalo, PR 16292)
  • Fix daemon crash related to ABCs (Jukka Lehtosalo, PR 16275)
  • Stream dmypy output instead of dumping everything at the end (Valentin Stanciu, PR 16252)
  • Make sure all dmypy errors are shown (Valentin Stanciu, PR 16250)

Mypyc Improvements

  • Generate error on duplicate function definitions (Jukka Lehtosalo, PR 16309)
  • Don't crash on unreachable statements (Jukka Lehtosalo, PR 16311)
  • Avoid cyclic reference in nested functions (Jukka Lehtosalo, PR 16268)
  • Fix direct __dict__ access on inner functions in new Python (Shantanu, PR 16084)
  • Make tuple packing and unpacking more efficient (Jukka Lehtosalo, PR 16022)

Improvements to Error Reporting

  • Update starred expression error message to match CPython (Cibin Mathew, PR 16304)
  • Fix error code of "Maybe you forgot to use await" note (Jelle Zijlstra, PR 16203)
  • Use error code [unsafe-overload] for unsafe overloads, instead of [misc] (Randolf Scholz, PR 16061)
  • Reword the error message related to void functions (Albert Tugushev, PR 15876)
  • Represent bottom type as Never in messages (Shantanu, PR 15996)
  • Add hint for AsyncIterator incompatible return type (Ilya Priven, PR 15883)
  • Don't suggest stubs packages where the runtime package now ships with types (Alex Waygood, PR 16226)

Performance Improvements

  • Speed up type argument checking (Jukka Lehtosalo, PR 16353)
  • Add fast path for checking self types (Jukka Lehtosalo, PR 16352)
  • Cache information about whether file is typeshed file (Jukka Lehtosalo, PR 16351)
  • Skip expensive repr() in logging call when not needed (Jukka Lehtosalo, PR 16350)

Attrs and Dataclass Improvements

  • dataclass.replace: Allow transformed classes (Ilya Priven, PR 15915)
  • dataclass.replace: Fall through to typeshed signature (Ilya Priven, PR 15962)
  • Document dataclass_transform behavior (Ilya Priven, PR 16017)
  • attrs: Remove fields type check (Ilya Priven, PR 15983)
  • attrs, dataclasses: Don't enforce slots when base class doesn't (Ilya Priven, PR 15976)
  • Fix crash on dataclass field / property collision (Nikita Sobolev, PR 16147)

Stubgen Improvements

  • Write stubs with utf-8 encoding (Jørgen Lind, PR 16329)
  • Fix missing property setter in semantic analysis mode (Ali Hamdan, PR 16303)
  • Unify C extension and pure python stub generators with object oriented design (Chad Dombrova, PR 15770)
  • Multiple fixes to the generated imports (Ali Hamdan, PR 15624)
  • Generate valid dataclass stubs (Ali Hamdan, PR 15625)

Fixes to Crashes

  • Fix incremental mode crash on TypedDict in method (Ivan Levkivskyi, PR 16364)
  • Fix crash on star unpack in TypedDict (Ivan Levkivskyi, PR 16116)
  • Fix crash on malformed TypedDict in incremental mode (Ivan Levkivskyi, PR 16115)
  • Fix crash with report generation on namespace packages (Shantanu, PR 16019)
  • Fix crash when parsing error code config with typo (Shantanu, PR 16005)
  • Fix __post_init__() internal error (Ilya Priven, PR 16080)

Documentation Updates

  • Make it easier to copy commands from README (Hamir Mahal, PR 16133)
  • Document and rename [overload-overlap] error code (Shantanu, PR 16074)
  • Document --force-uppercase-builtins and --force-union-syntax (Nikita Sobolev, PR 16049)
  • Document force_union_syntax and force_uppercase_builtins (Nikita Sobolev, PR 16048)
  • Document we're not tracking relationships between symbols (Ilya Priven, PR 16018)

Other Notable Changes and Fixes

  • Propagate narrowed types to lambda expressions (Ivan Levkivskyi, PR 16407)
  • Avoid importing from setuptools._distutils (Shantanu, PR 16348)
  • Delete recursive aliases flags (Ivan Levkivskyi, PR 16346)
  • Properly use proper subtyping for callables (Ivan Levkivskyi, PR 16343)
  • Use upper bound as inference fallback more consistently (Ivan Levkivskyi, PR 16344)
  • Add [unimported-reveal] error code (Nikita Sobolev, PR 16271)
  • Add |= and | operators support for TypedDict (Nikita Sobolev, PR 16249)
  • Clarify variance convention for Parameters (Ivan Levkivskyi, PR 16302)
  • Correctly recognize typing_extensions.NewType (Ganden Schaffner, PR 16298)
  • Fix partially defined in the case of missing type maps (Shantanu, PR 15995)
  • Use SPDX license identifier (Nikita Sobolev, PR 16230)
  • Make __qualname__ and __module__ available in class bodies (Anthony Sottile, PR 16215)
  • stubtest: Hint when args in stub need to be keyword-only (Alex Waygood, PR 16210)
  • Tuple slice should not propagate fallback (Thomas Grainger, PR 16154)
  • Fix cases of type object handling for overloads (Shantanu, PR 16168)
  • Fix walrus interaction with empty collections (Ivan Levkivskyi, PR 16197)
  • Use type variable bound when it appears as actual during inference (Ivan Levkivskyi, PR 16178)
  • Use upper bounds as fallback solutions for inference (Ivan Levkivskyi, PR 16184)
  • Special-case type inference of empty collections (Ivan Levkivskyi, PR 16122)
  • Allow TypedDict unpacking in Callable types (Ivan Levkivskyi, PR 16083)
  • Fix inference for overloaded __call__ with generic self (Shantanu, PR 16053)
  • Call dynamic class hook on generic classes (Petter Friberg, PR 16052)
  • Preserve implicitly exported types via attribute access (Shantanu, PR 16129)
  • Fix a stubtest bug (Alex Waygood)
  • Fix tuple[Any, ...] subtyping (Shantanu, PR 16108)
  • Lenient handling of trivial Callable suffixes (Ivan Levkivskyi, PR 15913)
  • Add add_overloaded_method_to_class helper for plugins (Nikita Sobolev, PR 16038)
  • Bundle misc/proper_plugin.py as a part of mypy (Nikita Sobolev, PR 16036)
  • Fix case Any() in match statement (DS/Charlie, PR 14479)
  • Make iterable logic more consistent (Shantanu, PR 16006)
  • Fix inference for properties with __call__ (Shantanu, PR 15926)

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:

  • Albert Tugushev
  • Alex Waygood
  • Ali Hamdan
  • Anders Kaseorg
  • Anthony Sottile
  • Chad Dombrova
  • Cibin Mathew
  • dinaldoap
  • DS/Charlie
  • Eli Schwartz
  • Ganden Schaffner
  • Hamir Mahal
  • Ihor
  • Ikko Eltociear Ashimine
  • Ilya Priven
  • Ivan Levkivskyi
  • Jelle Zijlstra
  • Jukka Lehtosalo
  • Jørgen Lind
  • KotlinIsland
  • Matt Bogosian
  • Nikita Sobolev
  • Petter Friberg
  • Randolf Scholz
  • Shantanu
  • Thomas Grainger
  • Valentin Stanciu

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

Tuesday 10 October 2023

Mypy 1.6 Released

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

Introduce Error Subcodes for Import Errors

Mypy now uses the error code import-untyped if an import targets an installed library that doesn’t support static type checking, and no stub files are available. Other invalid imports produce the import-not-found error code. They both are subcodes of the import error code, which was previously used for both kinds of import-related errors.

Use --disable-error-code=import-untyped to only ignore import errors about installed libraries without stubs. This way mypy will still report errors about typos in import statements, for example.

If you use --warn-unused-ignore or --strict, mypy will complain if you use # type: ignore[import] to ignore an import error. You are expected to use one of the more specific error codes instead. Otherwise, ignoring the import error code continues to silence both errors.

This feature was contributed by Shantanu (PR 15840, PR 14740).

Remove Support for Targeting Python 3.6 and Earlier

Running mypy with --python-version 3.6, for example, is no longer supported. Python 3.6 hasn’t been properly supported by mypy for some time now, and this makes it explicit. This was contributed by Nikita Sobolev (PR 15668).

Selective Filtering of --disallow-untyped-calls Targets

Using --disallow-untyped-calls could be annoying when using libraries with missing type information, as mypy would generate many errors about code that uses the library. Now you can use --untyped-calls-exclude=acme, for example, to disable these errors about calls targeting functions defined in the acme package. Refer to the documentation for more information.

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

Improved Type Inference between Callable Types

Mypy now does a better job inferring type variables inside arguments of callable types. For example, this code fragment now type checks correctly:

    def f(c: Callable[[T, S], None]) -> Callable[[str, T, S], None]: ...
    def g(*x: int) -> None: ...
    
    reveal_type(f(g))  # Callable[[str, int, int], None]

This was contributed by Ivan Levkivskyi (PR 15910).

Don’t Consider None and TypeVar to Overlap in Overloads

Mypy now doesn’t consider an overload item with an argument type None to overlap with a type variable:

    @overload
    def f(x: None) -> None: ..
    @overload
    def f(x: T) -> Foo[T]: ...
    ...

Previously mypy would generate an error about the definition of f above. This is slightly unsafe if the upper bound of T is object, since the value of the type variable could be None. We relaxed the rules a little, since this solves a common issue.

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

Improvements to --new-type-inference

The experimental new type inference algorithm (polymorphic inference) introduced as an opt-in feature in mypy 1.5 has several improvements:

  • Improve transitive closure computation during constraint solving (Ivan Levkivskyi, PR 15754)
  • Add support for upper bounds and values with --new-type-inference (Ivan Levkivskyi, PR 15813)
  • Basic support for variadic types with --new-type-inference (Ivan Levkivskyi, PR 15879)
  • Polymorphic inference: support for parameter specifications and lambdas (Ivan Levkivskyi, PR 15837)
  • Invalidate cache when adding --new-type-inference (Marc Mueller, PR 16059)

Note: We are planning to enable --new-type-inference by default in mypy 1.7. Please try this out and let us know if you encounter any issues.

ParamSpec Improvements

  • Support self-types containing ParamSpec (Ivan Levkivskyi, PR 15903)
  • Allow “…” in Concatenate, and clean up ParamSpec literals (Ivan Levkivskyi, PR 15905)
  • Fix ParamSpec inference for callback protocols (Ivan Levkivskyi, PR 15986)
  • Infer ParamSpec constraint from arguments (Ivan Levkivskyi, PR 15896)
  • Fix crash on invalid type variable with ParamSpec (Ivan Levkivskyi, PR 15953)
  • Fix subtyping between ParamSpecs (Ivan Levkivskyi, PR 15892)

Stubgen Improvements

  • Add option to include docstrings with stubgen (chylek, PR 13284)
  • Add required ... initializer to NamedTuple fields with default values (Nikita Sobolev, PR 15680)

Stubtest Improvements

  • Fix __mypy-replace false positives (Alex Waygood, PR 15689)
  • Fix edge case for bytes enum subclasses (Alex Waygood, PR 15943)
  • Generate error if typeshed is missing modules from the stdlib (Alex Waygood, PR 15729)
  • Fixes to new check for missing stdlib modules (Alex Waygood, PR 15960)
  • Fix stubtest enum.Flag edge case (Alex Waygood, PR 15933)

Documentation Improvements

  • Do not advertise to create your own assert_never helper (Nikita Sobolev, PR 15947)
  • Fix all the missing references found within the docs (Albert Tugushev, PR 15875)
  • Document await-not-async error code (Shantanu, PR 15858)
  • Improve documentation of disabling error codes (Shantanu, PR 15841)

Other Notable Changes and Fixes

  • Make unsupported PEP 695 features (introduced in Python 3.12) give a reasonable error message (Shantanu, PR 16013)
  • Remove the --py2 command-line argument (Marc Mueller, PR 15670)
  • Change empty tuple from tuple[] to tuple[()] in error messages (Nikita Sobolev, PR 15783)
  • Fix assert_type failures when some nodes are deferred (Nikita Sobolev, PR 15920)
  • Generate error on unbound TypeVar with values (Nikita Sobolev, PR 15732)
  • Fix over-eager types-google-cloud-ndb suggestion (Shantanu, PR 15347)
  • Fix type narrowing of == None and in (None,) conditions (Marti Raudsepp, PR 15760)
  • Fix inference for attrs.fields (Shantanu, PR 15688)
  • Make “await in non-async function” a non-blocking error and give it an error code (Gregory Santosa, PR 15384)
  • Add basic support for decorated overloads (Ivan Levkivskyi, PR 15898)
  • Fix TypeVar regression with self types (Ivan Levkivskyi, PR 15945)
  • Add __match_args__ to dataclasses with no fields (Ali Hamdan, PR 15749)
  • Include stdout and stderr in dmypy verbose output (Valentin Stanciu, PR 15881)
  • Improve match narrowing and reachability analysis (Shantanu, PR 15882)
  • Support __bool__ with Literal in --warn-unreachable (Jannic Warken, PR 15645)
  • Fix inheriting from generic @frozen attrs class (Ilya Priven, PR 15700)
  • Correctly narrow types for tuple[type[X], ...] (Nikita Sobolev, PR 15691)
  • Don't flag intentionally empty generators unreachable (Ilya Priven, PR 15722)
  • Add tox.ini to mypy sdist (Marcel Telka, PR 15853)
  • Fix mypyc regression with pretty (Shantanu, PR 16124)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to Max Murin, who did most of the release manager work for this release (I just did the final steps).

Thanks to all mypy contributors who contributed to this release:

  • Albert Tugushev
  • Alex Waygood
  • Ali Hamdan
  • chylek
  • EXPLOSION
  • Gregory Santosa
  • Ilya Priven
  • Ivan Levkivskyi
  • Jannic Warken
  • KotlinIsland
  • Marc Mueller
  • Marcel Johannesmann
  • Marcel Telka
  • Mark Byrne
  • Marti Raudsepp
  • Max Murin
  • Nikita Sobolev
  • Shantanu
  • Valentin Stanciu

Thursday 10 August 2023

Mypy 1.5 Released

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

Drop Support for Python 3.7

Mypy no longer supports running with Python 3.7, which has reached end-of-life. This was contributed by Shantanu (PR 15566).

Optional Check to Require Explicit @override

If you enable the explicit-override error code, mypy will generate an error if a method override doesn’t use the @typing.override decorator (as discussed in PEP 698). This way mypy will detect accidentally introduced overrides. Example:

    # mypy: enable-error-code="explicit-override"
    
    from typing_extensions import override
    
    class C:
        def foo(self) -> None: pass
        def bar(self) -> None: pass
    
    class D(C):
        # Error: Method "foo" is not using @override but is 
        # overriding a method
        def foo(self) -> None:
            ...
    
        @override
        def bar(self) -> None:  # OK
            ...

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

The override decorator will be available in typing in Python 3.12, but you can also use the backport from a recent version of typing_extensions on all supported Python versions.

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

More Flexible TypedDict Creation and Update

Mypy was previously overly strict when type checking TypedDict creation and update operations. Though these checks were often technically correct, they sometimes triggered for apparently valid code. These checks have now been relaxed by default. You can enable stricter checking by using the new --extra-checks flag.

Construction using the ** syntax is now more flexible:

    from typing import TypedDict
    
    class A(TypedDict):
        foo: int
        bar: int
    
    class B(TypedDict):
        foo: int
    
    a: A = {"foo": 1, "bar": 2}
    b: B = {"foo": 3}
    a2: A = { **a, **b}  # OK (previously an error)

You can also call update() with a TypedDict argument that contains a subset of the keys in the updated TypedDict:

    a.update(b)  # OK (previously an error)

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

Deprecated Flag: --strict-concatenate

The behavior of --strict-concatenate is now included in the new --extra-checks flag, and the old flag is deprecated.

Optionally Show Links to Error Code Documentation

If you use --show-error-code-links, mypy will add documentation links to (many) reported errors. The links are not shown for error messages that are sufficiently obvious, and they are shown once per error code only.

Example output:

    a.py:1: error: Need type annotation for "foo" (hint: "x: List[<type>] = ...")  [var-annotated]
    a.py:1: note: See https://mypy.rtfd.io/en/stable/_refs.html#code-var-annotated for more info

This was contributed by Ivan Levkivskyi (PR 15449).

Consistently Avoid Type Checking Unreachable Code

If a module top level has unreachable code, mypy won’t type check the unreachable statements. This is consistent with how functions behave. The behavior of --warn-unreachable is also more consistent now.

This was contributed by Ilya Priven (PR 15386).

Experimental Improved Type Inference for Generic Functions

You can use --new-type-inference to opt into an experimental new type inference algorithm. It fixes issues when calling a generic functions with an argument that is also a generic function, in particular. This current implementation is still incomplete, but we encourage trying it out and reporting bugs if you encounter regressions. We are planning to enable the new algorithm by default in a future mypy release.

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

Partial Support for Python 3.12

Mypy and mypyc now support running on recent Python 3.12 development versions. Not all new Python 3.12 features are supported, and we don’t ship compiled wheels for Python 3.12 yet.

  • Fix ast warnings for Python 3.12 (Nikita Sobolev, PR 15558)
  • mypyc: Fix multiple inheritance with a protocol on Python 3.12 (Jukka Lehtosalo, PR 15572)
  • mypyc: Fix self-compilation on Python 3.12 (Jukka Lehtosalo, PR 15582)
  • mypyc: Fix 3.12 issue with pickling of instances with __dict__ (Jukka Lehtosalo, PR 15574)
  • mypyc: Fix i16 on Python 3.12 (Jukka Lehtosalo, PR 15510)
  • mypyc: Fix int operations on Python 3.12 (Jukka Lehtosalo, PR 15470)
  • mypyc: Fix generators on Python 3.12 (Jukka Lehtosalo, PR 15472)
  • mypyc: Fix classes with __dict__ on 3.12 (Jukka Lehtosalo, PR 15471)
  • mypyc: Fix coroutines on Python 3.12 (Jukka Lehtosalo, PR 15469)
  • mypyc: Don't use _PyErr_ChainExceptions on 3.12, since it's deprecated (Jukka Lehtosalo, PR 15468)
  • mypyc: Add Python 3.12 feature macro (Jukka Lehtosalo, PR 15465)

Improvements to Dataclasses

  • Improve signature of dataclasses.replace (Ilya Priven, PR 14849)
  • Fix dataclass/protocol crash on joining types (Ilya Priven, PR 15629)
  • Fix strict optional handling in dataclasses (Ivan Levkivskyi, PR 15571)
  • Support optional types for custom dataclass descriptors (Marc Mueller, PR 15628)
  • Add __slots__ attribute to dataclasses (Nikita Sobolev, PR 15649)
  • Support better __post_init__ method signature for dataclasses (Nikita Sobolev, PR 15503)

Mypyc Improvements

  • Support unsigned 8-bit native integer type: mypy_extensions.u8 (Jukka Lehtosalo, PR 15564)
  • Support signed 16-bit native integer type: mypy_extensions.i16 (Jukka Lehtosalo, PR 15464)
  • Define mypy_extensions.i16 in stubs (Jukka Lehtosalo, PR 15562)
  • Document more unsupported features and update supported features (Richard Si, PR 15524)
  • Fix final NamedTuple classes (Richard Si, PR 15513)
  • Use C99 compound literals for undefined tuple values (Jukka Lehtosalo, PR 15453)
  • Don't explicitly assign NULL values in setup functions (Logan Hunt, PR 15379)

Stubgen Improvements

  • Teach stubgen to work with complex and unary expressions (Nikita Sobolev, PR 15661)
  • Support ParamSpec and TypeVarTuple (Ali Hamdan, PR 15626)
  • Fix crash on non-str docstring (Ali Hamdan, PR 15623)

Documentation Updates

  • Add documentation for additional error codes (Ivan Levkivskyi, PR 15539)
  • Improve documentation of type narrowing (Ilya Priven, PR 15652)
  • Small improvements to protocol documentation (Shantanu, PR 15460)
  • Remove confusing instance variable example in cheat sheet (Adel Atallah, PR 15441)

Other Notable Fixes and Improvements

  • Constant fold additional unary and binary expressions (Richard Si, PR 15202)
  • Exclude the same special attributes from Protocol as CPython (Kyle Benesch, PR 15490)
  • Change the default value of the slots argument of attrs.define to True, to match runtime behavior (Ilya Priven, PR 15642)
  • Fix type of class attribute if attribute is defined in both class and metaclass (Alex Waygood, PR 14988)
  • Handle type the same as typing.Type in the first argument of classmethods (Erik Kemperman, PR 15297)
  • Fix --find-occurrences flag (Shantanu, PR 15528)
  • Fix error location for class patterns (Nikita Sobolev, PR 15506)
  • Fix re-added file with errors in mypy daemon (Ivan Levkivskyi, PR 15440)
  • Fix dmypy run on Windows (Ivan Levkivskyi, PR 15429)
  • Fix abstract and non-abstract variant error for property deleter (Shantanu, PR 15395)
  • Remove special casing for "cannot" in error messages (Ilya Priven, PR 15428)
  • Add runtime __slots__ attribute to attrs classes (Nikita Sobolev, PR 15651)
  • Add get_expression_type to CheckerPluginInterface (Ilya Priven, PR 15369)
  • Remove parameters that no longer exist from NamedTuple._make() (Alex Waygood, PR 15578)
  • Allow using typing.Self in __new__ with an explicit @staticmethod decorator (Erik Kemperman, PR 15353)
  • Fix self types in subclass methods without Self annotation (Ivan Levkivskyi, PR 15541)
  • Check for abstract class objects in tuples (Nikita Sobolev, PR 15366)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Adel Atallah
  • Alex Waygood
  • Ali Hamdan
  • Erik Kemperman
  • Federico Padua
  • Ilya Priven
  • Ivan Levkivskyi
  • Jelle Zijlstra
  • Jared Hance
  • Jukka Lehtosalo
  • Kyle Benesch
  • Logan Hunt
  • Marc Mueller
  • Nikita Sobolev
  • Richard Si
  • Shantanu
  • Stavros Ntentos
  • Valentin Stanciu

Tuesday 20 June 2023

Mypy 1.4.0 Released

 

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

The Override Decorator

Mypy can now ensure that when renaming a method, overrides are also renamed. You can explicitly mark a method as overriding a base class method by using the @typing.override decorator (PEP 698). If the method is then renamed in the base class while the method override is not, mypy will generate an error. The decorator will be available in typing in Python 3.12, but you can also use the backport from a recent version of typing_extensions on all supported Python versions.

This feature was contributed byThomas M Kehrenberg (PR 14609).

Propagating Type Narrowing to Nested Functions

Previously, type narrowing was not propagated to nested functions because it would not be sound if the narrowed variable changed between the definition of the nested function and the call site. Mypy will now propagate the narrowed type if the variable is not assigned to after the definition of the nested function:

    def outer(x: str | None = None) -> None:
        if x is None:
            x = calculate_default()
        reveal_type(x)  # "str" (narrowed)
    
        def nested() -> None:
            reveal_type(x)  # Now "str" (used to be "str | None")
    
        nested()

This may generate some new errors because asserts that were previously necessary may become tautological or no-ops.

This was contributed by Jukka Lehtosalo (PR 15133).

Narrowing Enum Values Using “==”

Mypy now allows narrowing enum types using the == operator. Previously this was only supported when using the is operator. This makes exhaustiveness checking with enum types more usable, as the requirement to use the is operator was not very intuitive. In this example mypy can detect that the developer forgot to handle the value MyEnum.C in example

    from enum import Enum
    
    class MyEnum(Enum):
        A = 0
        B = 1
        C = 2
    
    def example(e: MyEnum) -> str:  # Error: Missing return statement
        if e == MyEnum.A:
            return 'x'
        elif e == MyEnum.B:
            return 'y'

Adding an extra elif case resolves the error:

    ...
    def example(e: MyEnum) -> str:  # No error -- all values covered
        if e == MyEnum.A:
            return 'x'
        elif e == MyEnum.B:
            return 'y'
        elif e == MyEnum.C:
            return 'z'

This change can cause false positives in test cases that have assert statements like assert o.x == SomeEnum.X when using --strict-equality. Example:

    # mypy: strict-equality
    
    from enum import Enum
    
    class MyEnum(Enum):
        A = 0
        B = 1
    
    class C:
        x: MyEnum
        ...
    
    def test_something() -> None:
        c = C(...)
        assert c.x == MyEnum.A
        c.do_something_that_changes_x()
        assert c.x == MyEnum.B  # Error: Non-overlapping equality check

These errors can be ignored using # type: ignore[comparison-overlap], or you can perform the assertion using a temporary variable as a workaround:

    ...
    def test_something() -> None:
        ...
        x = c.x
        assert x == MyEnum.A  # Does not narrow c.x
        c.do_something_that_changes_x()
        x = c.x
        assert x == MyEnum.B  # OK

This feature was contributed by Shantanu (PR 11521).

Performance Improvements

  • Speed up simplification of large union types and also fix a recursive tuple crash (Shantanu, PR 15128)
  • Speed up union subtyping (Shantanu, PR 15104)
  • Don't type check most function bodies when type checking third-party library code, or generally when ignoring errors (Jukka Lehtosalo, PR 14150)

Improvements to Plugins

  • attrs.evolve: Support generics and unions (Ilya Konstantinov, PR 15050)
  • Fix ctypes plugin (Alex Waygood)

Fixes to Crashes

  • Fix a crash when function-scope recursive alias appears as upper bound (Ivan Levkivskyi, PR 15159)
  • Fix crash on follow_imports_for_stubs (Ivan Levkivskyi, PR 15407)
  • Fix stubtest crash in explicit init subclass (Shantanu, PR 15399)
  • Fix crash when indexing TypedDict with empty key (Shantanu, PR 15392)
  • Fix crash on NamedTuple as attribute (Ivan Levkivskyi, PR 15404)
  • Correctly track loop depth for nested functions/classes (Ivan Levkivskyi, PR 15403)
  • Fix crash on joins with recursive tuples (Ivan Levkivskyi, PR 15402)
  • Fix crash with custom ErrorCode subclasses (Marc Mueller, PR 15327)
  • Fix crash in dataclass protocol with self attribute assignment (Ivan Levkivskyi, PR 15157)
  • Fix crash on lambda in generic context with generic method in body (Ivan Levkivskyi, PR 15155)
  • Fix recursive type alias crash in make_simplified_union (Ivan Levkivskyi, PR 15216)

Improvements to Error Messages

  • Use lower-case built-in collection types such as list[…] instead of List[…] in errors when targeting Python 3.9+ (Max Murin, PR 15070)
  • Use X | Y union syntax in error messages when targeting Python 3.10+ (Omar Silva, PR 15102)
  • Use type instead of Type in errors when targeting Python 3.9+ (Rohit Sanjay, PR 15139)
  • Do not show unused-ignore errors in unreachable code, and make it a real error code (Ivan Levkivskyi, PR 15164)
  • Don’t limit the number of errors shown by default (Rohit Sanjay, PR 15138)
  • Improver message for truthy functions (madt2709, PR 15193)
  • Output distinct types when type names are ambiguous (teresa0605, PR 15184)
  • Update message about invalid exception type in try (AJ Rasmussen, PR 15131)
  • Add explanation if argument type is incompatible because of an unsupported numbers type (Jukka Lehtosalo, PR 15137)
  • Add more detail to 'signature incompatible with supertype' messages for non-callables (Ilya Priven, PR 15263)

Documentation Updates

  • Add --local-partial-types note to dmypy docs (Alan Du, PR 15259)
  • Update getting started docs for mypyc for Windows (Valentin Stanciu, PR 15233)
  • Clarify usage of callables regarding type object in docs (Viicos, PR 15079)
  • Clarify difference between disallow_untyped_defs and disallow_incomplete_defs (Ilya Priven, PR 15247)
  • Use attrs and @attrs.define in documentation and tests (Ilya Priven, PR 15152)

Mypyc Improvements

  • Fix unexpected TypeError for certain variables with an inferred optional type (Richard Si, PR 15206)
  • Inline math literals (Logan Hunt, PR 15324)
  • Support unpacking mappings in dict display (Richard Si, PR 15203)

Changes to Stubgen

  • Do not remove Generic from base classes (Ali Hamdan, PR 15316)
  • Support yield from statements (Ali Hamdan, PR 15271)
  • Fix missing total from TypedDict class (Ali Hamdan, PR 15208)
  • Fix call-based namedtuple omitted from class bases (Ali Hamdan, PR 14680)
  • Support TypedDict alternative syntax (Ali Hamdan, PR 14682)
  • Make stubgen respect MYPY_CACHE_DIR (Henrik Bäärnhielm, PR 14722)
  • Fixes and simplifications (Ali Hamdan, PR 15232)

Other Notable Fixes and Improvements

  • Fix nested async functions when using TypeVar value restriction (Jukka Lehtosalo, PR 14705)
  • Always allow returning Any from lambda (Ivan Levkivskyi, PR 15413)
  • Add foundation for TypeVar defaults (PEP 696) (Marc Mueller, PR 14872)
  • Update semantic analyzer for TypeVar defaults (PEP 696) (Marc Mueller, PR 14873)
  • Make dict expression inference more consistent (Ivan Levkivskyi, PR 15174)
  • Do not block on duplicate base classes (Nikita Sobolev, PR 15367)
  • Generate an error when both staticmethod and classmethod decorators are used (Juhi Chandalia, PR 15118)
  • Fix assert_type behaviour with literals (Carl Karsten, PR 15123)
  • Fix match subject ignoring redefinitions (Vincent Vanlaer, PR 15306)
  • Support __all__.remove (Shantanu, PR 15279)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Adrian Garcia Badaracco
  • AJ Rasmussen
  • Alan Du
  • Alex Waygood
  • Ali Hamdan
  • Carl Karsten
  • dosisod
  • Ethan Smith
  • Gregory Santosa
  • Heather White
  • Henrik Bäärnhielm
  • Ilya Konstantinov
  • Ilya Priven
  • Ivan Levkivskyi
  • Juhi Chandalia
  • Jukka Lehtosalo
  • Logan Hunt
  • madt2709
  • Marc Mueller
  • Max Murin
  • Nikita Sobolev
  • Omar Silva
  • Özgür
  • Richard Si
  • Rohit Sanjay
  • Shantanu
  • teresa0605
  • Thomas M Kehrenberg
  • Tin Tvrtković
  • Tushar Sadhwani
  • Valentin Stanciu
  • Viicos
  • Vincent Vanlaer
  • Wesley Collin Wright
  • William Santosa
  • yaegassy

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

Wednesday 10 May 2023

Mypy 1.3 Released

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

  • Improve performance of union subtyping (Shantanu, PR 15104)
  • Add negative subtype caches (Ivan Levkivskyi, PR 14884)

Stub Tooling Improvements

  • Stubtest: Check that the stub is abstract if the runtime is, even when the stub is an overloaded method (Alex Waygood, PR 14955)
  • Stubtest: Verify stub methods or properties are decorated with @final if they are decorated with @final at runtime (Alex Waygood, PR 14951)
  • Stubtest: Fix stubtest false positives with TypedDicts at runtime (Alex Waygood, PR 14984)
  • Stubgen: Support @functools.cached_property (Nikita Sobolev, PR 14981)
  • Improvements to stubgenc (Chad Dombrova, PR 14564)

Improvements to attrs

  • Add support for converters with TypeVars on generic attrs classes (Chad Dombrova, PR 14908)
  • Fix attrs.evolve on bound TypeVar (Ilya Konstantinov, PR 15022)

Documentation Updates

  • Improve async documentation (Shantanu, PR 14973)
  • Improvements to cheat sheet (Shantanu, PR 14972)
  • Add documentation for bytes formatting error code (Shantanu, PR 14971)
  • Convert insecure links to use HTTPS (Marti Raudsepp, PR 14974)
  • Also mention overloads in async iterator documentation (Shantanu, PR 14998)
  • stubtest: Improve allowlist documentation (Shantanu, PR 15008)
  • Clarify "Using types... but not at runtime" (Jon Shea, PR 15029)
  • Fix alignment of cheat sheet example (Ondřej Cvacho, PR 15039)
  • Fix error for callback protocol matching against callable type object (Shantanu, PR 15042)

Error Reporting Improvements

  • Improve bytes formatting error (Shantanu, PR 14959)

Mypyc Improvements

  • Fix unions of bools and ints (Tomer Chachamu, PR 15066)

Other Fixes and Improvements

  • Fix narrowing union types that include Self with isinstance (Christoph Tyralla, PR 14923)
  • Allow objects matching SupportsKeysAndGetItem to be unpacked (Bryan Forbes, PR 14990)
  • Check type guard validity for staticmethods (EXPLOSION, PR 14953)
  • Fix sys.platform when cross-compiling with emscripten (Ethan Smith, PR 14888)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alex Waygood
  • Amin Alaee
  • Bryan Forbes
  • Chad Dombrova
  • Charlie Denton
  • Christoph Tyralla
  • dosisod
  • Ethan Smith
  • EXPLOSION
  • Ilya Konstantinov
  • Ivan Levkivskyi
  • Jon Shea
  • Jukka Lehtosalo
  • KotlinIsland
  • Marti Raudsepp
  • Nikita Sobolev
  • Ondřej Cvacho
  • Shantanu
  • sobolevn
  • Tomer Chachamu
  • Yaroslav Halchenko

Thursday 6 April 2023

Mypy 1.2 Released

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

Improvements to Dataclass Transforms

  • Support implicit default for "init" parameter in field specifiers (Wesley Collin Wright and Jukka Lehtosalo, PR 15010)
  • Support descriptors in dataclass transform (Jukka Lehtosalo, PR 15006)
  • Fix frozen_default in incremental mode (Wesley Collin Wright)
  • Fix frozen behavior for base classes with direct metaclasses (Wesley Collin Wright, PR 14878)

Mypyc: Native Floats

Mypyc now uses a native, unboxed representation for values of type float. Previously these were heap-allocated Python objects. Native floats are faster and use less memory. Code that uses floating-point operations heavily can be several times faster when using native floats.

Various float operations and math functions also now have optimized implementations. Refer to the documentation for a full list.

This can change the behavior of existing code that uses subclasses of float. When assigning an instance of a subclass of float to a variable with the float type, it gets implicitly converted to a float instance when compiled:

    from lib import MyFloat  # MyFloat ia a subclass of "float"
    def example() -> None:
        x = MyFloat(1.5)
        y: float = x  # Implicit conversion from MyFloat to float
        print(type(y))  # float, not MyFloat

Previously, implicit conversions were applied to int subclasses but not float subclasses.

Also, int values can no longer be assigned to a variable with type float in compiled code, since these types now have incompatible representations. An explicit conversion is required:

    def example(n: int) -> None:
        a: float = 1  # Error: cannot assign "int" to "float"
        b: float = 1.0  # OK
        c: float = n  # Error
        d: float = float(n)  # OK

This restriction only applies to assignments, since they could otherwise narrow down the type of a variable from float to int. int values can still be implicitly converted to float when passed as arguments to functions that expect float values.

Note that mypyc still doesn’t support arrays of unboxed float values. Using list[float] involves heap-allocated float objects, since list can only store boxed values. Support for efficient floating point arrays is one of the next major planned mypyc features.

Related changes:

  • Use a native unboxed representation for floats (Jukka Lehtosalo, PR 14880)
  • Document native floats and integers (Jukka Lehtosalo, PR 14927)
  • Fixes to float to int conversion (Jukka Lehtosalo, PR 14936)

Mypyc: Native Integers

Mypyc now supports signed 32-bit and 64-bit integer types in addition to the arbitrary-precision int type. You can use the types mypy_extensions.i32 and mypy_extensions.i64 to speed up code that uses integer operations heavily.

Simple example:

    from mypy_extensions import i64
    def inc(x: i64) -> i64:
        return x + 1

Refer to the documentation for more information. This feature was contributed by Jukka Lehtosalo.

Other Mypyc Fixes and Improvements

  • Support iterating over a TypedDict (Richard Si, PR 14747)
  • Faster coercions between different tuple types (Jukka Lehtosalo, PR 14899)
  • Faster calls via type aliases (Jukka Lehtosalo, PR 14784)
  • Faster classmethod calls via cls (Jukka Lehtosalo, PR 14789)

Fixes to Crashes

  • Fix crash on class-level import in protocol definition (Ivan Levkivskyi, PR 14926)
  • Fix crash on single item union of alias (Ivan Levkivskyi, PR 14876)
  • Fix crash on ParamSpec in incremental mode (Ivan Levkivskyi, PR 14885)

Documentation Updates

  • Update adopting --strict documentation for 1.0 (Shantanu, PR 14865)
  • Some minor documentation tweaks (Jukka Lehtosalo, PR 14847)
  • Improve documentation of top level mypy: disable-error-code comment (Nikita Sobolev, PR 14810)

Error Reporting Improvements

  • Add error code to typing_extensions suggestion (Shantanu, PR 14881)
  • Add a separate error code for top-level await (Nikita Sobolev, PR 14801)
  • Don’t suggest two obsolete stub packages (Jelle Zijlstra, PR 14842)
  • Add suggestions for pandas-stubs and lxml-stubs (Shantanu, PR 14737)

Other Fixes and Improvements

  • Multiple inheritance considers callable objects as subtypes of functions (Christoph Tyralla, PR 14855)
  • stubtest: Respect @final runtime decorator and enforce it in stubs (Nikita Sobolev, PR 14922)
  • Fix false positives related to type[<type-var>] (sterliakov, PR 14756)
  • Fix duplication of ParamSpec prefixes and properly substitute ParamSpecs (EXPLOSION, PR 14677)
  • Fix line number if __iter__ is incorrectly reported as missing (Jukka Lehtosalo, PR 14893)
  • Fix incompatible overrides of overloaded generics with self types (Shantanu, PR 14882)
  • Allow SupportsIndex in slice expressions (Shantanu, PR 14738)
  • Support if statements in bodies of dataclasses and classes that use dataclass_transform (Jacek Chałupka, PR 14854)
  • Allow iterable class objects to be unpacked (including enums) (Alex Waygood, PR 14827)
  • Fix narrowing for walrus expressions used in match statements (Shantanu, PR 14844)
  • Add signature for attr.evolve (Ilya Konstantinov, PR 14526)
  • Fix Any inference when unpacking iterators that don't directly inherit from typing.Iterator (Alex Waygood, PR 14821)
  • Fix unpack with overloaded __iter__ method (Nikita Sobolev, PR 14817)
  • Reduce size of JSON data in mypy cache (dosisod, PR 14808)
  • Improve “used before definition” checks when a local definition has the same name as a global definition (Stas Ilinskiy, PR 14517)
  • Honor NoReturn as __setitem__ return type to mark unreachable code (sterliakov, PR 12572)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alex Waygood
  • Avasam
  • Christoph Tyralla
  • dosisod
  • EXPLOSION
  • Ilya Konstantinov
  • Ivan Levkivskyi
  • Jacek Chałupka
  • Jelle Zijlstra
  • Jukka Lehtosalo
  • Marc Mueller
  • Max Murin
  • Nikita Sobolev
  • Richard Si
  • Shantanu
  • Stas Ilinskiy
  • sterliakov
  • Wesley Collin Wright

Monday 6 March 2023

Mypy 1.1.1 Released

We’ve just uploaded mypy 1.1.1 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 for dataclass_transform

This release adds full support for the dataclass_transform decorator defined in PEP 681. This allows decorators, base classes, and metaclasses that generate a __init__ method or other methods based on the properties of that class (similar to dataclasses) to have those methods recognized by mypy.

This was contributed by Wesley Collin Wright.

Dedicated Error Code for Method Assignments

Mypy can’t safely check all assignments to methods (a form of monkey patching), so mypy generates an error by default. To make it easier to ignore this error, mypy now uses the new error code method-assign for this. By disabling this error code in a file or globally, mypy will no longer complain about assignments to methods if the signatures are compatible.

Mypy also supports the old error code assignment for these assignments to prevent a backward compatibility break. More generally, we can use this mechanism in the future if we wish to split or rename another existing error code without causing backward compatibility issues.

This was contributed by Ivan Levkivskyi (PR 14570).

Fixes to Crashes

  • Fix a crash on walrus in comprehension at class scope (Ivan Levkivskyi, PR 14556)
  • Fix crash related to value-constrained TypeVar (Shantanu, PR 14642)

Fixes to Cache Corruption

  • Fix generic TypedDict/NamedTuple caching (Ivan Levkivskyi, PR 14675)

Mypyc Fixes and Improvements

  • Raise "non-trait base must be first..." error less frequently (Richard Si, PR 14468)
  • Generate faster code for bool comparisons and arithmetic (Jukka Lehtosalo, PR 14489)
  • Optimize __(a)enter__/__(a)exit__ for native classes (Jared Hance, PR 14530)
  • Detect if attribute definition conflicts with base class/trait (Jukka Lehtosalo, PR 14535)
  • Support __(r)divmod__ dunders (Richard Si, PR 14613)
  • Support __pow__, __rpow__, and __ipow__ dunders (Richard Si, PR 14616)
  • Fix crash on star unpacking to underscore (Ivan Levkivskyi, PR 14624)
  • Fix iterating over a union of dicts (Richard Si, PR 14713)

Fixes to Detecting Undefined Names (used-before-def)

  • Correctly handle walrus operator (Stas Ilinskiy, PR 14646)
  • Handle walrus declaration in match subject correctly (Stas Ilinskiy, PR 14665)

Stubgen Improvements

Stubgen is a tool for automatically generating draft stubs for libraries.

  • Allow aliases below the top level (Chad Dombrova, PR 14388)
  • Fix crash with PEP 604 union in type variable bound (Shantanu, PR 14557)
  • Preserve PEP 604 unions in generated .pyi files (hamdanal, PR 14601)

Stubtest Improvements

Stubtest is a tool for testing that stubs conform to the implementations.

  • Update message format so that it’s easier to go to error location (Avasam, PR 14437)
  • Handle name-mangling edge cases better (Alex Waygood, PR 14596)

Changes to Error Reporting and Messages

  • Add new TypedDict error code typeddict-unknown-key (JoaquimEsteves, PR 14225)
  • Give arguments a more reasonable location in error messages (Max Murin, PR 14562)
  • In error messages, quote just the module's name (Ilya Konstantinov, PR 14567)
  • Improve misleading message about Enum() (Rodrigo Silva, PR 14590)
  • Suggest importing from typing_extensions if definition is not in typing (Shantanu, PR 14591)
  • Consistently use type-abstract error code (Ivan Levkivskyi, PR 14619)
  • Consistently use literal-required error code for TypedDicts (Ivan Levkivskyi, PR 14621)
  • Adjust inconsistent dataclasses plugin error messages (Wesley Collin Wright, PR 14637)
  • Consolidate literal bool argument error messages (Wesley Collin Wright, PR 14693)

Other Fixes and Improvements

  • Check that type guards accept a positional argument (EXPLOSION, PR 14238)
  • Fix bug with in operator used with a union of Container and Iterable (Max Murin, PR 14384)
  • Support protocol inference for type[T] via metaclass (Ivan Levkivskyi, PR 14554)
  • Allow overlapping comparisons between bytes-like types (Shantanu, PR 14658)
  • Fix mypy daemon documentation link in README (Ivan Levkivskyi, PR 14644)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alex Waygood
  • Avasam
  • Chad Dombrova
  • dosisod
  • EXPLOSION
  • hamdanal
  • Ilya Konstantinov
  • Ivan Levkivskyi
  • Jared Hance
  • JoaquimEsteves
  • Jukka Lehtosalo
  • Marc Mueller
  • Max Murin
  • Michael Lee
  • Michael R. Crusoe
  • Richard Si
  • Rodrigo Silva
  • Shantanu
  • Stas Ilinskiy
  • Wesley Collin Wright
  • Yilei "Dolee" Yang
  • Yurii Karabas

We’d also like to thank our employer, Dropbox, for funding the mypy core team.

Monday 6 February 2023

Mypy 1.0 Released

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

New Release Versioning Scheme

Now that mypy reached 1.0, we’ll switch to a new versioning scheme. Mypy version numbers will be of form x.y.z.

Rules:

  • The major release number (x) is incremented if a feature release includes a significant backward incompatible change that affects a significant fraction of users.
  • The minor release number (y) is incremented on each feature release. Minor releases include updated stdlib stubs from typeshed.
  • The point release number (z) is incremented when there are fixes only.

Mypy doesn't use SemVer, since most minor releases have at least minor backward incompatible changes in typeshed, at the very least. Also, many type checking features find new legitimate issues in code. These are not considered backward incompatible changes, unless the number of new errors is very high.

Any significant backward incompatible change must be announced in the blog post for the previous feature release, before making the change. The previous release must also provide a flag to explicitly enable or disable the new behavior (whenever practical), so that users will be able to prepare for the changes and report issues. We should keep the feature flag for at least a few releases after we've switched the default.

See ”Release Process” in the mypy wiki for more details and for the most up-to-date version of the versioning scheme.

Performance Improvements

Mypy 1.0 is up to 40% faster than mypy 0.991 when type checking the Dropbox internal codebase. We also set up a daily job to measure the performance of the most recent development version of mypy to make it easier to track changes in performance.

Many optimizations contributed to this improvement:

  • Improve performance for errors on class with many attributes (Shantanu, PR 14379)
  • Speed up make_simplified_union (Jukka Lehtosalo, PR 14370)
  • Micro-optimize get_proper_type(s) (Jukka Lehtosalo, PR 14369)
  • Micro-optimize flatten_nested_unions (Jukka Lehtosalo, PR 14368)
  • Some semantic analyzer micro-optimizations (Jukka Lehtosalo, PR 14367)
  • A few miscellaneous micro-optimizations (Jukka Lehtosalo, PR 14366)
  • Optimization: Avoid a few uses of contextmanagers in semantic analyzer (Jukka Lehtosalo, PR 14360)
  • Optimization: Enable always defined attributes in Type subclasses (Jukka Lehtosalo, PR 14356)
  • Optimization: Remove expensive context manager in type analyzer (Jukka Lehtosalo, PR 14357)
  • subtypes: fast path for Union/Union subtype check (Hugues, PR 14277)
  • Micro-optimization: avoid Bogus[int] types that cause needless boxing (Jukka Lehtosalo, PR 14354)
  • Avoid slow error message logic if errors not shown to user (Jukka Lehtosalo, PR 14336)
  • Speed up the implementation of hasattr() checks (Jukka Lehtosalo, PR 14333)
  • Avoid the use of a context manager in hot code path (Jukka Lehtosalo, PR 14331)
  • Change various type queries into faster bool type queries (Jukka Lehtosalo, PR 14330)
  • Speed up recursive type check (Jukka Lehtosalo, PR 14326)
  • Optimize subtype checking by avoiding a nested function (Jukka Lehtosalo, PR 14325)
  • Optimize type parameter checks in subtype checking (Jukka Lehtosalo, PR 14324)
  • Speed up freshening type variables (Jukka Lehtosalo, PR 14323)
  • Optimize implementation of TypedDict types for **kwds (Jukka Lehtosalo, PR 14316)

Warn About Variables Used Before Definition

Mypy will now generate an error if you use a variable before it’s defined. This feature is enabled by default. By default mypy reports an error when it infers that a variable is always undefined.

    y = x  # E: Name "x" is used before definition [used-before-def]
    x = 0

This feature was contributed by Stas Ilinskiy.

Detect Possibly Undefined Variables (Experimental)

A new experimental possibly-undefined error code is now available that will detect variables that may be undefined:

    if b:
        x = 0
    print(x)  # Error: Name "x" may be undefined [possibly-undefined]

The error code is disabled be default, since it can generate false positives.

This feature was contributed by Stas Ilinskiy.

Support the “Self” Type

There is now a simpler syntax for declaring generic self types introduced in PEP 673: the Self type. You no longer have to define a type variable to use “self types”, and you can use them with attributes. Example from mypy documentation:

    from typing import Self
    
    class Friend:
        other: Self | None = None
    
        @classmethod
        def make_pair(cls) -> tuple[Self, Self]:
            a, b = cls(), cls()
            a.other = b
            b.other = a
            return a, b
    
    class SuperFriend(Friend):
        pass
    
    # a and b have the inferred type "SuperFriend", not "Friend"
    a, b = SuperFriend.make_pair()

The feature was introduced in Python 3.11. In earlier Python versions a backport of Self is available in typing_extensions.

This was contributed by Ivan Levkivskyi (PR 14041).

Support ParamSpec in Type Aliases

ParamSpec and Concatenate can now be used in type aliases. Example:
    from typing import ParamSpec, Callable
    
    P = ParamSpec("P")
    A = Callable[P, None]
    
    def f(c: A[int, str]) -> None:
        c(1, "x")

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

ParamSpec and Generic Self Types No Longer Experimental

Support for ParamSpec (PEP 612) and generic self types are no longer considered experimental.

Miscellaneous New Features

  • Minimal, partial implementation of dataclass_transform (PEP 681) (Wesley Collin Wright, PR 14523)
  • Add basic support for typing_extensions.TypeVar (Marc Mueller, PR 14313)
  • Add --debug-serialize option (Marc Mueller, PR 14155)
  • Constant fold initializers of final variables (Jukka Lehtosalo, PR 14283)
  • Enable Final instance attributes for attrs (Tin Tvrtković, PR 14232)
  • Allow function arguments as base classes (Ivan Levkivskyi, PR 14135)
  • Allow super() with mixin protocols (Ivan Levkivskyi, PR 14082)
  • Add type inference for dict.keys membership (Matthew Hughes, PR 13372)
  • Generate error for class attribute access if attribute is defined with __slots__ (Harrison McCarty, PR 14125)
  • Support additional attributes in callback protocols (Ivan Levkivskyi, PR 14084)

Fixes to Crashes

  • Fix crash on prefixed ParamSpec with forward reference (Ivan Levkivskyi, PR 14569)
  • Fix internal crash when resolving the same partial type twice (Shantanu, PR 14552)
  • Fix crash in daemon mode on new import cycle (Ivan Levkivskyi, PR 14508)
  • Fix crash in mypy daemon (Ivan Levkivskyi, PR 14497)
  • Fix crash on Any metaclass in incremental mode (Ivan Levkivskyi, PR 14495)
  • Fix crash in await inside comprehension outside function (Ivan Levkivskyi, PR 14486)
  • Fix crash in Self type on forward reference in upper bound (Ivan Levkivskyi, PR 14206)
  • Fix a crash when incorrect super() is used outside a method (Ivan Levkivskyi, PR 14208)
  • Fix crash on overriding with frozen attrs (Ivan Levkivskyi, PR 14186)
  • Fix incremental mode crash on generic function appearing in nested position (Ivan Levkivskyi, PR 14148)
  • Fix daemon crash on malformed NamedTuple (Ivan Levkivskyi, PR 14119)
  • Fix crash during ParamSpec inference (Ivan Levkivskyi, PR 14118)
  • Fix crash on nested generic callable (Ivan Levkivskyi, PR 14093)
  • Fix crashes with unpacking SyntaxError (Shantanu, PR 11499)
  • Fix crash on partial type inference within a lambda (Ivan Levkivskyi, PR 14087)
  • Fix crash with enums (Michael Lee, PR 14021)
  • Fix crash with malformed TypedDicts and disllow-any-expr (Michael Lee, PR 13963)

Error Reporting Improvements

  • More helpful error for missing self (Shantanu, PR 14386)
  • Add error-code truthy-iterable (Marc Mueller, PR 13762)
  • Fix pluralization in error messages (KotlinIsland, PR 14411)

Mypyc: Support Match Statement

Mypyc can now compile Python 3.10 match statements.

This was contributed by dosisod (PR 13953).

Other Mypyc Fixes and Improvements

  • Optimize int(x)/float(x)/complex(x) on instances of native classes (Richard Si, PR 14450)
  • Always emit warnings (Richard Si, PR 14451)
  • Faster bool and integer conversions (Jukka Lehtosalo, PR 14422)
  • Support attributes that override properties (Jukka Lehtosalo, PR 14377)
  • Precompute set literals for "in" operations and iteration (Richard Si, PR 14409)
  • Don't load targets with forward references while setting up non-extension class __annotations__ (Richard Si, PR 14401)
  • Compile away NewType type calls (Richard Si, PR 14398)
  • Improve error message for multiple inheritance (Joshua Bronson, PR 14344)
  • Simplify union types (Jukka Lehtosalo, PR 14363)
  • Fixes to union simplification (Jukka Lehtosalo, PR 14364)
  • Fix for typeshed changes to Collection (Shantanu, PR 13994)
  • Allow use of enum.Enum (Shantanu, PR 13995)
  • Fix compiling on Arch Linux (dosisod, PR 13978)

Documentation Improvements

  • Various documentation and error message tweaks (Jukka Lehtosalo, PR 14574)
  • Improve Generics documentation (Shantanu, PR 14587)
  • Improve protocols documentation (Shantanu, PR 14577)
  • Improve dynamic typing documentation (Shantanu, PR 14576)
  • Improve the Common Issues page (Shantanu, PR 14581)
  • Add a top-level TypedDict page (Shantanu, PR 14584)
  • More improvements to getting started documentation (Shantanu, PR 14572)
  • Move truthy-function documentation from “optional checks” to “enabled by default” (Anders Kaseorg, PR 14380)
  • Avoid use of implicit optional in decorator factory documentation (Tom Schraitle, PR 14156)
  • Clarify documentation surrounding install-types (Shantanu, PR 14003)
  • Improve searchability for module level type ignore errors (Shantanu, PR 14342)
  • Advertise mypy daemon in README (Ivan Levkivskyi, PR 14248)
  • Add link to error codes in README (Ivan Levkivskyi, PR 14249)
  • Document that report generation disables cache (Ilya Konstantinov, PR 14402)
  • Stop saying mypy is beta software (Ivan Levkivskyi, PR 14251)
  • Flycheck-mypy is deprecated, since its functionality was merged to Flycheck (Ivan Levkivskyi, PR 14247)
  • Update code example in "Declaring decorators" (ChristianWitzler, PR 14131)

Stubtest Improvements

Stubtest is a tool for testing that stubs conform to the implementations.

  • Improve error message for __all__-related errors (Alex Waygood, PR 14362)
  • Improve heuristics for determining whether global-namespace names are imported (Alex Waygood, PR 14270)
  • Catch BaseException on module imports (Shantanu, PR 14284)
  • Associate exported symbol error with __all__ object_path (Nikita Sobolev, PR 14217)
  • Add __warningregistry__ to the list of ignored module dunders (Nikita Sobolev, PR 14218)
  • If a default is present in the stub, check that it is correct (Jelle Zijlstra, PR 14085)

Stubgen Improvements

Stubgen is a tool for automatically generating draft stubs for libraries.

  • Treat dlls as C modules (Shantanu, PR 14503)

Other Notable Fixes and Improvements

  • Update stub suggestions based on recent typeshed changes (Alex Waygood, PR 14265)
  • Fix attrs protocol check with cache (Marc Mueller, PR 14558)
  • Fix strict equality check if operand item type has custom __eq__ (Jukka Lehtosalo, PR 14513)
  • Don't consider object always truthy (Jukka Lehtosalo, PR 14510)
  • Properly support union of TypedDicts as dict literal context (Ivan Levkivskyi, PR 14505)
  • Properly expand type in generic class with Self and TypeVar with values (Ivan Levkivskyi, PR 14491)
  • Fix recursive TypedDicts/NamedTuples defined with call syntax (Ivan Levkivskyi, PR 14488)
  • Fix type inference issue when a class inherits from Any (Shantanu, PR 14404)
  • Fix false positive on generic base class with six (Ivan Levkivskyi, PR 14478)
  • Don't read scripts without extensions as modules in namespace mode (Tim Geypens, PR 14335)
  • Fix inference for constrained type variables within unions (Christoph Tyralla, PR 14396)
  • Fix Unpack imported from typing (Marc Mueller, PR 14378)
  • Allow trailing commas in ini configuration of multiline values (Nikita Sobolev, PR 14240)
  • Fix false negatives involving Unions and generators or coroutines (Shantanu, PR 14224)
  • Fix ParamSpec constraint for types as callable (Vincent Vanlaer, PR 14153)
  • Fix type aliases with fixed-length tuples (Jukka Lehtosalo, PR 14184)
  • Fix issues with type aliases and new style unions (Jukka Lehtosalo, PR 14181)
  • Simplify unions less aggressively (Ivan Levkivskyi, PR 14178)
  • Simplify callable overlap logic (Ivan Levkivskyi, PR 14174)
  • Try empty context when assigning to union typed variables (Ivan Levkivskyi, PR 14151)
  • Improvements to recursive types (Ivan Levkivskyi, PR 14147)
  • Make non-numeric non-empty FORCE_COLOR truthy (Shantanu, PR 14140)
  • Fix to recursive type aliases (Ivan Levkivskyi, PR 14136)
  • Correctly handle Enum name on Python 3.11 (Ivan Levkivskyi, PR 14133)
  • Fix class objects falling back to metaclass for callback protocol (Ivan Levkivskyi, PR 14121)
  • Correctly support self types in callable ClassVar (Ivan Levkivskyi, PR 14115)
  • Fix type variable clash in nested positions and in attributes (Ivan Levkivskyi, PR 14095)
  • Allow class variable as implementation for read only attribute (Ivan Levkivskyi, PR 14081)
  • Prevent warnings from causing dmypy to fail (Andrzej Bartosiński, PR 14102)
  • Correctly process nested definitions in mypy daemon (Ivan Levkivskyi, PR 14104)
  • Don't consider a branch unreachable if there is a possible promotion (Ivan Levkivskyi, PR 14077)
  • Fix incompatible overrides of overloaded methods in concrete subclasses (Shantanu, PR 14017)
  • Fix new style union syntax in type aliases (Jukka Lehtosalo, PR 14008)
  • Fix and optimise overload compatibility checking (Shantanu, PR 14018)
  • Improve handling of redefinitions through imports (Shantanu, PR 13969)
  • Preserve (some) implicitly exported types (Shantanu, PR 13967)

Typeshed Updates

Typeshed is now modular and distributed as separate PyPI packages for everything except the standard library stubs. Please see git log for full list of typeshed changes.

Acknowledgements

Thanks to all mypy contributors who contributed to this release:

  • Alessio Izzo
  • Alex Waygood
  • Anders Kaseorg
  • Andrzej Bartosiński
  • Avasam
  • ChristianWitzler
  • Christoph Tyralla
  • dosisod
  • Harrison McCarty
  • Hugo van Kemenade
  • Hugues
  • Ilya Konstantinov
  • Ivan Levkivskyi
  • Jelle Zijlstra
  • jhance
  • johnthagen
  • Jonathan Daniel
  • Joshua Bronson
  • Jukka Lehtosalo
  • KotlinIsland
  • Lakshay Bisht
  • Lefteris Karapetsas
  • Marc Mueller
  • Matthew Hughes
  • Michael Lee
  • Nick Drozd
  • Nikita Sobolev
  • Richard Si
  • Shantanu
  • Stas Ilinskiy
  • Tim Geypens
  • Tin Tvrtković
  • Tom Schraitle
  • Valentin Stanciu
  • Vincent Vanlaer

We’d also like to thank our employer, Dropbox, for funding the mypy core team.