Fix backend lint errors (#836)

* Fix backend lint errors

* Post-review update

Author: rwood-moz

backend/pyproject.toml

@@ -34,7 +34,6 @@ dependencies = { file = ["requirements.txt"] }
 # Ruff
 [tool.ruff]
 line-length = 120
-
 # Exclude a variety of commonly ignored directories.
 exclude = [
     ".bzr",
@@ -57,6 +56,7 @@ exclude = [
     "dist",
     "node_modules",
     "venv",
+    "src/appointment/migrations"
 ]
 
 # Always generate Python 3.12-compatible code.

backend/src/appointment/controller/apis/fxa_client.py

@@ -6,7 +6,7 @@
 from requests_oauthlib import OAuth2Session
 import requests
 from ...database import models, repo
-from ...exceptions.fxa_api import NotInAllowListException, MissingRefreshTokenException
+from ...exceptions.fxa_api import MissingRefreshTokenException
 
 
 class FxaConfig:

backend/src/appointment/controller/apis/google_client.py

@@ -113,7 +113,11 @@ def get_free_busy(self, calendar_ids, time_min, time_max, token):
         perf_start = time.perf_counter_ns()
         with build('calendar', 'v3', credentials=token, cache_discovery=False) as service:
             request = service.freebusy().query(
-                body=dict(timeMin=time_min, timeMax=time_max, items=[{'id': calendar_id} for calendar_id in calendar_ids])
+                body=dict(
+                    timeMin=time_min,
+                    timeMax=time_max,
+                    items=[{'id': calendar_id} for calendar_id in calendar_ids]
+                )
             )
 
             while request is not None:

backend/src/appointment/controller/auth.py

@@ -73,4 +73,7 @@ def schedule_links_by_subscriber(db, subscriber: models.Subscriber):
     url_safe_username = urllib.parse.quote_plus(subscriber.username)
 
     # Empty space at join is for trailing slash!
-    return list(map(lambda sch: '/'.join([short_url, url_safe_username, urllib.parse.quote_plus(sch.slug), '']), schedules))
+    return list(map(
+        lambda sch: '/'.join([short_url, url_safe_username, urllib.parse.quote_plus(sch.slug), '']),
+        schedules)
+    )

backend/src/appointment/controller/calendar.py

@@ -8,7 +8,6 @@
 import time
 import zoneinfo
 import os
-from socket import getaddrinfo
 from urllib.parse import urlparse, urljoin
 
 import caldav.lib.error
@@ -27,8 +26,7 @@
 from sqlalchemy.orm import Session
 
 from .. import utils
-from ..database.schemas import CalendarConnection
-from ..defines import REDIS_REMOTE_EVENTS_KEY, DATEFMT, DEFAULT_CALENDAR_COLOUR, DATETIMEFMT
+from ..defines import REDIS_REMOTE_EVENTS_KEY, DATEFMT, DEFAULT_CALENDAR_COLOUR
 from .apis.google_client import GoogleClient
 from ..database.models import CalendarProvider, BookingStatus
 from ..database import schemas, models, repo
@@ -82,7 +80,12 @@ def get_cached_events(self, key_scope):
 
         return [schemas.Event.model_load_redis(blob) for blob in json.loads(encrypted_events)]
 
-    def put_cached_events(self, key_scope, events: list[schemas.Event], expiry=os.getenv('REDIS_EVENT_EXPIRE_SECONDS', 900)):
+    def put_cached_events(
+        self,
+        key_scope,
+        events: list[schemas.Event],
+        expiry=os.getenv('REDIS_EVENT_EXPIRE_SECONDS', 900)
+    ):
         """Sets the passed cached events with an option to set a custom expiry time."""
         if self.redis_instance is None:
             return False
@@ -291,7 +294,11 @@ def save_event(
             },
         }
 
-        new_event = self.google_client.save_event(calendar_id=self.remote_calendar_id, body=body, token=self.google_token)
+        new_event = self.google_client.save_event(
+            calendar_id=self.remote_calendar_id,
+            body=body,
+            token=self.google_token
+        )
 
         # Fill in the external_id so we can delete events later!
         event.external_id = new_event.get('id')
@@ -314,7 +321,16 @@ def delete_events(self, start):
 
 
 class CalDavConnector(BaseConnector):
-    def __init__(self, db: Session, subscriber_id: int, calendar_id: int, redis_instance, url: str, user: str, password: str):
+    def __init__(
+        self,
+        db: Session,
+        subscriber_id: int,
+        calendar_id: int,
+        redis_instance,
+        url: str,
+        user: str,
+        password: str
+    ):
         super().__init__(subscriber_id, calendar_id, redis_instance)
 
         self.db = db
@@ -343,8 +359,8 @@ def get_busy_time(self, calendar_ids: list, start: str, end: str):
 
         items = []
 
-        # This is sort of dumb, freebusy object isn't exposed in the icalendar instance except through a list of tuple props
-        # Luckily the value is a vPeriod which is a tuple of date times/timedelta (0 = Start, 1 = End)
+        # This is sort of dumb, freebusy object isn't exposed in the icalendar instance except through a list of tuple
+        # props; luckily the value is a vPeriod which is a tuple of date times/timedelta (0 = Start, 1 = End)
         for prop in response.icalendar_instance.property_items():
             if prop[0].lower() != 'freebusy':
                 continue
@@ -904,7 +920,11 @@ def existing_events_for_schedule(
                     start=busy.get('start'),
                     end=busy.get('end'),
                     title='Busy'
-                ) for busy in con.get_busy_time([calendar.user for calendar in google_calendars], start.strftime(DATEFMT), end.strftime(DATEFMT))
+                ) for busy in con.get_busy_time(
+                    [calendar.user for calendar in google_calendars],
+                    start.strftime(DATEFMT),
+                    end.strftime(DATEFMT)
+                )
             ])
 
         # handle already requested time slots

backend/src/appointment/controller/mailer.py

@@ -352,7 +352,15 @@ def __init__(self, name, email, date, duration, schedule_name, *args, **kwargs):
         self.schedule_name = schedule_name
         lang = kwargs['lang'] if 'lang' in kwargs else None
         default_kwargs = {'subject': l10n('new-booking-subject', {'name': name}, lang)}
-        super(NewBookingMail, self).__init__(name=name, email=email, date=date, duration=duration, *args, **default_kwargs, **kwargs)
+        super(NewBookingMail, self).__init__(
+            name=name,
+            email=email,
+            date=date,
+            duration=duration,
+            *args,
+            **default_kwargs,
+            **kwargs
+        )
         self.reply_to = email
 
     def text(self):
@@ -391,7 +399,12 @@ def __init__(self, requestee_name, requestee_email, topic, details, *args, **kwa
         self.topic = topic
         self.details = details
         default_kwargs = {'subject': l10n('support-mail-subject', {'topic': topic})}
-        super(SupportRequestMail, self).__init__(os.getenv('SUPPORT_EMAIL', 'help@tb.net'), *args, **default_kwargs, **kwargs)
+        super(SupportRequestMail, self).__init__(
+            os.getenv('SUPPORT_EMAIL', 'help@tb.net'),
+            *args,
+            **default_kwargs,
+            **kwargs
+        )
         self.reply_to = requestee_email
 
     def text(self):

backend/src/appointment/database/models.py

@@ -164,8 +164,20 @@ class Subscriber(HasSoftDelete, Base):
     external_connections = relationship('ExternalConnections', cascade='all,delete', back_populates='owner')
 
     # FIXME: Invite will be deleted if either the owner or the invited subscriber is deleted.
-    invite: Mapped['Invite'] = relationship('Invite', cascade='all,delete', back_populates='subscriber', uselist=False, foreign_keys='Invite.subscriber_id')
-    owned_invites: Mapped[list['Invite']] = relationship('Invite', cascade='all,delete', back_populates='owner', foreign_keys='[Invite.owner_id]')
+    invite: Mapped['Invite'] = relationship(
+        'Invite',
+        cascade='all,delete',
+        back_populates='subscriber',
+        uselist=False,
+        foreign_keys='Invite.subscriber_id'
+    )
+
+    owned_invites: Mapped[list['Invite']] = relationship(
+        'Invite',
+        cascade='all,delete',
+        back_populates='owner',
+        foreign_keys='[Invite.owner_id]'
+    )
 
     def get_external_connection(self, type: ExternalConnectionType) -> 'ExternalConnections':
         """Retrieves the first found external connection by type or returns None if not found"""
@@ -242,7 +254,12 @@ class Appointment(Base):
     )
 
     calendar: Mapped[Calendar] = relationship('Calendar', back_populates='appointments')
-    slots: Mapped[list['Slot']] = relationship('Slot', cascade='all,delete', back_populates='appointment', lazy='joined')
+    slots: Mapped[list['Slot']] = relationship(
+        'Slot',
+        cascade='all,delete',
+        back_populates='appointment',
+        lazy='joined'
+    )
 
 
 class Attendee(Base):
@@ -305,7 +322,7 @@ class Schedule(Base):
     weekdays: str | dict = Column(JSON, default='[1,2,3,4,5]')  # list of ISO weekdays, Mo-Su => 1-7
     slot_duration: int = Column(Integer, default=30)  # defaults to 30 minutes
     booking_confirmation: bool = Column(Boolean, index=True, nullable=False, default=True)
-    timezone: str = Column(encrypted_type(String), index=True, nullable=True)  # Not used right now but will be in the future
+    timezone: str = Column(encrypted_type(String), index=True, nullable=True)  # Not used now but will be in the future
 
     # What (if any) meeting link will we generate once the meeting is booked
     meeting_link_provider: MeetingLinkProviderType = Column(
@@ -385,9 +402,26 @@ class Invite(Base):
     code = Column(encrypted_type(String), index=False)
     status = Column(Enum(InviteStatus), index=True)
 
-    owner: Mapped['Subscriber'] = relationship('Subscriber', back_populates='invite', single_parent=True, foreign_keys=[owner_id])
-    subscriber: Mapped['Subscriber'] = relationship('Subscriber', back_populates='invite', single_parent=True, foreign_keys=[subscriber_id])
-    waiting_list: Mapped['WaitingList'] = relationship('WaitingList', cascade='all,delete', back_populates='invite', uselist=False)
+    owner: Mapped['Subscriber'] = relationship(
+        'Subscriber',
+        back_populates='invite',
+        single_parent=True,
+        foreign_keys=[owner_id]
+    )
+
+    subscriber: Mapped['Subscriber'] = relationship(
+        'Subscriber',
+        back_populates='invite',
+        single_parent=True,
+        foreign_keys=[subscriber_id]
+    )
+
+    waiting_list: Mapped['WaitingList'] = relationship(
+        'WaitingList',
+        cascade='all,delete',
+        back_populates='invite',
+        uselist=False
+    )
 
     @property
     def is_used(self) -> bool:

backend/src/appointment/database/repo/calendar.py

@@ -66,7 +66,11 @@ def create(db: Session, calendar: schemas.CalendarConnection, subscriber_id: int
     return db_calendar
 
 
-def update_by_calendar(db: Session, calendar: schemas.CalendarConnection, db_calendar: models.Calendar) -> models.Calendar|None:
+def update_by_calendar(
+    db: Session,
+    calendar: schemas.CalendarConnection,
+    db_calendar: models.Calendar
+) -> models.Calendar|None:
     """Update a calendar from the database with calendar data."""
 
     # list of all attributes that must never be updated
@@ -142,7 +146,12 @@ def delete_by_subscriber(db: Session, subscriber_id: int):
     return True
 
 
-def delete_by_subscriber_and_provider(db: Session, subscriber_id: int, provider: models.CalendarProvider, user: Optional[str] = None):
+def delete_by_subscriber_and_provider(
+    db: Session,
+    subscriber_id: int,
+    provider: models.CalendarProvider,
+    user: Optional[str] = None
+):
     """Delete all subscriber's calendar by a provider"""
     calendars = get_by_subscriber(db, subscriber_id=subscriber_id)
     for calendar in calendars:

backend/src/appointment/database/repo/invite.py

@@ -15,7 +15,12 @@ def get_by_subscriber(db: Session, subscriber_id: int) -> models.Invite:
     return db.query(models.Invite).filter(models.Invite.subscriber_id == subscriber_id).first()
 
 
-def get_by_owner(db: Session, subscriber_id: int, status: Optional[InviteStatus] = None, only_unused: bool = False) -> list[models.Invite]:
+def get_by_owner(
+    db: Session,
+    subscriber_id: int,
+    status: Optional[InviteStatus] = None,
+    only_unused: bool = False
+) -> list[models.Invite]:
     """Retrieve invites by the invite owner. Optionally filter by status, or unused."""
     query = db.query(models.Invite)
     filters = [models.Invite.owner_id == subscriber_id]

backend/src/appointment/database/repo/subscriber.py

@@ -3,10 +3,8 @@
 Repository providing CRUD functions for subscriber database models. 
 """
 
-import re
 import datetime
 import secrets
-import urllib.parse
 
 from sqlalchemy.orm import Session
 from .. import models, schemas