Views

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

`Club` ¶

Bases: Model

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

`president()` ¶

Fetch the membership of the current president of this club.

Source code in club/models.py

@cached_property
def president(self) -> Membership | None:
    """Fetch the membership of the current president of this club."""
    return self.members.filter(
        role=settings.SITH_CLUB_ROLES_ID["President"], end_date=None
    ).first()

`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: User) -> bool:
    """Method to see if that object can be super edited by the given user."""
    if user.is_anonymous:
        return False
    return user.is_root or 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: User) -> bool:
    """Method to see if that object can be edited by the given user."""
    return self.has_rights_in_club(user)

`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.

`NewsDateForm(*args, **kwargs)` ¶

Bases: ModelForm

Form to select the dates of an event.

Source code in com/forms.py

def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    self.label_suffix = ""

`get_occurrences(number)` `classmethod` ¶

Find the occurrence choice corresponding to numeric number of occurrences.

Source code in com/forms.py

@classmethod
def get_occurrences(cls, number: int) -> tuple[str, str] | None:
    """Find the occurrence choice corresponding to numeric number of occurrences."""
    if number < 2:
        # If only 0 or 1 date, there cannot be weekly events
        return None
    # occurrences have all a numeric value, except "SEMESTER_END"
    str_num = str(number)
    occurrences = next((c for c in cls.occurrence_choices if c[0] == str_num), None)
    if occurrences:
        return occurrences
    return next((c for c in cls.occurrence_choices if c[0] == "SEMESTER_END"), None)

`NewsForm(*args, author, date_form, **kwargs)` ¶

Bases: ModelForm

Form to create or edit news.

Source code in com/forms.py

def __init__(self, *args, author: User, date_form: NewsDateForm, **kwargs):
    super().__init__(*args, **kwargs)
    self.author = author
    self.date_form = date_form
    self.label_suffix = ""
    # if the author is an admin, he/she can choose any club,
    # otherwise, only clubs for which he/she is a board member can be selected
    if author.is_root or author.is_com_admin:
        self.fields["club"].widget = AutoCompleteSelectClub()
    else:
        self.fields["club"].queryset = Club.objects.having_board_member(author)

`PosterForm(*args, user, **kwargs)` ¶

Bases: ModelForm

Source code in com/forms.py

def __init__(self, *args, user: User, **kwargs):
    super().__init__(*args, **kwargs)
    if user.is_root or user.is_com_admin:
        self.fields["club"].widget = AutoCompleteSelectClub()
    else:
        self.fields["club"].queryset = Club.objects.having_board_member(user)

`IcsCalendar` ¶

`News` ¶

Bases: Model

News about club events.

`NewsDate` ¶

Bases: Model

A date associated with news.

A News can have multiple dates, for example if it is a recurring event.

`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