Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

core.FieldProperties

core.FieldProperties(
    self,
    name=None,
    title=None,
    type=None,
    format=None,
    description=None,
    example=None,
    constraints=None,
    categories=None,
    categories_ordered=None,
    missing_values=None,
)

A field in a table schema.

Provides human-readable documentation as well as additional information that can be used to validate the field or create a user interface for data entry.

Attributes

name : str | None: A name for this field. Must be unique amongst other field names in this table schema.
title : str | None: A human readable label or title for this field.
type : FieldType | None: The data type of this field.
format : str | None: The format for this field.
description : str | None: A text description for this field.
example : str | None: An example value for this field.
constraints : ConstraintsProperties | None: The constraints applicable to this field.
categories : list[str] | list[int] | None: A finite set of possible values for this field.
categories_ordered : bool | None: Specifies whether the order of appearance of the values in the categories property should be regarded as their natural order.
missing_values : list[str] | list[MissingValueProperties] | None: Values that, when encountered in the field, should be considered as not present. Takes precedence over the schema-level property.

Methods

Name	Description
default	Creates an instance with default values.

default

core.FieldProperties.default()

Creates an instance with default values.

Returns

: Self: A FieldProperties object with default values