squaresdb.membership.models module

class squaresdb.membership.models.FeeCategory(slug, name)

Bases: Model

Parameters:

• slug (SlugField) – Primary key: Slug

• name (CharField) – Name

Reverse relationships:

Parameters:

• person (Reverse ForeignKey from Person) – All people of this fee category (related name of fee_cat)

• subscriptionperiodprice (Reverse ForeignKey from SubscriptionPeriodPrice) – All subscription period prices of this fee category (related name of fee_cat)

• danceprice (Reverse ForeignKey from DancePrice) – All dance prices of this fee category (related name of fee_cat)

• payment (Reverse ForeignKey from Payment) – All payments of this fee category (related name of fee_cat)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

danceprice_set

Type: Reverse ForeignKey from DancePrice

All dance prices of this fee category (related name of fee_cat)

name

Type: CharField

Name

objects = <django.db.models.Manager object>

payment_set

Type: Reverse ForeignKey from Payment

All payments of this fee category (related name of fee_cat)

person_set

Type: Reverse ForeignKey from Person

All people of this fee category (related name of fee_cat)

slug

Type: SlugField

Primary key: Slug

subscriptionperiodprice_set

Type: Reverse ForeignKey from SubscriptionPeriodPrice

All subscription period prices of this fee category (related name of fee_cat)

class squaresdb.membership.models.MITAffil(slug, name, student)

Bases: Model

Parameters:

• slug (SlugField) – Primary key: Slug

• name (CharField) – Name

• student (BooleanField) – Student

Reverse relationships:

Parameters:

person (Reverse ForeignKey from Person) – All people of this MIT affiliation (related name of mit_affil)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

full_str()

name

Type: CharField

Name

objects = <django.db.models.Manager object>

person_set

Type: Reverse ForeignKey from Person

All people of this MIT affiliation (related name of mit_affil)

slug

Type: SlugField

Primary key: Slug

student

Type: BooleanField

Student

class squaresdb.membership.models.Person(id, name, email, level, status, join_date, mit_affil, grad_year, fee_cat, frequency, last_marked_correct)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) – Name

• email (EmailField) – Email

• join_date (DateTimeField) – Join date

• grad_year (IntegerField) – Year (expected or actual) graduated from MIT

• last_marked_correct (DateTimeField) – Last marked correct

Relationship fields:

Parameters:

• level (ForeignKey to SquareLevel) – Highest level (related name: person)

• status (ForeignKey to PersonStatus) – Membership status (related name: person)

• mit_affil (ForeignKey to MITAffil) – MIT affiliation (related name: person)

• fee_cat (ForeignKey to FeeCategory) – Fee cat (related name: person)

• frequency (ForeignKey to PersonFrequency) – Attendance frequency (related name: person)

Reverse relationships:

Parameters:

• comments (Reverse ForeignKey from PersonComment) – All comments of this person (related name of person)

• auth_links (Reverse ForeignKey from PersonAuthLink) – All auth links of this person (related name of person)

• class_coord (Reverse ForeignKey from TSClass) – All class coord of this person (related name of coordinator)

• class_assist (Reverse ManyToManyField from TSClass) – All class assist of this person (related name of assistants)

• classes (Reverse ManyToManyField from TSClass) – All classes of this person (related name of students)

• tsclassassist (Reverse ForeignKey from TSClassAssist) – All Tech Squares class assistants of this person (related name of assistant)

• tsclassmember (Reverse ForeignKey from TSClassMember) – All Tech Squares class members of this person (related name of student)

• payment (Reverse ForeignKey from Payment) – All payments of this person (related name of person)

• attendee (Reverse ForeignKey from Attendee) – All attendees of this person (related name of person)

• subscriptionlineitem (Reverse ForeignKey from SubscriptionLineItem) – All subscription line items of this person (related name of person)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

attendee_set

Type: Reverse ForeignKey from Attendee

All attendees of this person (related name of person)

auth_links

Type: Reverse ForeignKey from PersonAuthLink

All auth links of this person (related name of person)

class_assist

Type: Reverse ManyToManyField from TSClass

All class assist of this person (related name of assistants)

class_coord

Type: Reverse ForeignKey from TSClass

All class coord of this person (related name of coordinator)

classes

Type: Reverse ManyToManyField from TSClass

All classes of this person (related name of students)

comments

Type: Reverse ForeignKey from PersonComment

All comments of this person (related name of person)

email

Type: EmailField

Email

fee_cat

Type: ForeignKey to FeeCategory

Fee cat (related name: person)

fee_cat_id

Internal field, use fee_cat instead.

frequency

Type: ForeignKey to PersonFrequency

Attendance frequency (related name: person)

frequency_id

Internal field, use frequency instead.

get_absolute_url()

grad_year

Type: IntegerField

Year (expected or actual) graduated from MIT

grad_year_verbose = 'year (expected or actual) graduated from MIT'

id

Type: BigAutoField

Primary key: ID

join_date

Type: DateTimeField

Join date

last_marked_correct

Type: DateTimeField

Last marked correct

level

Type: ForeignKey to SquareLevel

Highest level (related name: person)

level_id

Internal field, use level instead.

mit_affil

Type: ForeignKey to MITAffil

MIT affiliation (related name: person)

mit_affil_id

Internal field, use mit_affil instead.

name

Type: CharField

Name

objects = <django.db.models.Manager object>

payment_set

Type: Reverse ForeignKey from Payment

All payments of this person (related name of person)

status

Type: ForeignKey to PersonStatus

Membership status (related name: person)

status_id

Internal field, use status instead.

subscriptionlineitem_set

Type: Reverse ForeignKey from SubscriptionLineItem

All subscription line items of this person (related name of person)

tsclassassist_set

Type: Reverse ForeignKey from TSClassAssist

All Tech Squares class assistants of this person (related name of assistant)

tsclassmember_set

Type: Reverse ForeignKey from TSClassMember

All Tech Squares class members of this person (related name of student)

class squaresdb.membership.models.PersonAuthLink(id, person, secret, allowed_ip, expire_time, state_hash, create_user, create_ip, create_time, create_reason_basic, create_reason_detail)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• secret (CharField) – Secret

• allowed_ip (GenericIPAddressField) – Allowed ip

• expire_time (DateTimeField) – Expire time

• state_hash (CharField) – State hash

• create_ip (GenericIPAddressField) – Create ip

• create_time (DateTimeField) – Create time

• create_reason_basic (CharField) – Create reason basic

• create_reason_detail (CharField) – Create reason detail

Relationship fields:

Parameters:

• person (ForeignKey to Person) – Person (related name: auth_links)

• create_user (ForeignKey to User) – Create user (related name: auth_links_created)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

allowed_ip

Type: GenericIPAddressField

Allowed ip

classmethod create_auth_link(person, reason, detail, creator)

create_ip

Type: GenericIPAddressField

Create ip

create_reason_basic

Type: CharField

Create reason basic

create_reason_detail

Type: CharField

Create reason detail

create_state_hash()

create_time

Type: DateTimeField

Create time

create_user

Type: ForeignKey to User

Create user (related name: auth_links_created)

create_user_id

Internal field, use create_user instead.

expire_time

Type: DateTimeField

Expire time

classmethod get_link(secret, request_ip)

Get a PersonAuthLink and confirm its validity

Returns a tuple, with elements: (1) Validity: True (valid) or False (invalid) (2) Object: PersonAuthLink object if the secret was found and None otherwise

If validity is False but object is non-None, one should next typically call send_new_auth_link to generate a replacement.

get_next_by_create_time(*, field=<django.db.models.DateTimeField: create_time>, is_next=True, **kwargs)

Finds next instance based on create_time. See get_next_by_FOO() for more information.

get_next_by_expire_time(*, field=<django.db.models.DateTimeField: expire_time>, is_next=True, **kwargs)

Finds next instance based on expire_time. See get_next_by_FOO() for more information.

get_previous_by_create_time(*, field=<django.db.models.DateTimeField: create_time>, is_next=False, **kwargs)

Finds previous instance based on create_time. See get_previous_by_FOO() for more information.

get_previous_by_expire_time(*, field=<django.db.models.DateTimeField: expire_time>, is_next=False, **kwargs)

Finds previous instance based on expire_time. See get_previous_by_FOO() for more information.

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

person

Type: ForeignKey to Person

Person (related name: auth_links)

person_id

Internal field, use person instead.

secret

Type: CharField

Secret

state_hash

Type: CharField

State hash

verify_state_hash()

class squaresdb.membership.models.PersonComment(id, author, timestamp, body, person)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• timestamp (DateTimeField) – Timestamp

• body (TextField) – Body

Relationship fields:

Parameters:

• author (ForeignKey to User) – Author (related name: comments_written)

• person (ForeignKey to Person) – Person (related name: comments)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

author

Type: ForeignKey to User

Author (related name: comments_written)

author_id

Internal field, use author instead.

body

Type: TextField

Body

get_next_by_timestamp(*, field=<django.db.models.DateTimeField: timestamp>, is_next=True, **kwargs)

Finds next instance based on timestamp. See get_next_by_FOO() for more information.

get_previous_by_timestamp(*, field=<django.db.models.DateTimeField: timestamp>, is_next=False, **kwargs)

Finds previous instance based on timestamp. See get_previous_by_FOO() for more information.

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

person

Type: ForeignKey to Person

Person (related name: comments)

person_id

Internal field, use person instead.

timestamp

Type: DateTimeField

Timestamp

class squaresdb.membership.models.PersonFrequency(slug, name, order)

Bases: Model

Parameters:

• slug (SlugField) – Primary key: Slug

• name (CharField) – Name

• order (IntegerField) – Order

Reverse relationships:

Parameters:

person (Reverse ForeignKey from Person) – All people of this person frequency (related name of frequency)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

name

Type: CharField

Name

objects = <django.db.models.Manager object>

order

Type: IntegerField

Order

person_set

Type: Reverse ForeignKey from Person

All people of this person frequency (related name of frequency)

slug

Type: SlugField

Primary key: Slug

class squaresdb.membership.models.PersonStatus(slug, name, member)

Bases: Model

Parameters:

• slug (SlugField) – Primary key: Slug

• name (CharField) – Name

• member (BooleanField) – Member

Reverse relationships:

Parameters:

person (Reverse ForeignKey from Person) – All people of this person status (related name of status)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

full_str()

member

Type: BooleanField

Member

name

Type: CharField

Name

objects = <django.db.models.Manager object>

person_set

Type: Reverse ForeignKey from Person

All people of this person status (related name of status)

slug

Type: SlugField

Primary key: Slug

class squaresdb.membership.models.SquareLevel(slug, name, order)

Bases: Model

Parameters:

• slug (SlugField) – Primary key: Slug

• name (CharField) – Name

• order (IntegerField) – Order

Reverse relationships:

Parameters:

person (Reverse ForeignKey from Person) – All people of this square level (related name of level)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

name

Type: CharField

Name

objects = <django.db.models.Manager object>

order

Type: IntegerField

Order

person_set

Type: Reverse ForeignKey from Person

All people of this square level (related name of level)

slug

Type: SlugField

Primary key: Slug

class squaresdb.membership.models.TSClass(id, label, coordinator, start_date, end_date)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• label (CharField) – Label

• start_date (DateField) – Start date

• end_date (DateField) – End date

Relationship fields:

Parameters:

• coordinator (ForeignKey to Person) – Coordinator (related name: class_coord)

• assistants (ManyToManyField to Person) – Assistants (related name: class_assist)

• students (ManyToManyField to Person) – Students (related name: classes)

Reverse relationships:

Parameters:

• tsclassassist (Reverse ForeignKey from TSClassAssist) – All Tech Squares class assistants of this Tech Squares class (related name of clas)

• tsclassmember (Reverse ForeignKey from TSClassMember) – All Tech Squares class members of this Tech Squares class (related name of clas)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

assistants

Type: ManyToManyField to Person

Assistants (related name: class_assist)

coordinator

Type: ForeignKey to Person

Coordinator (related name: class_coord)

coordinator_id

Internal field, use coordinator instead.

end_date

Type: DateField

End date

get_absolute_url()

id

Type: BigAutoField

Primary key: ID

label

Type: CharField

Label

objects = <django.db.models.Manager object>

start_date

Type: DateField

Start date

students

Type: ManyToManyField to Person

Students (related name: classes)

tsclassassist_set

Type: Reverse ForeignKey from TSClassAssist

All Tech Squares class assistants of this Tech Squares class (related name of clas)

tsclassmember_set

Type: Reverse ForeignKey from TSClassMember

All Tech Squares class members of this Tech Squares class (related name of clas)

class squaresdb.membership.models.TSClassAssist(id, assistant, clas, role)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• role (CharField) – Role

Relationship fields:

Parameters:

• assistant (ForeignKey to Person) – Assistant (related name: tsclassassist)

• clas (ForeignKey to TSClass) – Class (related name: tsclassassist)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

assistant

Type: ForeignKey to Person

Assistant (related name: tsclassassist)

assistant_id

Internal field, use assistant instead.

clas

Type: ForeignKey to TSClass

Class (related name: tsclassassist)

clas_id

Internal field, use clas instead.

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

role

Type: CharField

Role

class squaresdb.membership.models.TSClassMember(id, student, clas, pe)

Bases: Model

Parameters:

• id (BigAutoField) – Primary key: ID

• pe (BooleanField) – Taking class as PE student?

Relationship fields:

Parameters:

• student (ForeignKey to Person) – Student (related name: tsclassmember)

• clas (ForeignKey to TSClass) – Class (related name: tsclassmember)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

exception NotUpdated

Bases: ObjectNotUpdated, DatabaseError

clas

Type: ForeignKey to TSClass

Class (related name: tsclassmember)

clas_id

Internal field, use clas instead.

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

pe

Type: BooleanField

Taking class as PE student?

student

Type: ForeignKey to Person

Student (related name: tsclassmember)

student_id

Internal field, use student instead.

squaresdb.membership.models.personauthlink_default_expire_time()

squaresdb.membership.models.personauthlink_default_secret()