Skip to content

support.md

Latest commit

 

History

History
157 lines (134 loc) · 8.48 KB

support.md

File metadata and controls

157 lines (134 loc) · 8.48 KB

Support

This page lists the Python versions and features supported by the latest version of pytype.

Python Version

  • Analyzes: Whether pytype can analyze code written for this version. For deprecated versions, the last pytype release that supports this version.
  • Runs In: Whether pytype itself can run in this version. For deprecated versions, the last pytype release that supports this version.
  • Issue: Tracking issue for dropping support (older versions) or adding it (upcoming versions), if applicable
Version Analyzes Runs In Issue
2.7 2021.08.03 2020.04.01 #545
3.5 2021.09.09 2020.10.08 #677
3.6 2022.01.05 2022.01.05
3.7 ✅ ✅
3.8 ✅ ✅
3.9 ✅ ✅
3.10 ✅ ✅
3.11 ❌ ❌ #1308

Features

  • Supports: ✅ (yes), ❌ (no), or 🟡 (partial)
  • Issues: Notable issue(s), if applicable

Core

Note: pytype supports all language and stdlib features in its supported versions unless noted otherwise. This section lists features that are difficult to type for which pytype has or intends to add custom support.

Feature Supports Issues
Control Flow Analysis ("Type Narrowing") ✅
collections.namedtuple ✅
Dataclasses ✅
Enums ✅ Requires --use-enum-overlay flag externally

Typing

Feature Version Supports Issues
PEP 484 -- Type Hints 3.5 ✅
PEP 526 -- Syntax for Variable Annotations 3.6 ✅
PEP 544 -- Protocols 3.8 ✅
PEP 561 -- Distributing and Packaging Type Information 3.7 ❌ #151
PEP 563 -- Postponed Evaluation of Annotations 3.7 ✅
PEP 585 -- Type Hinting Generics in Standard Collections 3.9 ✅
PEP 586 -- Literal Types 3.8 ✅
PEP 589 -- TypedDict 3.8 ✅
PEP 591 -- Adding a Final Qualifier to Typing 3.8 ✅
PEP 593 -- Flexible Function and Variable Annotations 3.9 ✅
PEP 604 -- Allow Writing Union Types as X | Y 3.10 ✅
PEP 612 -- Parameter Specification Variables 3.10 🟡 #786
PEP 613 -- Explicit Type Aliases 3.10 ✅
PEP 646 -- Variadic Generics 3.11 ❌
PEP 647 -- User-Defined Type Guards 3.10 ✅
PEP 655 -- Marking individual TypedDict items as required or potentially-missing 3.11 ❌
PEP 673 -- Self Type 3.11 ❌
PEP 675 -- Arbitrary Literal String Type 3.11 ❌
PEP 681 -- Data Class Transforms 3.11 ❌
PEP 695 -- Type Parameter Syntax 3.12 ❌
PEP 698 -- Override Decorator for Static Typing 3.12 ❌
Custom Recursive Types 3.6 ✅
Generic Type Aliases 3.6 ✅
Type Annotation Inheritance 3.6 ❌ #81

Non-Standard/Experimental

This section describes notable non-standard and experimental features supported by pytype.

Note: This is not and does not endeavor to be an exhaustive list of the ways in which pytype differs from other Python type checkers. See the Pytype Typing FAQ for more on that topic.

  • Pytype forbids str from matching an iterable of strs, in order to catch a common accidental string iteration bug (FAQ entry).
  • Pytype allows ... as a top-level annotation. When used this way, ... means "inferred type" (feature request and discussion).
  • pytype_extensions: The pytype_extensions namespace contains many useful extensions, mostly user-contributed. The best way to learn about them is to read the inline documentation.
  • Pytype allows type-annotated variables to be assigned to None or ... without including the relevant type in the type annotation. For example, x: str = None and x: str = ... are allowed. This makes it easier to type-annotate code that uses None or ... to indicate an unset value.

Third-Party Libraries

Note: This section does not list all third-party libraries that pytype supports, only the ones that are difficult to type for which pytype has or intends to add custom support.

Feature Supports Issues
Attrs ✅
Chex 🟡 Google-internal
Flax 🟡 Google-internal
Numpy 🟡 Minimal type stub
Tensorflow 🟡 Minimal, Google-internal