Zope 3 apidoc

Base interfaces

Attributes/Fields

unique (Attribute)

This ICollection interface attribute must be True
default * - Field (default = None)

Default Value

The field default value may be None or a legal field value
missing_value * - Field (default = None)

Missing Value

If input for this Field is missing, and that's ok, then this is the value to use
order * - Int (default = None)

Field Order

The order attribute can be used to determine the order in which fields in a schema were defined. If one field is created after another (in the same thread), its order will be greater.

(Fields in separate threads could have the same order.)
required * - Bool (default = True)

Required

Tells whether a field requires its value to exist.
value_type * - Field (default = None)

Value Type

Field value items must conform to the given type, expressed via a Field.
description - Text (default = u'')

Description

A description of the field
max_length - Int (default = None)

Maximum length

Value after whitespace processing cannot have greater or equal than max_length characters (if a string type) or elements (if another sequence type). If max_length is None, there is no maximum.
min_length - Int (default = 0)

Minimum length

Value after whitespace processing cannot have less than min_length characters (if a string type) or elements (if another sequence type). If min_length is None, there is no minimum.
readonly - Bool (default = False)

Read Only

If true, the field's value cannot be changed.
title - TextLine (default = u'')

Title

A short summary or label

* = required

Methods

set(object, value)

Set the value of the field for the object

Raises a type error if the field is a read-only field.
constraint(value)

Check a customized constraint on the value.

You can implement this method with your Field to require a certain constraint. This relaxes the need to inherit/subclass a Field you to add a simple constraint. Returns true if the given value is within the Field's constraint.
bind(object)

Return a copy of this field which is bound to context.

The copy of the Field will have the 'context' attribute set to 'object'. This way a Field can implement more complex checks involving the object's location/environment.

Many fields don't need to be bound. Only fields that condition validation or properties on an object containing the field need to be bound.
get(object)

Get the value of the field for the given object.
query(object, default=None)

Query the value of the field for the given object.

Return the default if the value hasn't been set.
validate(value)

Validate that the given value is a valid field value.

Returns nothing but raises an error if the value is invalid. It checks everything specific to a Field and also checks with the additional constraint.

Adapters for objects providing this interface:

Specific Adapters

There are no specific adapters registered for this interface.

Extended Adapters

There are no extended adapters registered for this interface.

Generic Adapters

Views

Other Information

Classes

A list of classes that implement this interface. This might duplicate the entries in Utilities.

zope.schema._field.FrozenSet
zope.schema._field.Set

Interface
zope.schema.interfaces.IAbstractSet

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Classes

Interface zope.schema.interfaces.IAbstractSet

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Classes

Interface
zope.schema.interfaces.IAbstractSet