Skip to main content

Contains the API for end users as well as helper functions and classes to build Allure adapters for Python test frameworks

Project description

Allure Common API

Release Status Downloads

The package contains classes and functions for users of Allure Report. It can be used to enhance reports using an existing Allure adapter or to create new adapters.

Allure Report logo


User's API

Install an adapter that suits your test framework. You can then add more information to the report by using functions from the allure module.

Decorators API

Use these functions as decorators of your own functions, e.g.:

import allure

@allure.title("My test")
def test_fn():
    pass

The full list of decorators:

  • allure.title
  • allure.description
  • allure.description_html
  • allure.label
  • allure.severity
  • allure.epic
  • allure.feature
  • allure.story
  • allure.suite
  • allure.parent_suite
  • allure.sub_suite
  • allure.tag
  • allure.id
  • allure.manual
  • allure.link
  • allure.issue
  • allure.testcase
  • allure.step

Refer to the adapter's documentation for the information about what decorators are supported and what functions they can be applied to.

Runtime API

Most of the functions of Runtime API can be accessed via allure.dynamic.*. Call them at runtime from your code.

The full list includes:

  • allure.dynamic.title
  • allure.dynamic.description
  • allure.dynamic.description_html
  • allure.dynamic.label
  • allure.dynamic.severity
  • allure.dynamic.epic
  • allure.dynamic.feature
  • allure.dynamic.story
  • allure.dynamic.suite
  • allure.dynamic.parent_suite
  • allure.dynamic.sub_suite
  • allure.dynamic.tag
  • allure.dynamic.id
  • allure.dynamic.manual
  • allure.dynamic.link
  • allure.dynamic.issue
  • allure.dynamic.testcase
  • allure.dynamic.parameter
  • allure.attach
  • allure.attach.file
  • allure.step

Refer to the adapter's documentation for the information about what functions are supported and where you can use them.

Adapter API

You may use allure-pytest-commons to build your own Allure adapter. The key elements of the corresponding API are:

  • allure_python_commons.model2: the object model of Allure Report.
  • allure_python_commons.logger: classes that are used to emit Allure Report objects (tests, containers, attachments):
    • AllureFileLogger: emits to the file system.
    • AllureMemoryLogger: collects the objects in memory. Useful for testing.
  • allure_python_commons.lifecycle.AllureLifecycle: an implementation of Allure lifecycle that doesn't isolate the state between threads.
  • allure_python_commons.reporter.AllureReporter: an implementation of Allure lifecycle that supports some multithreaded scenarios.

A new version of the API is likely to be released in the future as we need a decent support for multithreaded and async-based concurrency (see here and here).

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

allure_python_commons-2.14.3.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

allure_python_commons-2.14.3-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file allure_python_commons-2.14.3.tar.gz.

File metadata

  • Download URL: allure_python_commons-2.14.3.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for allure_python_commons-2.14.3.tar.gz
Algorithm Hash digest
SHA256 2dcaa87dd6b0b41902f60fe17e2653d3762788f3998ca4cf721dabfa8342aa07
MD5 b4bc72b4db3da06db02692e0252209e4
BLAKE2b-256 61c58c1cc8d4216ad2266fa16d020fafa8c4cfe67ed8c23a3ce74ea0c1e8d392

See more details on using hashes here.

File details

Details for the file allure_python_commons-2.14.3-py3-none-any.whl.

File metadata

File hashes

Hashes for allure_python_commons-2.14.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7bcf6a2eff69e6f0eacd8681e923f0a9dfbdd86cb8e20d8f93288057f9fb7cb1
MD5 6efa32745af33fe2ab36d99e9f0cf4bb
BLAKE2b-256 4f52ed2029f1cd2c0b08040a85ef86f32af89ff70199ddecd5a4220c4043975d

See more details on using hashes here.

Supported by

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