Skip to main content

A plugin for pytest devs to view how assertion rewriting recodes the AST

Project description

See Build Status on Travis CI See Build Status on AppVeyor

A plugin for pytest devs to view how assertion rewriting recodes the AST


Features

Pytest rewrites the AST (abstract syntax tree) of your tests, for the purpose of displaying the subexpressions involved in your assert statements. This plugin converts that rewritten AST back to Python source, and displays it.

Installation

You can install “pytest-ast-back-to-python” via pip from PyPI:

$ pip install pytest-ast-back-to-python

Usage

py.test --show-ast-as-python

Example

Take a trivial test like:

def test_simple():
    a = 1
    b = 2
    assert a + b == 3

View the rewritten AST as Python like this:

$ py.test --show-ast-as-python test_simple.py
======================================== test session starts ========================================
plugins: ast-back-to-python-0.1.0, cov-2.2.1
collected 1 items

test_simple.py .
======================================== Rewritten AST as Python ========================================
import builtins as @py_builtins
import _pytest.assertion.rewrite as @pytest_ar

def test_simple():
    a = 1
    b = 2
    @py_assert0 = 1
    @py_assert2 = 2
    @py_assert4 = @py_assert0 + @py_assert2
    @py_assert6 = 3
    @py_assert5 = @py_assert4 == @py_assert6
    if not @py_assert5:
        @py_format8 = @pytest_ar._call_reprcompare(('==',), (@py_assert5,), ('(%(py1)s + %(py3)s) == %(py7)s',), (@py_assert4, @py_assert6)) % {'py3': @pytest_ar._saferepr(@py_assert2), 'py1': @pytest_ar._saferepr(@py_assert0), 'py7': @pytest_ar._saferepr(@py_assert6)}
        @py_format10 = ('' + 'assert %(py9)s') % {'py9': @py_format8}
        raise AssertionError(@pytest_ar._format_explanation(@py_format10))
    @py_assert0 = @py_assert2 = @py_assert4 = @py_assert5 = @py_assert6 = None

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, “pytest-ast-back-to-python” is free and open source software

This Pytest plugin was generated with Cookiecutter along with @hackebrot’s Cookiecutter-pytest-plugin template.

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

pytest-ast-back-to-python-1.1.0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

pytest_ast_back_to_python-1.1.0-py2.py3-none-any.whl (14.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-ast-back-to-python-1.1.0.tar.gz.

File metadata

File hashes

Hashes for pytest-ast-back-to-python-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c138070585d2e89b85dee8f7470069e149ee3552030144e769541cdb529dee14
MD5 f0cb7fbfdf07b628454d590ec705a739
BLAKE2b-256 247eba8d2add96f74b4aa3520d8d89411f5167bf61e3105e3060b8c6131c5bdb

See more details on using hashes here.

File details

Details for the file pytest_ast_back_to_python-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_ast_back_to_python-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 94ba1cc8cd65ed7229a2faaf58feb5b619345670d5d2251ed4970cbdde3b135b
MD5 7dbeb0ad598eed9716cb5c7f51905f76
BLAKE2b-256 3a0ca5b0fa61f19031fe7c284372a33648af3722f56522251ff52b4acd195280

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