steffo/sophon
steffo/sophon
1
Fork 0
mirror of https://github.com/Steffo99/sophon.git synced 2024-12-23 07:14:21 +00:00
Code Activity

📔 Document Project function

Browse source
This commit is contained in:
Steffo 2021-04-15 17:18:36 +02:00 committed by Stefano Pigozzi
parent 95f4981dec
commit 7e9ae57cb4
1 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
sophon/core/models.py
View file

@ -357,9 +357,20 @@ class Project(models.Model):
) )
def get_contributors(self): def get_contributors(self):
"""
:return: All the contributors (:attr:`.owner` + :attr:`.collaborators`) of the project.
"""
return {self.owner, *self.collaborators.values()} return {self.owner, *self.collaborators.values()}
def can_be_viewed_by(self, user): def can_be_viewed_by(self, user) -> bool:
"""
Check whether an user should be allowed to **view** the project details.
:param user: The user to check permissions for.
:return: :data:`True` if the user can view the details, or :data:`False` if they cannot.
"""
if self.visibility == "PUBLIC": if self.visibility == "PUBLIC":
return True return True
elif self.visibility == "INTERNAL": elif self.visibility == "INTERNAL":
@ -369,10 +380,24 @@ class Project(models.Model):
else: else:
raise ValueError(f"Unknown visibility value: {self.visibility}") raise ValueError(f"Unknown visibility value: {self.visibility}")
def can_be_edited_by(self, user): def can_be_edited_by(self, user) -> bool:
"""
Check whether an user should be allowed to **edit** the project details.
:param user: The user to check permissions for.
:return: :data:`True` if the user can edit the details, or :data:`False` if they cannot.
"""
return user in self.get_contributors() return user in self.get_contributors()
def can_be_administrated_by(self, user): def can_be_administrated_by(self, user) -> bool:
"""
Check whether an user should be allowed to **administrate** the project.
:param user: The user to check permissions for.
:return: :data:`True` if the user can administrate the project, or :data:`False` if they cannot.
"""
return user == self.owner return user == self.owner
def __str__(self): def __str__(self):