genome_spy.ValuesParams

class genome_spy.ValuesParams(description=Undefined, field=Undefined, param=Undefined, type=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for ValuesParams.

Methods

copy(*[, deep])	Return a copy with optional keyword updates.
description(value)	Return a copy with description updated.
field(value)	Return a copy with field updated.
param([value, name, push])	Return a copy with a TransformOutput param.
resolve_references()	Return this class schema with referenced properties merged in.
to_dict(*[, validate])	Serialize this schema wrapper to a JSON-compatible dictionary.
to_json(*[, validate])	Serialize this schema wrapper to formatted JSON.
type(value)	Return a copy with type updated.
validate(instance)	Validate an instance against this wrapper's schema.

description(value)View on GitHub

Return a copy with description updated.

field(value)View on GitHub

Return a copy with field updated.

param(value=Undefined, /, *, name=Undefined, push=Undefined)View on GitHub

Return a copy with a TransformOutput param.

Parameters:

• name (str) – Schema-defined name property.

• push (Literal['outer']) – Schema-defined push property.

type(value)View on GitHub

Return a copy with type updated.

copy(*, deep=True, **kwds)View on GitHub

Return a copy with optional keyword updates.

classmethod resolve_references()View on GitHub

Return this class schema with referenced properties merged in.

to_dict(*, validate=True)View on GitHub

Serialize this schema wrapper to a JSON-compatible dictionary.

to_json(*, validate=True)View on GitHub

Serialize this schema wrapper to formatted JSON.

classmethod validate(instance)View on GitHub

Validate an instance against this wrapper’s schema.