gws.base.model.field

Source code: gws.base.model.field

Module Contents

class gws.base.model.field.Props(*args, **kwargs)

Bases: gws.Props

Object properties.

attributeType: gws.AttributeType

geometryType: gws.GeometryType

name: str

title: str

type: str

widget: gws.ext.props.modelWidget

uid: str

relatedModelUids: list[str]

class gws.base.model.field.Config(*args, **kwargs)

Bases: gws.ConfigWithAccess

Basic config with permissions.

name: str

title: str | None

isPrimaryKey: bool | None

isRequired: bool | None

isUnique: bool | None

isAuto: bool | None

values: list[gws.ext.config.modelValue] | None

validators: list[gws.ext.config.modelValidator] | None

widget: gws.ext.config.modelWidget | None

class gws.base.model.field.Object

Bases: gws.ModelField

Model field.

configure()

Configuration hook.

configure_flags()

configure_values()

configure_validators()

configure_widget()

post_configure()

Post-configuration hook.

props(user)

Generate a Props struct for this object.

Parameters:

user – The user for which the props should be generated.

do_validate(feature, mc)

related_models()

find_relatable_features(search, mc)

raw_to_python(feature, value, mc: gws.ModelContext)

prop_to_python(feature, value, mc: gws.ModelContext)

python_to_raw(feature, value, mc: gws.ModelContext)

python_to_prop(feature, value, mc: gws.ModelContext)

describe()