Source code for runtimepy.schemas

"""
A module for working with schemas belonging to this package.
"""

# built-in
from typing import Optional as _Optional

# third-party
from vcorelib.dict.codec import DictCodec as _DictCodec
from vcorelib.io import DEFAULT_INCLUDES_KEY
from vcorelib.paths.find import PACKAGE_SEARCH
from vcorelib.schemas.base import SchemaMap as _SchemaMap
from vcorelib.schemas.json import JsonSchemaMap as _JsonSchemaMap

# internal
from runtimepy import PKG_NAME

# Add this package to the search path.
if PKG_NAME not in PACKAGE_SEARCH:
    PACKAGE_SEARCH.insert(0, PKG_NAME)


[docs] class RuntimepyDictCodec(_DictCodec): """ A simple wrapper for package classes that want to implement DictCodec. """ default_schemas: _Optional[_SchemaMap] = _JsonSchemaMap.from_package( PKG_NAME, includes_key=DEFAULT_INCLUDES_KEY, )