Fix PathPair & PathPairCollection validation; add path_pair type hint fn; use path_pair in Topmodel init_config model

[aaraney]

ngen.config

Additions

• path_pair type hint fn. Use this instead of PathPair (see Feature Details section in Fix PathPair & PathPairCollection validation; add path_pair type hint fn; use path_pair in Topmodel init_config model #183)
• Topmodel subcat and param fields can now be initialized with TopModelSubcat and TopModelParams instances respectively.

Changes

• Fix PathPair & PathPairCollection model validation
• Use path_pair type hint function in Topmodel init_config model
• AbstractPathPairMixin.read return type hint correct to bool. Already returned bool, type hint was missing.

Feature Details

path_pair type hint function:

In nearly all cases, this should be used as the pydantic model field type if the field is to be a PathPair[T]. This will ensure that the PathPair[T] instance has the specified serializer, deserializer, reader, and writer.

NOTE: if a PathPair instance is passed to a model field defined using this function during initialization of the model, any serializer, deserializer, reader, or writer on the PathPair instance will not be replaced by the inputs provided to this function.

NOTE: if a pydantic model's field type is defined using this function, it's ModelField.type_ will be a PathPairOptions.

Example:

import typing
import pydantic
from ngen.config.path_pair import (
    PathPair,
    pydantic_serializer,
    pydantic_deserializer,
)

class Model(pydantic.BaseModel):
    field: int

class Foo(pydantic.BaseModel):
    # make static type checkers happy
    if typing.TYPE_CHECKING:
        path: PathPair[Model]
    else:
        path: path_pair(
            Model,
            serializer=pydantic_serializer,
            deserializer=pydantic_deserializer(Model),
        )

[hellkite500]

which value?