[tests] improve testing process by catching warning

and explain it in doc
#36

Author: thomas-saigre

.gitignore

@@ -18,7 +18,6 @@ src/tests/outputs/**
 # Doxygen output
 doxygen/*
 
-
 # Virtual environment
 .venv/
 *.egg-info/
@@ -29,4 +28,7 @@ dist/
 # Tox
 .tox/
 .coverage
-coverage.xml
+coverage.xml
+
+# Mkdocs site
+site/**

docs/develop/contributing.md

@@ -10,7 +10,7 @@ You can also submit a pull request with the desired feature or the correction of
 
 ## Development
 
-The actual code maybe quite messy (is with your contribution you manage to imrpove it, I thank you in advance !).
+The actual code maybe quite messy (is with your contribution you manage to improve it, I thank you in advance !).
 The source code of the package are present in the directory `src/tikzplotly`, in which each file is dedicated to a specific feature of the library.
 
 Some external packages are necessary to make tikzplotly work, that are specified in the `requirements.txt` file.
@@ -40,13 +40,19 @@ tox -- --cov tikzplotly --cov-report html --cov-report term
 
 The code coverage is available in the directory `htmlcov`.
 
-!!! info "Note about coverage"
+!!! Tip "Note about coverage"
     The coverage CI is quite strict, so you need to cover all the modification to pass it.
-    I found that tedious at first, but actually making it pass make me realize that there was some bogs in the code!
+    I found that tedious at first, but actually making it pass make me realize that there were some bogs in the code!
+
+??? Info "Pytest"
+    Some warnings are ignored by `pytest`, as they are intended for the user in some specific cases, that are not relevant in general test cases.
+    This corresponds to:
+    - the warning raised when [heat maps](../plot/supported/#heat-maps) PNG file is not resized (cf [issue comment](https://github.com/thomas-saigre/tikzplotly/issues/6#issuecomment-2106180586)),
+    - warning for features that are not yet implemented (such as text templates, or `barpolar` plots).
 
 
 ## Documentation
 
-Feel free to add some comments on this page, espacially if there are some notable differences between plotly and pgfplots (see [this page](../plot/NB.md)).
-This pages are written in Markdown and are present in the directory `docs`.
+Feel free to add some comments on this page, especially if there are some notable differences between plotly and pgfplots (see [this page](../plot/NB.md)).
+These pages are written in Markdown and are present in the directory `docs`.
 The site is build using [Mkdocs-materials](https://squidfunk.github.io/mkdocs-material/).

docs/develop/tests.md

@@ -2,7 +2,7 @@
 
 ## Local tests
 
-These tests are for development purpose, to ensure that the features that are developped are working as expected.
+These tests are for development purpose, to ensure that the features that are developed are working as expected.
 They are present in the directory `src/tests` and can be run with the following command, from the `src` directory.
 
 ```bash

pyproject.toml

@@ -36,3 +36,10 @@ dev = ["pandas"]
 [project.urls]
 Code = "https://github.com/thomas-saigre/tikzplotly"
 Issues = "https://github.com/thomas-saigre/tikzplotly/issues"
+
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore:png image has not been reduced.*:UserWarning",
+    "ignore:Text template is not supported yet.:UserWarning",
+]

requirements.txt

@@ -1,8 +1,11 @@
 numpy
 plotly
 pillow
-kaleido<1.0.0
+kaleido
 tox
 pandas
 mkdocs-material[recommended]
 mkdocs-git-revision-date-localized-plugin
+pytest
+pytest-cov
+pytest-codeblocks

src/tikzplotly/_histogram.py

@@ -92,6 +92,9 @@ def draw_histogram(trace, axis: Axis, colors_set, row_sep="\\\\"):
         axis.add_option("x filter/.expression", "rawy")
         axis.add_option("y filter/.expression", "rawx")
         hist_options["handler/.style"] = "{xbar interval}"
+    else:   # trace.x and trace.y are both empty
+        warn("Normally, we should reach this line")
+        data_str = ""
 
 
 

tests/test_colors.py

@@ -1,8 +1,10 @@
 import os
 import pathlib
+from contextlib import nullcontext
 
 import numpy
 import plotly.graph_objects as go
+import plotly.express as px
 import pytest
 
 from .helpers import assert_equality
@@ -17,6 +19,12 @@ def plot_color(color_scheme):
     fig.add_trace(go.Scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16], marker_color=color_scheme))
     return fig
 
+def plot_transparent_background():
+    fig = px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])
+    fig.update_layout(plot_bgcolor='rgba(255, 182, 193, .5)')
+
+    return fig
+
 
 @pytest.mark.parametrize(
     "color, warning_match",
@@ -35,7 +43,11 @@ def plot_color(color_scheme):
 def test_color(color, warning_match, request):
     id = request.node.callspec.id
     if warning_match is None:
-        assert_equality(plot_color(color), os.path.join(this_dir, test_name, f"{test_name}_{id}_reference.tex"))
+        context = nullcontext()
     else:
-        with pytest.warns(UserWarning, match=warning_match):
-            assert_equality(plot_color(color), os.path.join(this_dir, test_name, f"{test_name}_{id}_reference.tex"))
+        context =  pytest.warns(UserWarning, match=warning_match)
+    with context:
+        assert_equality(plot_color(color), os.path.join(this_dir, test_name, f"{test_name}_{id}_reference.tex"))
+
+def test_transparent_background():
+    assert_equality(plot_transparent_background(), os.path.join(this_dir, test_name, test_name + "_transparent_background_reference.tex"))

…fic_transparent_background_reference.tex …ors_transparent_background_reference.textests/test_specific/test_specific_transparent_background_reference.tex renamed to tests/test_colors/test_colors_transparent_background_reference.tex tests/test_specific/test_specific_transparent_background_reference.tex renamed to tests/test_colors/test_colors_transparent_background_reference.tex

@@ -1,6 +1,7 @@
 import plotly.express as px
 import plotly.graph_objects as go
 import numpy as np
+import pytest
 import os
 from .helpers import assert_equality
 import pathlib
@@ -22,6 +23,7 @@ def plot_2():
     return fig
 
 def plot_3():
+    # A plot with no colorscale
     fig = go.Figure(data=go.Heatmap(
                    z=[[1, None, 30, 50, 1], [20, 1, 60, 80, 30], [30, 60, 1, -10, 20]],
                    x=['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
@@ -35,7 +37,7 @@ def plot_4():
     programmers = ['Alex','Nicole','Sara','Etienne','Chelsea','Jody','Marianne']
 
     base = datetime.datetime(2021, 7, 20, 19, 30, 0)
-    dates = base - np.arange(180) * datetime.timedelta(days=1)
+    dates = [base - datetime.timedelta(days=int(i)) for i in np.arange(180)]
     np.random.seed(43)
     z = np.random.poisson(size=(len(programmers), len(dates)))
 
@@ -51,7 +53,7 @@ def plot_4():
 
     return fig
 
-def plot_5():
+def plot_empty_trace():
     fig = px.imshow([[1, 20, 30],
                     [20, 1, 60],
                     [30, 60, 1]])
@@ -65,10 +67,12 @@ def test_2():
     assert_equality(plot_2(), os.path.join(this_dir, test_name, test_name + "_2_reference.tex"), img_name="/tmp/tikzplotly/fig2.png")
 
 def test_3():
-    assert_equality(plot_3(), os.path.join(this_dir, test_name, test_name + "_3_reference.tex"), img_name="/tmp/tikzplotly/fig3.png")
+    with pytest.warns(UserWarning, match="No colorscale found, using default"):
+        assert_equality(plot_3(), os.path.join(this_dir, test_name, test_name + "_3_reference.tex"), img_name="/tmp/tikzplotly/fig3.png")
 
 def test_4():
     assert_equality(plot_4(), os.path.join(this_dir, test_name, test_name + "_4_reference.tex"), img_name="/tmp/tikzplotly/fig4.png")
 
-def test_5():
-    assert_equality(plot_5(), os.path.join(this_dir, test_name, test_name + "_5_reference.tex"))
+def test_empty_trace():
+    with pytest.warns(UserWarning, match="Adding empty trace."):
+        assert_equality(plot_empty_trace(), os.path.join(this_dir, test_name, test_name + "_5_reference.tex"))

tests/test_heatmap.py

@@ -2,6 +2,7 @@
 import plotly.graph_objects as go
 import numpy as np
 import os
+from contextlib import nullcontext
 from .helpers import assert_equality
 import pathlib
 import pytest
@@ -77,7 +78,12 @@ def test_3():
 
 @pytest.mark.parametrize("histnorm", ["percent", "probability", "density", "probability density"])
 def test_4(histnorm):
-    assert_equality(plot_4(histnorm), os.path.join(this_dir, test_name, test_name + "_4_reference.tex"))
+    if histnorm in ["percent", "probability", "density"]:
+        context = pytest.warns(UserWarning, match=r"Sorry, I did not find an equivalent for histnorm='\w+' in TikZ*")
+    else:
+        context = nullcontext()
+    with context:
+        assert_equality(plot_4(histnorm), os.path.join(this_dir, test_name, test_name + "_4_reference.tex"))
 
 def test_5():
     assert_equality(plot_5(), os.path.join(this_dir, test_name, test_name + "_5_reference.tex"))
@@ -86,7 +92,8 @@ def test_6():
     assert_equality(plot_6(), os.path.join(this_dir, test_name, test_name + "_6_reference.tex"))
 
 def test_7():
-    assert_equality(plot_7(), os.path.join(this_dir, test_name, test_name + "_7_reference.tex"))
+    with pytest.warns(UserWarning, match="To the best of our knowledge, other aggregate function than 'count' are not supported in pgfplots.*"):
+        assert_equality(plot_7(), os.path.join(this_dir, test_name, test_name + "_7_reference.tex"))
 
 def test_8():
     assert_equality(plot_8(), os.path.join(this_dir, test_name, test_name + "_8_reference.tex"))