test_compound_validator.py

import pytest
from _plotly_utils.basevalidators import CompoundValidator
from plotly.graph_objs.scatter import Marker


# Fixtures
# --------
@pytest.fixture()
def validator():
    return CompoundValidator("prop", "scatter", data_class_str="Marker", data_docs="")


# Tests
# -----
def test_acceptance(validator):
    val = Marker(color="green", size=10)
    res = validator.validate_coerce(val)

    assert isinstance(res, Marker)
    assert res.color == "green"
    assert res.size == 10


def test_acceptance_none(validator):
    val = None
    res = validator.validate_coerce(val)

    assert isinstance(res, Marker)
    assert res.color is None
    assert res.size is None


def test_acceptance_dict(validator):
    val = dict(color="green", size=10)
    res = validator.validate_coerce(val)

    assert isinstance(res, Marker)
    assert res.color == "green"
    assert res.size == 10


def test_rejection_type(validator):
    val = 37

    with pytest.raises(ValueError) as validation_failure:
        validator.validate_coerce(val)

    assert "Invalid value" in str(validation_failure.value)


def test_rejection_value(validator):
    val = dict(color="green", size=10, bogus=99)

    with pytest.raises(ValueError) as validation_failure:
        validator.validate_coerce(val)

    assert (
        "Invalid property specified for object of type "
        "plotly.graph_objs.scatter.Marker: 'bogus'" in str(validation_failure.value)
    )


def test_skip_invalid(validator):
    val = dict(
        color="green",
        size=10,
        bogus=99,  # Bad property name
        colorbar={"bgcolor": "blue", "bogus_inner": 23},  # Bad nested property name
        opacity="bogus value",  # Bad value for valid property
    )

    expected = dict(color="green", size=10, colorbar={"bgcolor": "blue"})

    res = validator.validate_coerce(val, skip_invalid=True)
    assert res.to_plotly_json() == expected


def test_skip_invalid_empty_object(validator):
    val = dict(
        color="green",
        size=10,
        colorbar={
            "bgcolor": "bad_color",  # Bad value for valid property
            "bogus_inner": 23,  # Bad nested property name
        },
        opacity=0.5,  # Bad value for valid property
    )

    # The colorbar property should be absent, not None or {}
    expected = dict(color="green", size=10, opacity=0.5)

    res = validator.validate_coerce(val, skip_invalid=True)
    assert res.to_plotly_json() == expected