Repository: altair-viz/altair

Issue:
Multiple rounds of the same error message
I noticed that some specs shows the same error multiple time, for example:

```py
source = data.cars()
alt.Chart(source).mark_text(align="right").encode(
    alt.Text("Horsepower:N", bandPosition='4')
)
```

```
'4' is not of type 'number'
Additional properties are not allowed ('field' was unexpected)
'4' is not of type 'number'
Additional properties are not allowed ('bandPosition', 'field', 'type' were unexpected)
```

Sometimes these messages can become quite long:

```python
alt.Text("Horsepower:N", type=dict(text="Horsepower", align="right"))
```

```
{'text': 'Horsepower', 'align': 'right'} is not one of ['quantitative', 'ordinal', 'temporal', 'nominal']
{'text': 'Horsepower', 'align': 'right'} is not of type 'string'
Additional properties are not allowed ('field' was unexpected)
{'text': 'Horsepower', 'align': 'right'} is not one of ['quantitative', 'ordinal', 'temporal', 'nominal', 'geojson']
{'text': 'Horsepower', 'align': 'right'} is not of type 'string'
Additional properties are not allowed ('field', 'type' were unexpected)
```

Granted that these multiple errors are likely rare this is probably not high priority (and maybe even desirable for some reasons that escapes me right now), but I thought I would document them anyways.



Discussion:
mattijn: Thanks @binste!

After this PR, the following examples return as such:

```python
import altair as alt
from vega_datasets import data

alt.Chart().encode(alt.Angle().sort("invalid_value"))
```
```cmd
SchemaValidationError: 'invalid_value' is an invalid value for `sort`:

'invalid_value' is not of type 'array'

alt.Chart(...)
```

```python
source = data.cars()
alt.Chart(source).mark_text(align="right").encode(
    alt.Text("Horsepower:N", bandPosition='4')
)
```
```cmd
SchemaValidationError: '4' is an invalid value for `bandPosition`:

'4' is not of type 'number'
Additional properties are not allowed ('field' was unexpected)
Additional properties are not allowed ('bandPosition', 'field', 'type' were unexpected)

alt.Chart(...)
```

```python
alt.Text("Horsepower:N", type=dict(text="Horsepower", align="right")).to_dict()
```
```cmd
SchemaValidationError: '{'text': 'Horsepower', 'align': 'right'}' is an invalid value for `type`:

{'text': 'Horsepower', 'align': 'right'} is not one of ['quantitative', 'ordinal', 'temporal', 'nominal']
{'text': 'Horsepower', 'align': 'right'} is not of type 'string'
```

No duplication of error messages anymore. Will merge once tests pass.

One question, why did you had to add the `$` sign?

Patch:
diff --git a/altair/utils/schemapi.py b/altair/utils/schemapi.py
index 298a1cbf..03b5fc1e 100644
--- a/altair/utils/schemapi.py
+++ b/altair/utils/schemapi.py
@@ -299,9 +299,23 @@ class SchemaValidationError(jsonschema.ValidationError):
                 {message}"""
 
             if self._additional_errors:
-                message += "\n                " + "\n                ".join(
-                    [e.message for e in self._additional_errors]
+                # Deduplicate error messages and only include them if they are
+                # different then the main error message stored in self.message.
+                # Using dict instead of set to keep the original order in case it was
+                # chosen intentionally to move more relevant error messages to the top
+                additional_error_messages = list(
+                    dict.fromkeys(
+                        [
+                            e.message
+                            for e in self._additional_errors
+                            if e.message != self.message
+                        ]
+                    )
                 )
+                if additional_error_messages:
+                    message += "\n                " + "\n                ".join(
+                        additional_error_messages
+                    )
 
             return inspect.cleandoc(
                 """{}
diff --git a/tools/schemapi/schemapi.py b/tools/schemapi/schemapi.py
index 1a97c074..799cf0b1 100644
--- a/tools/schemapi/schemapi.py
+++ b/tools/schemapi/schemapi.py
@@ -297,9 +297,23 @@ class SchemaValidationError(jsonschema.ValidationError):
                 {message}"""
 
             if self._additional_errors:
-                message += "\n                " + "\n                ".join(
-                    [e.message for e in self._additional_errors]
+                # Deduplicate error messages and only include them if they are
+                # different then the main error message stored in self.message.
+                # Using dict instead of set to keep the original order in case it was
+                # chosen intentionally to move more relevant error messages to the top
+                additional_error_messages = list(
+                    dict.fromkeys(
+                        [
+                            e.message
+                            for e in self._additional_errors
+                            if e.message != self.message
+                        ]
+                    )
                 )
+                if additional_error_messages:
+                    message += "\n                " + "\n                ".join(
+                        additional_error_messages
+                    )
 
             return inspect.cleandoc(
                 """{}


Test patch:
diff --git a/tests/utils/tests/test_schemapi.py b/tests/utils/tests/test_schemapi.py
index c2566dfd..35f14ce2 100644
--- a/tests/utils/tests/test_schemapi.py
+++ b/tests/utils/tests/test_schemapi.py
@@ -4,7 +4,6 @@ import inspect
 import json
 import jsonschema
 import jsonschema.exceptions
-import re
 import pickle
 import warnings
 
@@ -476,6 +475,18 @@ def chart_example_invalid_timeunit_value():
     return alt.Chart().encode(alt.Angle().timeUnit("invalid_value"))
 
 
+def chart_example_invalid_sort_value():
+    return alt.Chart().encode(alt.Angle().sort("invalid_value"))
+
+
+def chart_example_invalid_bandposition_value():
+    return (
+        alt.Chart(data.cars())
+        .mark_text(align="right")
+        .encode(alt.Text("Horsepower:N", bandPosition="4"))
+    )
+
+
 @pytest.mark.parametrize(
     "chart_func, expected_error_message",
     [
@@ -490,7 +501,7 @@ def chart_example_invalid_timeunit_value():
                 axis           impute   stack   type       
                 bandPosition                               
 
-                See the help for `X` to read the full description of these parameters"""  # noqa: W291
+                See the help for `X` to read the full description of these parameters$"""  # noqa: W291
             ),
         ),
         (
@@ -504,7 +515,7 @@ def chart_example_invalid_timeunit_value():
                 background   data       padding       spacing   usermeta    
                 bounds       datasets                                       
 
-                See the help for `VConcatChart` to read the full description of these parameters"""  # noqa: W291
+                See the help for `VConcatChart` to read the full description of these parameters$"""  # noqa: W291
             ),
         ),
         (
@@ -514,7 +525,7 @@ def chart_example_invalid_timeunit_value():
 
                 'asdf' is not one of \['zero', 'center', 'normalize'\]
                 'asdf' is not of type 'null'
-                'asdf' is not of type 'boolean'"""
+                'asdf' is not of type 'boolean'$"""
             ),
         ),
         (
@@ -524,7 +535,7 @@ def chart_example_invalid_timeunit_value():
 
                 'asdf' is not one of \['zero', 'center', 'normalize'\]
                 'asdf' is not of type 'null'
-                'asdf' is not of type 'boolean'"""
+                'asdf' is not of type 'boolean'$"""
             ),
         ),
         (
@@ -533,7 +544,7 @@ def chart_example_invalid_timeunit_value():
                 r"""'{'text': 'Horsepower', 'align': 'right'}' is an invalid value for `title`:
 
                 {'text': 'Horsepower', 'align': 'right'} is not of type 'string'
-                {'text': 'Horsepower', 'align': 'right'} is not of type 'array'"""
+                {'text': 'Horsepower', 'align': 'right'} is not of type 'array'$"""
             ),
         ),
         (
@@ -550,7 +561,7 @@ def chart_example_invalid_timeunit_value():
                 fillOpacity   opacity      stroke    theta2          xError2   yOffset   
                 href                                                                     
 
-                See the help for `Encoding` to read the full description of these parameters"""  # noqa: W291
+                See the help for `Encoding` to read the full description of these parameters$"""  # noqa: W291
             ),
         ),
         (
@@ -561,14 +572,33 @@ def chart_example_invalid_timeunit_value():
                 'invalid_value' is not one of \['year', 'quarter', 'month', 'week', 'day', 'dayofyear', 'date', 'hours', 'minutes', 'seconds', 'milliseconds'\]
                 'invalid_value' is not one of \['utcyear', 'utcquarter', 'utcmonth', 'utcweek', 'utcday', 'utcdayofyear', 'utcdate', 'utchours', 'utcminutes', 'utcseconds', 'utcmilliseconds'\]
                 'invalid_value' is not one of \['yearquarter', 'yearquartermonth', 'yearmonth', 'yearmonthdate', 'yearmonthdatehours', 'yearmonthdatehoursminutes', 'yearmonthdatehoursminutesseconds', 'yearweek', 'yearweekday', 'yearweekdayhours', 'yearweekdayhoursminutes', 'yearweekdayhoursminutesseconds', 'yeardayofyear', 'quartermonth', 'monthdate', 'monthdatehours', 'monthdatehoursminutes', 'monthdatehoursminutesseconds', 'weekday', 'weeksdayhours', 'weekdayhoursminutes', 'weekdayhoursminutesseconds', 'dayhours', 'dayhoursminutes', 'dayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds'\]
-                'invalid_value' is not one of \['utcyearquarter', 'utcyearquartermonth', 'utcyearmonth', 'utcyearmonthdate', 'utcyearmonthdatehours', 'utcyearmonthdatehoursminutes', 'utcyearmonthdatehoursminutesseconds', 'utcyearweek', 'utcyearweekday', 'utcyearweekdayhours', 'utcyearweekdayhoursminutes', 'utcyearweekdayhoursminutesseconds', 'utcyeardayofyear', 'utcquartermonth', 'utcmonthdate', 'utcmonthdatehours', 'utcmonthdatehoursminutes', 'utcmonthdatehoursminutesseconds', 'utcweekday', 'utcweeksdayhours', 'utcweekdayhoursminutes', 'utcweekdayhoursminutesseconds', 'utcdayhours', 'utcdayhoursminutes', 'utcdayhoursminutesseconds', 'utchoursminutes', 'utchoursminutesseconds', 'utcminutesseconds', 'utcsecondsmilliseconds'\]"""
+                'invalid_value' is not one of \['utcyearquarter', 'utcyearquartermonth', 'utcyearmonth', 'utcyearmonthdate', 'utcyearmonthdatehours', 'utcyearmonthdatehoursminutes', 'utcyearmonthdatehoursminutesseconds', 'utcyearweek', 'utcyearweekday', 'utcyearweekdayhours', 'utcyearweekdayhoursminutes', 'utcyearweekdayhoursminutesseconds', 'utcyeardayofyear', 'utcquartermonth', 'utcmonthdate', 'utcmonthdatehours', 'utcmonthdatehoursminutes', 'utcmonthdatehoursminutesseconds', 'utcweekday', 'utcweeksdayhours', 'utcweekdayhoursminutes', 'utcweekdayhoursminutesseconds', 'utcdayhours', 'utcdayhoursminutes', 'utcdayhoursminutesseconds', 'utchoursminutes', 'utchoursminutesseconds', 'utcminutesseconds', 'utcsecondsmilliseconds'\]$"""
+            ),
+        ),
+        (
+            chart_example_invalid_sort_value,
+            # Previuosly, the line
+            # "'invalid_value' is not of type 'array'" appeared multiple times in
+            # the error message. This test should prevent a regression.
+            inspect.cleandoc(
+                r"""'invalid_value' is an invalid value for `sort`:
+
+                'invalid_value' is not of type 'array'$"""
+            ),
+        ),
+        (
+            chart_example_invalid_bandposition_value,
+            inspect.cleandoc(
+                r"""'4' is an invalid value for `bandPosition`:
+
+                '4' is not of type 'number'
+                Additional properties are not allowed \('field' was unexpected\)
+                Additional properties are not allowed \('bandPosition', 'field', 'type' were unexpected\)$"""
             ),
         ),
     ],
 )
 def test_chart_validation_errors(chart_func, expected_error_message):
-    # DOTALL flag makes that a dot (.) also matches new lines
-    pattern = re.compile(expected_error_message, re.DOTALL)
     # For some wrong chart specifications such as an unknown encoding channel,
     # Altair already raises a warning before the chart specifications are validated.
     # We can ignore these warnings as we are interested in the errors being raised
@@ -576,7 +606,7 @@ def test_chart_validation_errors(chart_func, expected_error_message):
     with warnings.catch_warnings():
         warnings.filterwarnings("ignore", category=UserWarning)
         chart = chart_func()
-    with pytest.raises(SchemaValidationError, match=pattern):
+    with pytest.raises(SchemaValidationError, match=expected_error_message):
         chart.to_dict()