RegionColumnSpec

final class lsst.daf.butler.column_spec.RegionColumnSpec(*, name: str = 'region', doc: str = '', type: Literal['region'] = 'region', nullable: bool = True, nbytes: int = 2048)

Bases: _BaseColumnSpec

Description of a region column.

Attributes Summary

model_computed_fields	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_fields	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

Methods Summary

serializer()	Return object that converts values of this column to or from serializable format.
to_arrow()	Return an object that converts values of this column to a column in an Arrow table.

Attributes Documentation

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'doc': FieldInfo(annotation=str, required=False, default='', description='Documentation for the column.'), 'name': FieldInfo(annotation=str, required=False, default='region'), 'nbytes': FieldInfo(annotation=int, required=False, default=2048), 'nullable': FieldInfo(annotation=bool, required=False, default=True, description='Whether the column may be ``NULL``.'), 'type': FieldInfo(annotation=Literal['region'], required=False, default='region')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Methods Documentation

serializer() → ColumnValueSerializer

Return object that converts values of this column to or from serializable format.

Returns:

serializerColumnValueSerializer

A converter instance.

to_arrow() → ToArrow

Return an object that converts values of this column to a column in an Arrow table.

Returns:

converterarrow_utils.ToArrow

A converter object with schema information in Arrow form.