couchdbkit.schema.properties.Property

Class Property

object --+ | Property

Property base which all other properties inherit.

Instance Methods

__init__(self, verbose_name=None, name=None, default=None, required=False, validators=None, choices=None)
Default constructor for a property.

source code

__property_config__(self, document_class, property_name)

source code

__property_init__(self, document_instance, value)
method used to set value of the property when we create the document.

source code

__get__(self, document_instance, document_class)

source code

__set__(self, document_instance, value)

source code

__delete__(self, document_instance)

source code

default_value(self)
return default value

source code

validate(self, value, required=True)
validate value

source code

empty(self, value)
test if value is empty

source code

_to_python(self, value)

source code

_to_json(self, value)

source code

to_python(self, value)
convert to python type

source code

to_json(self, value)
convert to json, Converted value is saved in couchdb.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

creation_counter = 0

data_type = None
hash(x)

Properties

[hide private]

Inherited from object: __class__

init(self, verbose_name=None, name=None, default=None, required=False, validators=None, choices=None)
(Constructor)

source code

Default constructor for a property.

:param verbose_name: str, verbose name of field, could
        be use for description
:param name: str, name of field
:param default: default value
:param required: True if field is required, default is False
:param validators: list of callable or callable, field validators
function that are executed when document is saved.

Overrides: object.__init__

__property_init__(self, document_instance, value)

source code

method used to set value of the property when we create the document. Don't check required.

Class Property

__init__(self, verbose_name=None, name=None, default=None, required=False, validators=None, choices=None) (Constructor)

__property_init__(self, document_instance, value)

init(self, verbose_name=None, name=None, default=None, required=False, validators=None, choices=None)
(Constructor)