Skip to content

check_metadata_routing_default_request

yohou.testing.common.check_metadata_routing_default_request(estimator_fitted)

Check that by default metadata routing request is empty.

Tests: - get_metadata_routing() returns MetadataRouter or MetadataRequest - Default requests are empty (all metadata values are None)

Parameters

Name Type Description Default
estimator_fitted BaseForecaster | BaseTransformer

A fitted estimator instance

 required

Raises

Type Description
AssertionError

If routing structure is incorrect or requests are not empty

Source Code

View on GitHub

Show/Hide source 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def check_metadata_routing_default_request(estimator_fitted) -> None:
    """Check that by default metadata routing request is empty.

    Tests:
    - get_metadata_routing() returns MetadataRouter or MetadataRequest
    - Default requests are empty (all metadata values are None)

    Parameters
    ----------
    estimator_fitted : BaseForecaster | BaseTransformer
        A fitted estimator instance

    Raises
    ------
    AssertionError
        If routing structure is incorrect or requests are not empty

    """
    # Routing is always enabled in Yohou - no check needed

    router = estimator_fitted.get_metadata_routing()
    assert isinstance(router, MetadataRouter | MetadataRequest), (
        f"Expected MetadataRouter or MetadataRequest, got {type(router)}"
    )

    # Check requests are empty (with possible exclusions for defaults)
    exclude = {}  # Can add specific exclusions per estimator type
    assert_request_is_empty(router, exclude=exclude)