allure-python-commons

Warnings

• breaking Version 2.14.0 dropped official support for Python 3.7. Ensure your Python environment is 3.8 or newer for the latest versions of `allure-python-commons` and its adapters.
  Fix: Upgrade Python to 3.8 or later, or use an older version of `allure-python-commons` compatible with Python 3.7 (e.g., <2.14.0).
• gotcha Do not confuse `allure-python-commons` with older, incompatible Allure plugins like `pytest-allure-adaptor`. `allure-python-commons` provides the core API, while integrations like `allure-pytest` handle framework-specific logic. Using both or mixing old and new versions can lead to import errors and unexpected behavior.
  Fix: Ensure you are using `allure-pytest` (or another official adapter) and `allure-python-commons` together, and uninstall any legacy `pytest-allure-adaptor` plugins. Keep all `allure-framework` related packages updated to compatible versions.
• gotcha Custom labels added via `@allure.label` might not display directly in the default Allure Report HTML view. These labels are primarily intended for advanced filtering in Allure TestOps or for custom report processing.
  Fix: For visible categorization in the report, use standard labels like `severity`, `epic`, `feature`, `story`, `tag` which have dedicated sections. If custom labels are required for display, consider custom report transformations or use Allure TestOps integration.
• gotcha Using `allure-python-commons` alone will not generate an interactive HTML Allure Report. It provides the API for creating report data. To get a report, you must also install a specific Allure adapter for your test framework (e.g., `allure-pytest` for Pytest) and the separate Allure Report command-line tool (which requires Java to run).
  Fix: Install `allure-pytest` (or your framework's adapter) via `pip install allure-pytest` and the Allure Report CLI tool (e.g., via `brew install allure` or by downloading from GitHub and ensuring Java is installed). Then run your tests with the adapter and generate the report using `allure generate` or `allure serve`.
• breaking Older versions of `allure-python-commons` (pre-2.x) had compatibility issues with newer Pytest versions (e.g., Pytest 3.2.0 and later), specifically concerning the location of internal classes like `XFail`, leading to import failures.
  Fix: Upgrade all `allure-python` related packages (`allure-python-commons`, `allure-pytest`, etc.) to their latest compatible versions with your Pytest installation. The 2.x series resolved many of these issues.

Install

• pip install allure-python-commons Install latest version

Imports

• allure

  import allure

  The main entry point for Allure API functions like step, attach, and dynamic annotations.
• LabelType

  from allure_commons.types import LabelType

  Used for standardizing labels, e.g., allure.label(LabelType.SEVERITY, allure.severity_level.CRITICAL).

Quickstart

This example demonstrates basic usage of `allure.step` and `allure.attach` within a Python function. While `allure-python-commons` provides the API, generating an actual Allure Report requires integration with a test framework adapter (like `allure-pytest`) and the Allure Report command-line tool. The output will typically be `.json` and `.xml` files in a designated directory, which are then processed by the Allure CLI tool.

import allure
import os

def my_function_with_steps():
    with allure.step("Step 1: Perform initial setup"):
        print("Executing setup...")
        allure.attach("Setup log content", name="setup_log", attachment_type=allure.attachment_type.TEXT)

    with allure.step("Step 2: Process data"):
        data = "some_data_to_process"
        allure.dynamic.parameter("input_data", data)
        print(f"Processing data: {data}")
        processed_data = data.upper()
        allure.attach(processed_data, name="processed_output", attachment_type=allure.attachment_type.TEXT)

    with allure.step("Step 3: Final verification"):
        result = "success"
        allure.dynamic.label("result", result)
        print(f"Verification result: {result}")

if __name__ == "__main__":
    # In a real test framework (e.g., pytest), this function would be a test.
    # The Allure adapter would then capture these calls to build the report.
    print("Running a simulated test function using allure-python-commons API.")
    print("Note: To generate an actual Allure Report, you need a test runner (e.g., pytest) configured with an Allure adapter (e.g., allure-pytest) and the Allure Report CLI tool.")
    my_function_with_steps()
    print("API calls made. Check the output directory configured by your Allure adapter.")