pytest-html-plus 0.4.8__tar.gz → 0.5.0__tar.gz

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-html-plus
-Version: 0.4.8
+Version: 0.5.0
 Summary: Generate Actionable, automatic screenshots, unified Mobile friendly Pytest HTML report in less than 3 seconds — no hooks, merge plugins, no config, xdist-ready.
 License: MIT
 Keywords: pytest,pytest-html-plus,pytest-plugin,html-test-report,beautiful-test-report,shareable-test-results,test-report,test-results,unit-test-report,functional-test-report,test-summary,reporting,python-testing,automated-testing,test-runner,report-generator,continuous-integration,ci-cd,github-actions,jenkins,pytest-html,pytest-report
@@ -20,7 +20,7 @@ Project-URL: Source, https://github.com/reporterplus/pytest-html-plus
 Project-URL: Tracker, https://github.com/reporterplus/pytest-html-plus/issues
 Description-Content-Type: text/markdown
 
-⚡ **Plug. Play. Debug without delay.**  
+⚡ **Test your code, not your reporting setup.**  
 > _Get started with rich pytest reports in under 3 seconds. Just install — no setup required. The simplest, fastest reporter for pytest._
 
 ## Get a self-contained, actionable, easy-to-read single page HTML unified reports summarizing all your test results — no hassle, just clarity. Detect **flaky tests**, **attach screenshots** automatically without hooks and optionally send reports via email**. Works beautifully with or without `xdist`.
@@ -46,6 +46,12 @@ If you don’t want the burden of installing pytest-html-plus manually and your
 [![🚀 Checkout on GitHub Marketplace](https://img.shields.io/badge/Marketplace-Pytest%20HTML%20Plus-blue?logo=github)](https://github.com/marketplace/actions/pytest-html-plus-action)
 [![Documentation](https://img.shields.io/badge/docs-readthedocs.io-brightgreen)](https://pytest-html-plus.readthedocs.io/en/main/marketplace/usage.html)
 
+## Pytest HTML Plus VSCode
+
+[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/reporterplus.pytest-html-plus-vscode)]
+[![Installs](https://img.shields.io/visual-studio-marketplace/i/reporterplus.pytest-html-plus-vscode)]
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://pytest-html-plus.readthedocs.io/en/main/extensions/vscode/usage.html)
+
 ## ✨ Features
 
 #### 🧩 Seamless Combined XML Export to your favourite test management tools — No Plugins Needed

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/README.md

@@ -1,4 +1,4 @@
-⚡ **Plug. Play. Debug without delay.**  
+⚡ **Test your code, not your reporting setup.**  
 > _Get started with rich pytest reports in under 3 seconds. Just install — no setup required. The simplest, fastest reporter for pytest._
 
 ## Get a self-contained, actionable, easy-to-read single page HTML unified reports summarizing all your test results — no hassle, just clarity. Detect **flaky tests**, **attach screenshots** automatically without hooks and optionally send reports via email**. Works beautifully with or without `xdist`.
@@ -24,6 +24,12 @@ If you don’t want the burden of installing pytest-html-plus manually and your
 [![🚀 Checkout on GitHub Marketplace](https://img.shields.io/badge/Marketplace-Pytest%20HTML%20Plus-blue?logo=github)](https://github.com/marketplace/actions/pytest-html-plus-action)
 [![Documentation](https://img.shields.io/badge/docs-readthedocs.io-brightgreen)](https://pytest-html-plus.readthedocs.io/en/main/marketplace/usage.html)
 
+## Pytest HTML Plus VSCode
+
+[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/reporterplus.pytest-html-plus-vscode)]
+[![Installs](https://img.shields.io/visual-studio-marketplace/i/reporterplus.pytest-html-plus-vscode)]
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://pytest-html-plus.readthedocs.io/en/main/extensions/vscode/usage.html)
+
 ## ✨ Features
 
 #### 🧩 Seamless Combined XML Export to your favourite test management tools — No Plugins Needed

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest-html-plus"
-version = "0.4.8"
+version = "0.5.0"
 description = "Generate Actionable, automatic screenshots, unified Mobile friendly Pytest HTML report in less than 3 seconds — no hooks, merge plugins, no config, xdist-ready."
 readme = "README.md"
 authors = ["reporterplus"]

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/pytest_html_plus/compute_report_metadata.py

@@ -1,4 +1,5 @@
 import json
+import os
 from datetime import datetime
 
 from pytest_html_plus.utils import is_main_worker, get_env_marker, get_report_title, \
@@ -8,16 +9,18 @@ from pytest_html_plus.utils import is_main_worker, get_env_marker, get_report_ti
 def write_plus_metadata_if_main_worker(config, report_path, output_path="plus_metadata.json", **kwargs):
     if not is_main_worker():
         return
+    metadata_path = os.path.join(report_path, output_path)
     branch = kwargs.get("git_branch", "Pass --git-branch to populate git metadata")
     commit = kwargs.get("git_commit", "Pass --git-commit to populate git metadata")
     metadata = {
         "report_title": get_report_title(output_path=report_path),
-        "environment": get_env_marker(config),
+        "environment": kwargs.get("rp_env") or get_env_marker(config),
         "branch": branch,
         "commit": commit,
         "python_version": get_python_version(),
         "generated_at": datetime.now().isoformat()
     }
-    with open(output_path, "w") as f:
-        print(metadata)
+    os.makedirs(report_path, exist_ok=True)
+
+    with open(metadata_path, "w") as f:
         json.dump(metadata, f, indent=2)

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/pytest_html_plus/generate_html_report.py

@@ -60,6 +60,7 @@ class JSONReporter:
         else:
             self.metadata = {}
 
+
     def log_result(
             self,
             test_name,
@@ -148,6 +149,7 @@ class JSONReporter:
                     return os.path.join("screenshots", file)
         return None
 
+
     def generate_copy_button(self, content, label):
         if isinstance(content, list):
             # Convert list to string (for logs)
@@ -184,16 +186,35 @@ class JSONReporter:
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <style>
     
-      body {{ font-family: Arial, sans-serif; padding: 1rem; background: #f2f4f7; }}
-      .test {{ border: 1px solid #ddd; margin-bottom: 0.5rem; border-radius: 5px; background: #ffffff; }}
+      body {{
+  font-family: Arial, sans-serif;
+  padding: 1rem;
+  background: #FAF7F2;  
+}}
+      .test {{
+   border: 1px solid #D9C3A5; 
+  margin-bottom: 0.5rem;
+  border-radius: 5px;
+  background: #FDFBF7;     
+}}
       .header {{ padding: 0.5rem; cursor: pointer; display: flex; justify-content: space-between; align-items: center; gap: 8px; flex-wrap: wrap; }}
-      .header.passed {{ background: #e6f4ea; color: #2f7a33; }}
-      .header.failed {{ background: #fdecea; color: #a83232; }}
-      .header.skipped {{  background: #fff8e1; color: #b36b00;  }}
+      .header.passed {{
+  background: #E1F3E8; 
+  color: #1E6B3A;   
+  border-left: 4px solid #2E7D32;
+}}
+      .header.failed {{
+  background: #FBE4E4;   
+  color: #8B1E1E;      
+  border-left: 4px solid #C62828;
+}}
+      .header.skipped {{
+  background: #fff8e1;
+  color: #b36b00;
+}}
       .header.error {{
-  background: #fdecea;   /* light red / pink */
-  color: #b71c1c;        /* deep red */
-  border-left: 4px solid #d32f2f;
+  background: #fdecea;
+  color: #b71c1c;
 }}
       .details {{ padding: 0.5rem 1rem; display: none; border-top: 1px solid #ddd; }}
       .toggle::before {{ content: "▶"; display: inline-block; margin-right: 0.5rem; transition: transform 0.3s ease; }}

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/pytest_html_plus/plugin.py

@@ -5,6 +5,7 @@ from pathlib import Path
 
 import pytest
 import json
+import sys
 
 from pytest_html_plus.compute_report_metadata import write_plus_metadata_if_main_worker
 from pytest_html_plus.extract_link import extract_links_from_item
@@ -36,6 +37,19 @@ def pytest_runtest_setup(item):
    if "caplog" not in item.fixturenames:
        item.fixturenames.append("caplog")
 
+import warnings
+
+def _warn_python_39_deprecation():
+    if sys.version_info[:2] == (3, 9):
+        warnings.warn(
+            "pytest-html-plus is not actively tested in Python 3.9 and support will be dropped in v0.5.1. "
+            "Please upgrade to Python 3.10+.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+_warn_python_39_deprecation()
+
 
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_makereport(item, call):
@@ -113,78 +127,123 @@ import subprocess
 
 
 def pytest_sessionfinish(session, exitstatus):
-   reporter = session.config._json_reporter
-
-   json_path = session.config.getoption("--json-report") or "final_report.json"
-   html_output = session.config.getoption("--html-output") or "report_output"
-   screenshots_path = session.config.getoption("--screenshots") or "screenshots"
-   xml_path = session.config.getoption("--xml-report") or "final_xml.xml"
-
-   is_worker = os.getenv("PYTEST_XDIST_WORKER") is not None
-   try:
-       is_xdist = bool(session.config.getoption("-n"))
-   except ValueError:
-       is_xdist = False
-
-   if is_worker:
-       reporter.write_report()
-       print(f"Worker {os.getenv('PYTEST_XDIST_WORKER')} finished – skipping merge.")
-       return
-
-   if is_xdist:
-       merge_json_reports(directory=".pytest_worker_jsons", output_path=json_path)
-   else:
-       reporter.results = mark_flaky_tests(reporter.results)
-       reporter.write_report()
-
-   script_path = os.path.join(os.path.dirname(__file__), "generate_html_report.py")
-
-   if not os.path.exists(script_path):
-       logger.warning(f"Report generation script not found at {script_path}. Skipping HTML report generation.")
-       return
-
-   try:
-       subprocess.run([
-           sys.executable,
-           script_path,
-           "--report", json_path,
-           "--screenshots", screenshots_path,
-           "--output", html_output
-       ], check=True)
-   except Exception as e:
-       raise RuntimeError(f"Exception during HTML report generation: {e}") from e
+    reporter = session.config._json_reporter
 
-   if session.config.getoption("--plus-email"):
-       print("📬 --plus-email enabled. Sending report...")
-       try:
-           config = load_email_env()
-           config["report_path"] = f"{html_output}"
-           sender = EmailSender(config, report_path=config["report_path"])
-           sender.send()
-       except Exception as e:
-           raise RuntimeError(f"Failed to send email: {e}") from e
+    raw_json_report = session.config.getoption("--json-report")
+    html_output = session.config.getoption("--html-output") or "report_output"
+    screenshots_path = session.config.getoption("--screenshots") or "screenshots"
+    raw_xml_report = session.config.getoption("--xml-report")
+
+    # ---- XML filename validation ----
+    if raw_xml_report:
+        if os.path.basename(raw_xml_report) != raw_xml_report:
+            raise pytest.UsageError("--xml-report must be a filename, not a path")
+        xml_filename = raw_xml_report
+    else:
+        xml_filename = "final_xml.xml"
+
+    xml_path = os.path.join(html_output, xml_filename)
+
+    os.makedirs(html_output, exist_ok=True)
+
+    # ---- JSON filename validation ----
+    if raw_json_report:
+        if os.path.basename(raw_json_report) != raw_json_report:
+            raise pytest.UsageError("--json-report must be a filename, not a path")
+        json_filename = raw_json_report
+    else:
+        json_filename = "final_report.json"
+
+    json_path = os.path.join(html_output, json_filename)
+    reporter.report_path = json_path
+
+    is_worker = os.getenv("PYTEST_XDIST_WORKER") is not None
+    try:
+        is_xdist = bool(session.config.getoption("-n"))
+    except ValueError:
+        is_xdist = False
+
+    # ---- Worker behavior ----
+    if is_worker:
+        worker_id = os.getenv("PYTEST_XDIST_WORKER")
+        worker_dir = ".pytest_worker_jsons"
+        os.makedirs(worker_dir, exist_ok=True)
+
+        reporter.report_path = os.path.join(
+            worker_dir,
+            f"{worker_id}.json"
+        )
 
-   open_html_report(report_path=f"{html_output}/report.html",json_path=json_path, config=session.config)
+        reporter.write_report()
+        return
 
-   if session.config.getoption("--generate-xml"):
-       try:
-           json_path = reporter.report_path
-           convert_json_to_junit_xml(json_path, xml_path)
-           print(f"XML report generated: {xml_path}")
-       except Exception as e:
-           raise RuntimeError(f"Failed to generate XML report: {e}") from e
+    # ---- Controller behavior ----
+    if is_xdist:
+        merge_json_reports(directory=".pytest_worker_jsons", output_path=json_path)
+    else:
+        reporter.results = mark_flaky_tests(reporter.results)
+        reporter.write_report()
 
+    script_path = os.path.join(os.path.dirname(__file__), "generate_html_report.py")
+    if not os.path.exists(script_path):
+        logger.warning(
+            f"Report generation script not found at {script_path}. Skipping HTML report generation."
+        )
+        return
+
+    try:
+        subprocess.run([
+            sys.executable,
+            script_path,
+            "--report", json_path,
+            "--screenshots", screenshots_path,
+            "--output", html_output
+        ], check=True)
+    except Exception as e:
+        raise RuntimeError(f"Exception during HTML report generation: {e}") from e
+
+    # ---- Generate XML ----
+    if session.config.getoption("--generate-xml"):
+        try:
+            convert_json_to_junit_xml(json_path, xml_path)
+            print(f"XML report generated: {xml_path}")
+        except Exception as e:
+            raise RuntimeError(f"Failed to generate XML report: {e}") from e
+
+    if not os.getenv("PYTEST_XDIST_WORKER"):
+        if os.path.exists(screenshots_path):
+            try:
+                shutil.rmtree(screenshots_path)
+            except Exception:
+                logger.warning("Could not clean up screenshots directory")
+
+    if session.config.getoption("--plus-email"):
+        try:
+            config = load_email_env()
+            config["report_path"] = html_output
+            sender = EmailSender(config, report_path=html_output)
+            sender.send()
+        except Exception as e:
+            raise RuntimeError(f"Failed to send email: {e}") from e
+
+    # ---- Open report (controller only) ----
+    open_html_report(
+        report_path=os.path.join(html_output, "report.html"),
+        json_path=json_path,
+        config=session.config
+    )
 
 def pytest_sessionstart(session):
     html_output = session.config.getoption("--html-output") or "report_output"
     git_branch = session.config.getoption("--git-branch") or "Pass --git-branch to populate git metadata"
     git_commit = session.config.getoption("--git-commit") or "Pass --git-commit to populate git metadata"
+    rp_env = session.config.getoption("--rp-env") or "Pass --rp-env <name> to populate environment"
     configure_logging()
     session.config.addinivalue_line(
        "markers", "link(url): Add a link to external test case or documentation."
    )
     write_plus_metadata_if_main_worker(session.config, report_path=html_output,
-                                       git_branch=git_branch, git_commit=git_commit)
+                                       git_branch=git_branch, git_commit=git_commit, rp_env=rp_env)
 
 
 def pytest_load_initial_conftests(args):
@@ -193,75 +252,75 @@ def pytest_load_initial_conftests(args):
 
 
 def pytest_addoption(parser):
-   parser.addoption(
-       "--json-report",
-       action="store",
-       default="final_report.json",
-       help="Directory to save individual JSON test reports"
-   )
-   parser.addoption(
+    group = parser.getgroup(
+        "pytest-html-plus",
+        "pytest-html-plus reporting options"
+    )
+
+
+    group.addoption(
+           "--json-report",
+           action="store",
+           default="final_report.json",
+           help="Name of the JSON report file generated alongside the HTML report"
+       )
+    group.addoption(
        "--capture-screenshots",
        action="store",
        default="failed",
        choices=["failed", "all", "none"],
        help="Capture screenshots: failed (default), all, or none"
    )
-   parser.addoption("--html-output", default="report_output")
-   parser.addoption("--screenshots", default="screenshots")
-   parser.addoption(
+    group.addoption("--html-output", default="report_output")
+    group.addoption("--screenshots", default="screenshots")
+    group.addoption(
        "--plus-email",
        action="store_true",
        default=False,
        help="Send HTML test report via email after test run"
    )
-   parser.addoption(
+    group.addoption(
        "--detect-flake",
        action="store",
        default=False,
        help="Helps capture flaky tests in the last n number of builds"
    )
-   parser.addoption(
+    group.addoption(
        "--should-open-report",
        action="store",
        default="failed",
        choices=["always", "failed", "never"],
        help="When to open the HTML report: always, failed, or never (default: failed)",
    )
-   parser.addoption(
+    group.addoption(
        "--generate-xml",
        action="store_true",
        default=False,
        help="Generate JUnit-style XML from the final JSON report"
    )
-   parser.addoption(
+    group.addoption(
        "--xml-report",
        action="store",
        default=None,
-       help="Path to output the XML report (used with --generatexml)"
+       help="Name of the XML report file generated alongside the HTML report (used with --generate-xml)"
    )
-   parser.addoption(
+    group.addoption(
        "--git-branch",
        action="store",
        default="Pass --git-branch to populate git metadata",
        help="Helps show branch information on the report"
    )
-   parser.addoption(
+    group.addoption(
        "--git-commit",
        action="store",
        default="Pass --git-commit to populate git metadata",
        help="Helps show commitId information on the report"
    )
-   parser.addoption(
-       "--env",
-       action="store",
-       default="Pass --env or --environment <name> to populate environment",
-       help="Helps show commitId information on the report"
-   )
-   parser.addoption(
-       "--environment",
+    group.addoption(
+       "--rp-env",
        action="store",
-       default="Pass --env or --environment <name> to populate environment",
-       help="Helps show commitId information on the report"
+       default="Pass --rp-env to populate environment",
+       help="Helps show env information on the report"
    )
 
 import logging
@@ -361,6 +420,7 @@ def open_html_report(report_path: str, json_path: str, config) -> None:
 
        results = report_data.get("results", [])
 
+
        has_failures = any(
            t.get("status") == "failed" or t.get("error")
            for t in results

{pytest_html_plus-0.4.8 → pytest_html_plus-0.5.0}/pytest_html_plus/utils.py

@@ -7,7 +7,7 @@ def get_env_marker(config):
     for arg in ("--env", "--environment"):
         if config.getoption(arg.lstrip("-").replace("-", "_"), default=None):
             return config.getoption(arg.lstrip("-").replace("-", "_"))
-    return "Pass --env <name> to populate environment"
+    return "Pass --rp-env to populate environment"
 
 def get_report_title(output_path):
     report_path = output_path