loefsys.users.models package

Module containing the models related to contacts and users.

class loefsys.users.models.Address(*args, **kwargs)

Bases: Model Extensions

Model that defines an address.

created

The timestamp of the creation of the model, automatically generated upon creation.

Type:: datetime

modified

The timestamp of last modification of this model, automatically generated upon update.

Type:: datetime

street

The street and house number.

Type:: str

street2

Additional information of the street if necessary.

Type:: str

postal_code

The postal code of the address.

Type:: str

city

The city that the address is located in.

Type:: str

country

The country that the city and address are located in.

Type:: str

street: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

street2: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

postal_code: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

country: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=True, **kwargs)

get_previous_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

memberdetails

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

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

class loefsys.users.models.MemberDetails(*args, **kwargs)

Bases: Model Extensions

Model that defines the properties for a member of Loefbijter.

This model contains the required details for a person to be a member of Loefbijter. Thus, it will only exist on a Person object when the person is a member.

user

The user that the membership details are for.

Type:: User

gender

The gender of the person.

Type:: Genders

birthday

The birthday of the member.

Type:: date

show_birthday

Flag to determine the person’s preference to publicly show their birthday.

If set to True, other people will be able to see this person’s birthday in loefsys.

Type:: bool

address

The address of the member.

Type:: Address or None

study_registration

The study registration for this member.

If this value is None, then this member does not study.

Type:: StudyRegistration or None

membership_set

Type:: QuerySet of Membership

user

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

gender: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

birthday: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

show_birthday: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

address

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

study_registration: StudyRegistration | None

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

membership_set: QuerySet

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

address_id

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_gender_display(*, field=<django.db.models.fields.PositiveSmallIntegerField: gender>)

get_next_by_birthday(*, field=<django.db.models.fields.DateField: birthday>, is_next=True, **kwargs)

get_next_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=True, **kwargs)

get_previous_by_birthday(*, field=<django.db.models.fields.DateField: birthday>, is_next=False, **kwargs)

get_previous_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=False, **kwargs)

modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

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

user_id

class loefsys.users.models.Membership(*args, **kwargs)

Bases: Model

Model defining a person’s membership of Loefbijter.

Over the course of a member’s presence at Loefbijter, their membership status may change. For example, an active member may become a passive member, or an exceptional member becomes alumnus. This model exists to keep a record of those statuses and status changes.

This also means that a person’s membership period with one status may not overlap with a period of another membership status. When a person’s membership status changes, the record of that status ends on day X and the record of the next status starts on the next day, day X+1. Validation logic is in place to ensure this integrity.

member

The person that this membership belongs to.

Type:: LoefbijterMember

membership_type

The type of membership.

Type:: MembershipTypes

start

The start date of the person’s membership.

Type:: date

end

The end date of the person’s membership, if it exists.

Type:: date or None

member

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

membership_type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

start: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

end: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

clean(): Run validation on the model.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

get_membership_type_display(*, field=<django.db.models.fields.PositiveSmallIntegerField: membership_type>)

get_next_by_start(*, field=<django.db.models.fields.DateField: start>, is_next=True, **kwargs)

get_previous_by_start(*, field=<django.db.models.fields.DateField: start>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

member_id

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

class loefsys.users.models.StudyRegistration(*args, **kwargs)

Bases: Model Extensions

Model for members who are registered for a study.

created

The timestamp of creation of this model.

Type:: datetime

modified

The timestamp of last modification of this model.

Type:: datetime

member

The member whom the study details belong to.

Type:: LoefbijterMember

institution

The name of the institution where the person is registered.

Type:: str

programme

The programme that the person follows at the institution.

Type:: str

student_number

The student number of the person.

Type:: str

rsc_number

The RSC number of the person or empty if they don’t have one.

Type:: str

member

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

institution: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

programme: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

student_number: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

rsc_number: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=True, **kwargs)

get_previous_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

member_id

modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

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

class loefsys.users.models.User(*args, **kwargs)

Bases: AbstractBaseUser, PermissionsMixin, NameMixin, Model Extensions

The user model for authentication on the Loefbijter website.

A user account can be made for two use cases. First, when a member registers at Loefbijter, an account is made for them as it is necessary for them to interact with loefsys for their membership. Additionally, it is also possible that a user account is made for guests who need access to the site. This user model is used for both cases and the only difference in model values is that a member has a

created

The timestamp of the creation of this model.

Type:: datetime

modified

The timestamp of last modification of this model.

Type:: datetime

email

The email of the user, required to log in.

Type:: str

password

The password for this user.

Type:: str

last_login

the timestamp of the last login for this user.

Type:: datetime

is_superuser

Designated that this user has all permissions without explicit assignation.

Type:: bool

groups

The groups that this user belongs to.

Type:: QuerySet of LoefbijterGroup

user_permissions

The specific permissions for this user.

Type:: QuerySet of Permission

phone_number

The phone number of the user.

For members, a phone number is required, and it is recommended for guest accounts too. However, it is possible that no phone number is available for ex-members, so the field should take into account empty values too.

Type:: str

picture

Type:: ImageFieldFile

note

A note field that are only visible to active board members.

For guest accounts, a note can provide information for which purpose this account exists. For members, incidents can potentially be tracked.

Type:: str

user_upload_directory(): Return the user upload directory.

user_picture_upload_path(_): Return the upload path for the user profile picture.

delete_profile_picture(): Delete the image file associated with the profile picture.

email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_staff: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

groups

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

phone_number

The descriptor for the phone number attribute on the model instance. Returns a PhoneNumber when accessed so you can do stuff like:

>>> instance.phone_number.as_international

Assigns a phone number object on assignment so you can do:

>>> instance.phone_number = PhoneNumber(...)

or,

>>> instance.phone_number = '+414204242'

picture: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

note: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

EMAIL_FIELD = 'email'

USERNAME_FIELD = 'email'

objects = <loefsys.users.models.user.UserManager object>

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

authorized_skippers

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

display_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

display_name_preference: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

eventregistration_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

feedtoken

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

first_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_display_name_preference_display(*, field=<django.db.models.fields.PositiveSmallIntegerField: display_name_preference>)

get_next_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=True, **kwargs)

get_previous_by_created(*, field=<django_extensions.db.fields.CreationDateTimeField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<django_extensions.db.fields.ModificationDateTimeField: modified>, is_next=False, **kwargs)

groupmembership_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

initials: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_superuser: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_login: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

member

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

nickname: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

organizer

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

password: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

reservee_user_reservation_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

skippers

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

user_permissions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

userlog_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

userskippership_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

loefsys.users.models package

Submodules