qref.schema_v1

schema_v1

Pydantic models used for defining V1 schema of Routine.

NAME_PATTERN module-attribute

NAME_PATTERN = '[A-Za-z_][A-Za-z0-9_]*'

OPTIONALLY_NAMESPACED_NAME_PATTERN module-attribute

OPTIONALLY_NAMESPACED_NAME_PATTERN = f'({NAME_PATTERN}\.)?{NAME_PATTERN}'

MULTINAMESPACED_NAME_PATTERN module-attribute

MULTINAMESPACED_NAME_PATTERN = f'({NAME_PATTERN}\.)+{NAME_PATTERN}'

OPTIONALLY_MULTINAMESPACED_NAME_PATTERN module-attribute

OPTIONALLY_MULTINAMESPACED_NAME_PATTERN = f'({NAME_PATTERN}\.)*{NAME_PATTERN}'

CONNECTION_PATTERN module-attribute

CONNECTION_PATTERN = f'{OPTIONALLY_MULTINAMESPACED_NAME_PATTERN} -> {OPTIONALLY_MULTINAMESPACED_NAME_PATTERN}'

T module-attribute

T = TypeVar('T')

CONNECTION_SCHEMA module-attribute

CONNECTION_SCHEMA = {'type': 'array', 'items': {'anyOf': [{'$ref': '#/$defs/Connection'}, {'pattern': f'^{CONNECTION_PATTERN}$', 'type': 'string'}]}, 'title': 'Connections', 'type': 'array'}

NamedList

Bases: list[T]

by_name property

by_name: _ProxyMapping[T]

__get_pydantic_core_schema__ classmethod

__get_pydantic_core_schema__(source, handler)

PortV1

Bases: BaseModel

Description of Port in V1 schema

name instance-attribute

name: _Name

direction instance-attribute

direction: Literal['input', 'output', 'through']

size instance-attribute

size: _Value | None

model_config class-attribute instance-attribute

model_config = ConfigDict(title='Port')

ConnectionV1

Bases: BaseModel

Description of Connection in V1 schema

source instance-attribute

source: _OptionallyNamespacedName

target instance-attribute

target: _OptionallyNamespacedName

model_config class-attribute instance-attribute

model_config = ConfigDict(title='Connection', use_enum_values=True)

ResourceV1

Bases: BaseModel

Description of Resource in V1 schema

name instance-attribute

name: _Name

type instance-attribute

type: Literal['additive', 'multiplicative', 'qubits', 'other']

value instance-attribute

value: _Value | None

model_config class-attribute instance-attribute

model_config = ConfigDict(title='Resource')

ParamLinkV1

Bases: BaseModel

Description of Parameter link in V1 schema

source instance-attribute

source: _OptionallyNamespacedName

targets instance-attribute

targets: list[_MultiNamespacedName]

model_config class-attribute instance-attribute

model_config = ConfigDict(title='ParamLink')

ConstantSequenceV1

Bases: BaseModel

Description of a constant sequence in a V1 Schema.

In a constant sequence we repeat an element multiplier times in each iteration.

type instance-attribute

type: Literal['constant']

multiplier class-attribute instance-attribute

multiplier: _Value = 1

ArithmeticSequenceV1

Bases: BaseModel

Description of an arithmetic sequence in a V1 Schema.

In an arithmetic sequence we start from initial_term repetitions of an element, and in each iteration we increase it by difference.

type instance-attribute

type: Literal['arithmetic']

initial_term class-attribute instance-attribute

initial_term: _Value = 0

difference instance-attribute

difference: _Value

GeometricSequenceV1

Bases: BaseModel

Description of a geometric sequence in a V1 Schema.

In a geometric sequence we start from 1 repetition of an element, and in each iteration we multiply it by ratio.

type instance-attribute

type: Literal['geometric']

ratio instance-attribute

ratio: _Value

ClosedFormSequenceV1

Bases: BaseModel

Description of a sequence with known closed-form for a sum or product in a V1 Schema.

If sum/prod are specified, they can be used to calculate these values for a given sequence. Expressions for sum/prod should use num_terms_symbol to represent the total number of terms.

type instance-attribute

type: Literal['closed_form']

sum class-attribute instance-attribute

sum: _Value | None = None

prod class-attribute instance-attribute

prod: _Value | None = None

num_terms_symbol instance-attribute

num_terms_symbol: str

CustomSequenceV1

Bases: BaseModel

Description of a custom sequence in a V1 Schema.

For sequences which do not fall into categories defined in other classes, one can use a custom representation. It is an explicit representation of a sequence where term_expression defines the expression for each term in the sequence and iterator_symbol is used to represent number of the iteration.

type instance-attribute

type: Literal['custom']

term_expression instance-attribute

term_expression: str

iterator_symbol class-attribute instance-attribute

iterator_symbol: str = 'i'

RepetitionV1

Bases: BaseModel

Description of a repetition of a routine in V1 schema.

count instance-attribute

count: int | str

sequence instance-attribute

sequence: ConstantSequenceV1 | ArithmeticSequenceV1 | GeometricSequenceV1 | ClosedFormSequenceV1 | CustomSequenceV1

RoutineV1

RoutineV1(**data: Any)

Bases: BaseModel

Description of Routine in V1 schema.

Note

This is NOT a top-level object in the schema. Instead, RoutineV1 is wrapped in SchemaV1.

name instance-attribute

name: _Name

children class-attribute instance-attribute

children: NamedList[RoutineV1] = Field(default_factory=NamedList)

type class-attribute instance-attribute

type: str | None = None

ports class-attribute instance-attribute

ports: Annotated[NamedList[PortV1], _name_sorter] = Field(default_factory=NamedList)

resources class-attribute instance-attribute

resources: Annotated[NamedList[ResourceV1], _name_sorter] = Field(default_factory=NamedList)

connections class-attribute instance-attribute

connections: Annotated[list[Annotated[ConnectionV1, _connection_parser]], _source_sorter] = []

input_params class-attribute instance-attribute

input_params: list[_OptionallyMultiNamespacedName] = []

local_variables class-attribute instance-attribute

local_variables: dict[str, str] = {}

linked_params class-attribute instance-attribute

linked_params: Annotated[list[ParamLinkV1], _source_sorter] = []

repetition class-attribute instance-attribute

repetition: RepetitionV1 | None = None

meta class-attribute instance-attribute

meta: dict[str, Any] = {}

model_config class-attribute instance-attribute

model_config = ConfigDict(title='Routine', validate_assignment=True)

generate_schema_v1

generate_schema_v1() -> dict[str, Any]

Generate Routine schema V1.

The schema is generated from DocumentRootV1 model, and then enriched with additional fields "title" and "$schema".