Allure Common API
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.
- Learn more about Allure Report at https://allurereport.org
- 📚 Documentation – discover official documentation for Allure Report
- ❓ Questions and Support – get help from the team and community
- 📢 Official announcements – stay updated with our latest news and updates
- 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
- 🖥️ Live Demo — explore a live example of Allure Report in action
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.titleallure.descriptionallure.description_htmlallure.labelallure.severityallure.epicallure.featureallure.storyallure.suiteallure.parent_suiteallure.sub_suiteallure.tagallure.idallure.manualallure.linkallure.issueallure.testcaseallure.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.titleallure.dynamic.descriptionallure.dynamic.description_htmlallure.dynamic.labelallure.dynamic.severityallure.dynamic.epicallure.dynamic.featureallure.dynamic.storyallure.dynamic.suiteallure.dynamic.parent_suiteallure.dynamic.sub_suiteallure.dynamic.tagallure.dynamic.idallure.dynamic.manualallure.dynamic.linkallure.dynamic.issueallure.dynamic.testcaseallure.dynamic.parameterallure.attachallure.attach.fileallure.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).
1 maintainer
Release files for allure-python-commons 2.16.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| allure_python_commons-2.16.1.tar.gz | 15.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| allure_python_commons-2.16.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.7 kB
Release files / allure_python_commons-2.16.1.tar.gz
| Download URL | allure_python_commons-2.16.1.tar.gz |
|---|---|
| Size | 15.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3bfb00982a17dd325581f7ca7ebc142d4e3ba2a001ba1f800c2d4e69ddf54a82
|
|
BLAKE2b-256 checksum How to use checksums |
1706bad27c0d10d9c7f03b40bcf85d7d56e098a44b4de13e7fed177fdf528f89
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / allure_python_commons-2.16.1-py3-none-any.whl
| Download URL | allure_python_commons-2.16.1-py3-none-any.whl |
|---|---|
| Size | 16.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bcc9698e3df33bcc83ab9df276c4e17c8f8007837e216b17bc9b0385043d00c2
|
|
BLAKE2b-256 checksum How to use checksums |
45538e55e46cf7f90a0e7a2c3938fa17563e6d6539ce268344c217f7638377b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
