t.r.HABTM(Relationship) : class documentation

Part of twistar.relationships View In Hierarchy

A class representing the "has and bleongs to many" relationship. One additional argument this class uses in the Relationship.__init__ argument list is join_table.

Split Table into Classes Show Methods in One Table

Line #	Kind	Name	Docs
233	Method	tablename	No summary
255	Method	get	Get the objects that caller has.
282	Method	count	Get the number of objects that caller has.
318	Method	set	Set the objects that caller has.
331	Method	clear	Clear the list of all of the objects that this one has.
308	Method	_set	Undocumented

Inherited from Relationship:

Line #	Kind	Name	Docs
21	Method	__init__	Constructor.

Line #	Kind	Name	Docs
21	Method	__init__	Constructor.
331	Method	clear	Clear the list of all of the objects that this one has.
282	Method	count	Get the number of objects that caller has.
255	Method	get	Get the objects that caller has.
318	Method	set	Set the objects that caller has.
233	Method	tablename	No summary
308	Method	_set	Undocumented

def tablename(self):

Get the tablename (specified either in the join_table relationship property or by calculating the tablename). If not specified, the table name is calculated by sorting the table name versions of the two class names and joining them with a '_'). For instance, given the classes Teacher and Student, the resulting table name would be student_teacher.

def get(self, **kwargs):

Get the objects that caller has.

Parameters	kwargs	These could include `limit`, `orderby`, or any others included in `InteractionBase.select`. If a `where` parameter is included, the conditions will be added to the ones already imposed by default in this method.
Returns	A `Deferred` with a callback value of a list of objects.

def count(self, **kwargs):

Get the number of objects that caller has.

Parameters	kwargs	These could include `limit`, `orderby`, or any others included in `InteractionBase.select`. If a `where` parameter is included, the conditions will be added to the ones already imposed by default in this method.
Returns	A `Deferred` with the number of objects.

def _set(self, _, others):

Undocumented

def set(self, others):

Set the objects that caller has.

Returns A Deferred.

def clear(self):

Clear the list of all of the objects that this one has.

API Documentation for twistar, generated by pydoctor at 2012-06-12 10:00:49.