Skip to content

Schema

Schema Utils

schema

Schema utilities for loading constants from py-avd.

This module provides utilities to dynamically load schema constants from the py-avd library, with graceful fallback to hardcoded values when py-avd is unavailable.

clear_schema_cache 

clear_schema_cache() -> None

Clear cached schema values.

Useful for testing or when py-avd is dynamically loaded.

Examples:

>>> clear_schema_cache()
>>> platforms = get_supported_platforms()  # Will reload from schema
Source code in avd_cli/utils/schema.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
def clear_schema_cache() -> None:
    """Clear cached schema values.

    Useful for testing or when py-avd is dynamically loaded.

    Examples
    --------
    >>> clear_schema_cache()
    >>> platforms = get_supported_platforms()  # Will reload from schema
    """
    get_supported_platforms.cache_clear()
    get_supported_device_types.cache_clear()
    get_avd_schema_version.cache_clear()

get_avd_schema_version cached 

get_avd_schema_version() -> Optional[str]

Get py-avd schema version.

Returns:

Type Description
Optional[str]

Schema version string, or None if py-avd unavailable

Examples:

>>> version = get_avd_schema_version()
>>> version is None or isinstance(version, str)
True
Source code in avd_cli/utils/schema.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
@lru_cache(maxsize=1)
def get_avd_schema_version() -> Optional[str]:
    """Get py-avd schema version.

    Returns
    -------
    Optional[str]
        Schema version string, or None if py-avd unavailable

    Examples
    --------
    >>> version = get_avd_schema_version()
    >>> version is None or isinstance(version, str)
    True
    """
    try:
        import pyavd

        return getattr(pyavd, "__version__", None)
    except ImportError:
        logger.debug("py-avd not available, schema version unknown")
        return None

get_supported_device_types cached 

get_supported_device_types() -> List[str]

Get list of supported device types.

Attempts to load from py-avd schema. Falls back to hardcoded list if py-avd is unavailable or import fails.

Returns:

Type Description
List[str]

List of supported device type names

Examples:

>>> types = get_supported_device_types()
>>> "spine" in types
True
Source code in avd_cli/utils/schema.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@lru_cache(maxsize=1)
def get_supported_device_types() -> List[str]:
    """Get list of supported device types.

    Attempts to load from py-avd schema. Falls back to hardcoded list
    if py-avd is unavailable or import fails.

    Returns
    -------
    List[str]
        List of supported device type names

    Examples
    --------
    >>> types = get_supported_device_types()
    >>> "spine" in types
    True
    """
    try:
        # Attempt to import py-avd schema
        import pyavd  # noqa: F401

        # For now, return fallback until py-avd API is confirmed
        logger.info("py-avd available, using %d device types", len(_FALLBACK_DEVICE_TYPES))
        return list(_FALLBACK_DEVICE_TYPES)

    except (ImportError, AttributeError) as e:
        logger.debug("Could not load device types from py-avd: %s. Using fallback list.", e)
        return list(_FALLBACK_DEVICE_TYPES)

get_supported_platforms cached 

get_supported_platforms() -> List[str]

Get list of supported EOS platforms.

Attempts to load from py-avd schema. Falls back to hardcoded list if py-avd is unavailable or import fails.

Returns:

Type Description
List[str]

List of supported platform names

Examples:

>>> platforms = get_supported_platforms()
>>> "vEOS-lab" in platforms
True
Source code in avd_cli/utils/schema.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@lru_cache(maxsize=1)
def get_supported_platforms() -> List[str]:
    """Get list of supported EOS platforms.

    Attempts to load from py-avd schema. Falls back to hardcoded list
    if py-avd is unavailable or import fails.

    Returns
    -------
    List[str]
        List of supported platform names

    Examples
    --------
    >>> platforms = get_supported_platforms()
    >>> "vEOS-lab" in platforms
    True
    """
    try:
        # Attempt to import py-avd schema
        # Note: Actual pyavd API may differ - adjust based on real implementation
        import pyavd  # noqa: F401

        # For now, return fallback until py-avd API is confirmed
        logger.info("py-avd available, using %d platforms", len(_FALLBACK_PLATFORMS))
        return list(_FALLBACK_PLATFORMS)

    except (ImportError, AttributeError) as e:
        logger.debug("Could not load platforms from py-avd: %s. Using fallback list.", e)
        return list(_FALLBACK_PLATFORMS)