Models

Banjo’s Model class extends Django’s with from_dict and to_dict methods, which are important for Banjo’s use case: consuming JSON requests and producing JSON responses.

Banjo’s ModelField classes wrap Django’s, adding default values and required cascade behavior for foreign keys.

class banjo.models.BooleanField(*args, **kwargs)

A database column which stores a boolean. The default value is False.

class banjo.models.FloatField(*args, **kwargs)

A database column which stores a float. The default value is 0.0.

class banjo.models.ForeignKey(*args, **kwargs)

A database column which links a model to another model.

class banjo.models.IntegerField(*args, **kwargs)

A database column which stores an integer. The default value is 0.

class banjo.models.Model(*args, **kwargs)

class Meta

abstract = False

app_label = 'app'

classmethod from_dict(props)

Tries to create an instance of Model from props.

objects

to_dict(with_related=True)

Returns a json representation of the Model.

class banjo.models.QuerySet(model=None, query=None, using=None, hints=None)

Extends the base QuerySey with random() and sample() methods

random()

sample(n)

class banjo.models.StringField(*args, **kwargs)

A database column which stores a string. The default value is ‘’, the empty string.

banjo.models.serialize(obj)

Safely converts an object to a dict, regardless of whether it implements banjo’s to_dict interface.