Skip to content

Commit

Permalink
Adds typing to site model file
Browse files Browse the repository at this point in the history
Did I do this right?
  • Loading branch information
mouse-reeve committed Aug 27, 2024
1 parent 2bd5a11 commit 04ab58e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions bookwyrm/models/site.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class Meta:
abstract = True

# pylint: disable=no-self-use
def raise_not_editable(self, viewer):
def raise_not_editable(self, viewer: User) -> None:
"""Check if the user has the right permissions"""
if viewer.has_perm("bookwyrm.edit_instance_settings"):
return
Expand Down Expand Up @@ -119,26 +119,26 @@ def get(cls):
return default_settings

@property
def logo_url(self):
def logo_url(self) -> str:
"""helper to build the logo url"""
return self.get_url("logo", "images/logo.png")

@property
def logo_small_url(self):
def logo_small_url(self) -> str:
"""helper to build the logo url"""
return self.get_url("logo_small", "images/logo-small.png")

@property
def favicon_url(self):
def favicon_url(self) -> str:
"""helper to build the logo url"""
return self.get_url("favicon", "images/favicon.png")

def raise_federation_disabled(self):
def raise_federation_disabled(self) -> None:
"""Don't connect to the outside world"""
if self.disable_federation:
raise PermissionDenied("Federation is disabled")

def get_url(self, field, default_path):
def get_url(self, field: str, default_path: str) -> str:
"""get a media url or a default static path"""
uploaded = getattr(self, field, None)
if uploaded:
Expand Down Expand Up @@ -185,7 +185,7 @@ class SiteInvite(models.Model):
invitees = models.ManyToManyField(User, related_name="invitees")

# pylint: disable=no-self-use
def raise_not_editable(self, viewer):
def raise_not_editable(self, viewer: User) -> None:
"""Admins only"""
if viewer.has_perm("bookwyrm.create_invites"):
return
Expand Down Expand Up @@ -214,7 +214,7 @@ class InviteRequest(BookWyrmModel):
invite_sent = models.BooleanField(default=False)
ignored = models.BooleanField(default=False)

def raise_not_editable(self, viewer):
def raise_not_editable(self, viewer: User) -> None:
"""Only check perms on edit, not create"""
if not self.id or viewer.has_perm("bookwyrm.create_invites"):
return
Expand All @@ -240,7 +240,7 @@ class PasswordReset(models.Model):
expiry = models.DateTimeField(default=get_password_reset_expiry)
user = models.OneToOneField(User, on_delete=models.CASCADE)

def valid(self):
def valid(self) -> bool:
"""make sure it hasn't expired or been used"""
return self.expiry > timezone.now()

Expand Down

0 comments on commit 04ab58e

Please sign in to comment.