Views

`sith = Sith.objects.first` `module-attribute` ¶

`Club` ¶

Bases: Model

The Club class, made as a tree to allow nice tidy organization.

`check_loop()` ¶

Raise a validation error when a loop is found within the parent list.

Source code in club/models.py

def check_loop(self):
    """Raise a validation error when a loop is found within the parent list."""
    objs = []
    cur = self
    while cur.parent is not None:
        if cur in objs:
            raise ValidationError(_("You can not make loops in clubs"))
        objs.append(cur)
        cur = cur.parent

`is_owned_by(user)` ¶

Method to see if that object can be super edited by the given user.

Source code in club/models.py

def is_owned_by(self, user):
    """Method to see if that object can be super edited by the given user."""
    if user.is_anonymous:
        return False
    return user.is_board_member

`can_be_edited_by(user)` ¶

Method to see if that object can be edited by the given user.

Source code in club/models.py

def can_be_edited_by(self, user):
    """Method to see if that object can be edited by the given user."""
    return self.has_rights_in_club(user)

`can_be_viewed_by(user)` ¶

Method to see if that object can be seen by the given user.

Source code in club/models.py

def can_be_viewed_by(self, user):
    """Method to see if that object can be seen by the given user."""
    sub = User.objects.filter(pk=user.pk).first()
    if sub is None:
        return False
    return sub.was_subscribed

`get_membership_for(user)` ¶

Return the current membership the given user.

Note

The result is cached.

Source code in club/models.py

def get_membership_for(self, user: User) -> Membership | None:
    """Return the current membership the given user.

    Note:
        The result is cached.
    """
    if user.is_anonymous:
        return None
    membership = cache.get(f"membership_{self.id}_{user.id}")
    if membership == "not_member":
        return None
    if membership is None:
        membership = self.members.filter(user=user, end_date=None).first()
        if membership is None:
            cache.set(f"membership_{self.id}_{user.id}", "not_member")
        else:
            cache.set(f"membership_{self.id}_{user.id}", membership)
    return membership

`Mailing` ¶

Bases: Model

A Mailing list for a club.

Warning

Remember that mailing lists should be validated by UTBM.

`News` ¶

Bases: Model

The news class.

`NewsDate` ¶

Bases: Model

A date class, useful for weekly events, or for events that just have no date.

This class allows more flexibilty managing the dates related to a news, particularly when this news is weekly, since we don't have to make copies

`Poster` ¶

Bases: Model

`Screen` ¶

Bases: Model

`Sith` ¶

Bases: Model

A one instance class storing all the modifiable infos.

`Weekmail` ¶

Bases: Model

The weekmail class.

:ivar title: Title of the weekmail :ivar intro: Introduction of the weekmail :ivar joke: Joke of the week :ivar protip: Tip of the week :ivar conclusion: Conclusion of the weekmail :ivar sent: Track if the weekmail has been sent