genome_spy.LookupParams

class genome_spy.LookupParams(as_=Undefined, default=Undefined, description=Undefined, fields=Undefined, from_=Undefined, key=Undefined, type=Undefined, values=Undefined, **kwds)View on GitHub

Bases: GenomeSpySchema

Generated wrapper for LookupParams.

Methods

as_(value)	Return a copy with as updated.
copy(*[, deep])	Return a copy with optional keyword updates.
default(value)	Return a copy with default updated.
description(value)	Return a copy with description updated.
fields(value)	Return a copy with fields updated.
from_([value, description, ...])	Return a copy with from updated.
key(value)	Return a copy with key updated.
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.
values(value)	Return a copy with values updated.

as_(value)View on GitHub

Return a copy with as updated.

default(value)View on GitHub

Return a copy with default updated.

description(value)View on GitHub

Return a copy with description updated.

fields(value)View on GitHub

Return a copy with fields updated.

from_(value=Undefined, /, *, description=Undefined, dynamicCallbackSource=Undefined, format=Undefined, lazy=Undefined, name=Undefined, source=Undefined, url=Undefined, values=Undefined)View on GitHub

Return a copy with from updated.

Parameters:

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

• dynamicCallbackSource (bool) – The View class has getDynamicData() methods that provides the data. This is intended for internal use.

• format (CsvDataFormat | dict[str, Any] | DsvDataFormat | JsonDataFormat | BedDataFormat | BedpeDataFormat | WigDataFormat | VcfDataFormat | OtherDataFormat) – Schema-defined format property.

• lazy (LazyDataParams | dict[str, Any]) – Schema-defined lazy property.

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

• source (Literal['input']) – Use the current input data as the lookup table. Lookup reads all records from one input file or inline dataset before emitting results. Multiple files and facets are indexed separately.

• url (str | Sequence[str] | ExprRef | dict[str, Any] | UrlList | UrlTemplate) – An URL, a list of URLs, or a URL expansion definition from which to load the data set. A URL template can expand values from an ExprRef and attach the expanded value as a field to loaded rows. Gzip-compressed resources are decompressed transparently when the URL, MIME type, or payload indicates gzip content. Use the format.type property to ensure the loaded data is correctly parsed.

• values (InlineDataset | dict[str, Any]) – The full data set, included inline. This can be an array of objects or primitive values, an object, or a string. Arrays of primitive values are ingested as objects with a data property. Strings are parsed according to the specified format type.

key(value)View on GitHub

Return a copy with key updated.

type(value)View on GitHub

Return a copy with type updated.

values(value)View on GitHub

Return a copy with values 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.