update: duration_format renders deprecation warning

Author: BeyondEvil

docs/user_guide.rst

@@ -281,29 +281,6 @@ The following query parameters may be passed:
 * :code:`xpassed`
 * :code:`rerun`
 
-Formatting the Duration Column
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The formatting of the timestamp used in the :code:`Durations` column can be modified by setting :code:`duration_formatter`
-on the :code:`report` attribute. All `time.strftime`_ formatting directives are supported. In addition, it is possible
-to supply :code:`%f` to get duration milliseconds. If this value is not set, the values in the :code:`Durations` column are
-displayed in :code:`%S.%f` format where :code:`%S` is the total number of seconds a test ran for.
-
-Below is an example of a :code:`conftest.py` file setting :code:`duration_formatter`:
-
-.. code-block:: python
-
-   import pytest
-
-
-   @pytest.hookimpl(hookwrapper=True)
-   def pytest_runtest_makereport(item, call):
-       outcome = yield
-       report = outcome.get_result()
-       setattr(report, "duration_formatter", "%H:%M:%S.%f")
-
-**NOTE**: Milliseconds are always displayed with a precision of 2
-
 .. _@pytest.hookimpl(tryfirst=True): https://docs.pytest.org/en/stable/writing_plugins.html#hook-function-ordering-call-example
 .. _ansi2html: https://pypi.python.org/pypi/ansi2html/
 .. _Content Security Policy (CSP): https://developer.mozilla.org/docs/Web/Security/CSP/

src/pytest_html/nextgen.py

@@ -45,12 +45,11 @@ def insert(self, index, html):
             self._html[index] = html
 
     class Report:
-        def __init__(self, title, duration_format):
+        def __init__(self, title):
             self._data = {
                 "title": title,
                 "collectedItems": 0,
                 "runningState": "not_started",
-                "durationFormat": duration_format,
                 "environment": {},
                 "tests": [],
                 "resultsTableHeader": {},
@@ -84,11 +83,10 @@ def __init__(self, report_path, config, default_css="style.css"):
         self._css = _process_css(
             Path(self._resources_path, default_css), self._config.getoption("css")
         )
-        self._duration_format = config.getini("duration_format")
         self._max_asset_filename_length = int(
             config.getini("max_asset_filename_length")
         )
-        self._report = self.Report(self._report_path.name, self._duration_format)
+        self._report = self.Report(self._report_path.name)
 
     @property
     def css(self):
@@ -242,6 +240,12 @@ def pytest_collection_finish(self, session):
 
     @pytest.hookimpl(trylast=True)
     def pytest_runtest_logreport(self, report):
+        if hasattr(report, "duration_formatter"):
+            warnings.warn(
+                "'duration_format' has been removed and no longer has any effect!",
+                DeprecationWarning,
+            )
+
         data = {
             "duration": report.duration,
             "when": report.when,

src/pytest_html/plugin.py

@@ -42,11 +42,6 @@ def pytest_addoption(parser):
         default=[],
         help="append given css file content to report style file.",
     )
-    parser.addini(
-        "duration_format",
-        default=None,
-        help="the format for duration.",
-    )
     parser.addini(
         "render_collapsed",
         type="bool",

testing/test_unit.py

@@ -0,0 +1,29 @@
+pytest_plugins = ("pytester",)
+
+
+def run(pytester, path="report.html", *args):
+    path = pytester.path.joinpath(path)
+    return pytester.runpytest("-s", "--html", path, *args)
+
+
+def test_duration_format_deprecation_warning(pytester):
+    pytester.makeconftest(
+        """
+        import pytest
+        @pytest.hookimpl(hookwrapper=True)
+        def pytest_runtest_makereport(item, call):
+            outcome = yield
+            report = outcome.get_result()
+            setattr(report, "duration_formatter", "%H:%M:%S.%f")
+    """
+    )
+    pytester.makepyfile(
+        """
+        import pytest
+        def test_pass():
+            with pytest.warns(DeprecationWarning) as record:
+                assert len(record) == 1
+    """
+    )
+    result = run(pytester)
+    assert result.ret == 0