Skip to main content

display more node ininformation.

Project description

Welcome to pytest-informative-node

PyPi version Python version Build Status codecov

Display more node information.


  • pytest >= 3.10.0
  • python >= 3.6

Not compatible with Python2.x

How to install

$ pip install pytest-informative-node

How to use

# pytest.ini
enable    : true
delimiter : @

write docstring with leading delimiter you defined in pytest.ini [informative_node_id] section as node name.

class TestClass:
    """@you node id"""

def test_func():
    """@you node id"""

Test file and Test Package is also supported, just write docstring in the top of file and respectively.


Notice! [pytest]section must be included.
Notice! All options bellow must be under [informative_node_id] section in pytest.ini.

  • enable : [true / false] default is false.
  • delimiter : the delimiter to extract node_id in docstring, default is @.


# Test file structure
    |   |# content of
    |   |"""@LoginSection"""
    |   #\---------------------
        |# content of
        |   """@TestFile"""
        |   import pytest
        |   class TestClass:
        |       """@TestGroup"""
        |       @pytest.mark.parametrize('n', [1, 2], ids=['first', 'second'])
        |       def test_demo(self, n):
        |           """@DemoTest"""
        |           assert n == 1
# Test report structure
|__ ✕TestFile
    |__ ✕TestGroup
        |__ ✕Demo Test
            |__ ✓first
            |__ ✕second

Notice: Duplicate custom node id under same test level is not allowed.

def test_a():
    """@ login"""
def test_b():
    """@ login""" # <-----XXXXXX!


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.


Distributed under the terms of the MIT license, "pytest-informative-node" is free and open source software

Known Issue

  • If you test with Pycharm, you cannot navigate back to source test file from Test Runner tab.

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

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