RetrieverRef

RetrieverRef

Aliases another retriever, combiner, or another reference for flattening potentially nested struct properties to help with providing a more coherent API

__get__

__get__(instance: BaseStruct, owner: Type[BaseStruct]) -> Any

__new__

__new__(*target: Retriever | RetrieverRef | RetrieverCombiner | int | Get, enum: Type[Enum] = None) -> RetrieverRef

Create a new property which aliases the retriever property at the given path.

Parameters:

• *target (Retriever | RetrieverRef | RetrieverCombiner | int | Get, default: () ) –

  The retriever path to alias. This can be a sequence of retrievers/list indices starting in the current struct

• enum (Type[Enum], default: None ) –

  An enum class to convert values to/from. Note: if a value isn't found in the enum, it is left as it is

__set__

__set__(instance: BaseStruct, value: Any) -> None

__set_name__

__set_name__(owner: Type[BaseStruct], name: str) -> None