From 04ab58e7849abceded2fd1298160b751e0802708 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Tue, 27 Aug 2024 15:01:12 -0700 Subject: [PATCH] Adds typing to site model file Did I do this right? --- bookwyrm/models/site.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/bookwyrm/models/site.py b/bookwyrm/models/site.py index 9abd36517..3d197940a 100644 --- a/bookwyrm/models/site.py +++ b/bookwyrm/models/site.py @@ -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 @@ -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: @@ -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 @@ -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 @@ -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()