Skip to main content

Infer types for AST nodes.

Project description

astypes

Python library to statically detect types for AST nodes.

A good use case is a linter that needs to run some rules only for particular types. For instance, to check arguments of something.format(a=b) only if something has type str.

python3 -m pip install astypes

Usage

Astypes uses astroid to infer definitions of nodes. So, if your code works with ast nodes, you'll need to convert them into astroid first:

import astroid
import astypes

module = astroid.parse(source_code)
node = astypes.find_node(module, ast_node)

And when you have an astroid node, you can get its type:

node_type = astype.get_node(node)
print(node_type.annotation)

Example:

import astroid
import astypes

node = astroid.extract_node('1 + 2.3')
t = astypes.get_type(node)
print(t.annotation)  # 'float'

For a real-world usage example, check out infer-types. It is a CLI tool that automatically adds type annotations into Python code using astypes.

How it works

You can find most of the logic in astypes/_handlers.py. In short:

  1. The type of some nodes is easy to infer. For example, 13 is always int.
  2. Some nodes are also can be inferred but only if we make some assumptions. Assumptions that we make are the ones that are true in 99% of cases. For example, we assume that list(x) returns type list. It might be not true if you shadow list with something else.
  3. If the type cannot be assumed just by looking at the node, we try to use astroid to infer the type.
  4. If the returned value is a function call, we use astroid to find the definition of the function. The annotated return annotation of the function is what we need.
  5. If the resolved function doesn't have annotation, we use typeshed_client to get its annotation from typeshed. For example, for all built-in functions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astypes-0.2.6.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

astypes-0.2.6-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file astypes-0.2.6.tar.gz.

File metadata

  • Download URL: astypes-0.2.6.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for astypes-0.2.6.tar.gz
Algorithm Hash digest
SHA256 7bfb49dc207890587cd3d1b2fe57c61aa378fb0603a3590ab5e1c1c78b24e387
MD5 d95e6c6ba559b9b899f6e8f6302dc367
BLAKE2b-256 41807028efe25d789b020170cc5937f6d2162a2a53604aa3914d9b03707f9390

See more details on using hashes here.

File details

Details for the file astypes-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: astypes-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for astypes-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4274e83a80c616f400d05678f9b8bc8143a94e544bbfa02906cc5805d990bf13
MD5 eceaa5c55aae032fc7aedec855af8ed0
BLAKE2b-256 1c9f087a31145a2b63ce01deb60e160eac29c700562921b43a7cfbbd0daf3bce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page