kae/musicmuster
1
0
Fork 0
Code Issues 28 Pull Requests Projects Releases 1 Activity

Python typing fixups

Browse Source
This commit is contained in:
Keith Edmunds 2023-01-20 21:59:40 +00:00
parent c04114b07a
commit f8dcc69a55
3 changed files with 37 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/config.py
View File

@ -65,7 +65,6 @@ class Config(object):
MAX_MISSING_FILES_TO_REPORT = 10 MAX_MISSING_FILES_TO_REPORT = 10
MILLISECOND_SIGFIGS = 0 MILLISECOND_SIGFIGS = 0
MYSQL_CONNECT = os.environ.get('MYSQL_CONNECT') or "mysql+mysqldb://musicmuster:musicmuster@localhost/musicmuster_v2" # noqa E501 MYSQL_CONNECT = os.environ.get('MYSQL_CONNECT') or "mysql+mysqldb://musicmuster:musicmuster@localhost/musicmuster_v2" # noqa E501
NORMALISE_ON_IMPORT = True
NOTE_TIME_FORMAT = "%H:%M:%S" NOTE_TIME_FORMAT = "%H:%M:%S"
ROOT = os.environ.get('ROOT') or "/home/kae/music" ROOT = os.environ.get('ROOT') or "/home/kae/music"
IMPORT_DESTINATION = os.path.join(ROOT, "Singles") IMPORT_DESTINATION = os.path.join(ROOT, "Singles")

69
app/models.py
View File

@ -4,7 +4,7 @@ import os.path
import re import re
import stackprinter # type: ignore import stackprinter # type: ignore
from dbconfig import Session from dbconfig import Session, scoped_session
from datetime import datetime from datetime import datetime
from typing import List, Optional from typing import List, Optional
@ -61,7 +61,8 @@ class Carts(Base):
f"name={self.name}, path={self.path}>" f"name={self.name}, path={self.path}>"
) )
def __init__(self, session: Session, cart_number: int, name: str = None, def __init__(self, session: scoped_session, cart_number: int,
name: Optional[str] = None,
duration: int = None, path: str = None, duration: int = None, path: str = None,
enabled: bool = True) -> None: enabled: bool = True) -> None:
"""Create new cart""" """Create new cart"""
@ -94,7 +95,7 @@ class NoteColours(Base):
) )
@staticmethod @staticmethod
def get_colour(session: Session, text: str) -> Optional[str]: def get_colour(session: scoped_session, text: str) -> Optional[str]:
""" """
Parse text and return colour string if matched, else None Parse text and return colour string if matched, else None
""" """
@ -139,7 +140,7 @@ class Playdates(Base):
f"lastplayed={self.lastplayed}>" f"lastplayed={self.lastplayed}>"
) )
def __init__(self, session: Session, track_id: int) -> None: def __init__(self, session: scoped_session, track_id: int) -> None:
"""Record that track was played""" """Record that track was played"""
self.lastplayed = datetime.now() self.lastplayed = datetime.now()
@ -148,7 +149,7 @@ class Playdates(Base):
session.commit() session.commit()
@staticmethod @staticmethod
def last_played(session: Session, track_id: int) -> Optional[datetime]: def last_played(session: scoped_session, track_id: int) -> Optional[datetime]:
"""Return datetime track last played or None""" """Return datetime track last played or None"""
last_played = session.execute( last_played = session.execute(
@ -164,7 +165,7 @@ class Playdates(Base):
return None return None
@staticmethod @staticmethod
def played_after(session: Session, since: datetime) -> List["Playdates"]: def played_after(session: scoped_session, since: datetime) -> List["Playdates"]:
"""Return a list of Playdates objects since passed time""" """Return a list of Playdates objects since passed time"""
return ( return (
@ -206,12 +207,12 @@ class Playlists(Base):
f"is_templatee={self.is_template}>" f"is_templatee={self.is_template}>"
) )
def __init__(self, session: Session, name: str) -> None: def __init__(self, session: scoped_session, name: str) -> None:
self.name = name self.name = name
session.add(self) session.add(self)
session.commit() session.commit()
def close(self, session: Session) -> None: def close(self, session: scoped_session) -> None:
"""Mark playlist as unloaded""" """Mark playlist as unloaded"""
closed_idx = self.tab closed_idx = self.tab
@ -227,7 +228,7 @@ class Playlists(Base):
@classmethod @classmethod
def create_playlist_from_template(cls, def create_playlist_from_template(cls,
session: Session, session: scoped_session,
template: "Playlists", template: "Playlists",
playlist_name: str) \ playlist_name: str) \
-> "Playlists": -> "Playlists":
@ -239,7 +240,7 @@ class Playlists(Base):
return playlist return playlist
@classmethod @classmethod
def get_all(cls, session: Session) -> List["Playlists"]: def get_all(cls, session: scoped_session) -> List["Playlists"]:
"""Returns a list of all playlists ordered by last use""" """Returns a list of all playlists ordered by last use"""
return ( return (
@ -253,7 +254,7 @@ class Playlists(Base):
) )
@classmethod @classmethod
def get_all_templates(cls, session: Session) -> List["Playlists"]: def get_all_templates(cls, session: scoped_session) -> List["Playlists"]:
"""Returns a list of all templates ordered by name""" """Returns a list of all templates ordered by name"""
return ( return (
@ -267,7 +268,7 @@ class Playlists(Base):
) )
@classmethod @classmethod
def get_closed(cls, session: Session) -> List["Playlists"]: def get_closed(cls, session: scoped_session) -> List["Playlists"]:
"""Returns a list of all closed playlists ordered by last use""" """Returns a list of all closed playlists ordered by last use"""
return ( return (
@ -284,7 +285,7 @@ class Playlists(Base):
) )
@classmethod @classmethod
def get_open(cls, session: Session) -> List[Optional["Playlists"]]: def get_open(cls, session: scoped_session) -> List[Optional["Playlists"]]:
""" """
Return a list of loaded playlists ordered by tab order. Return a list of loaded playlists ordered by tab order.
""" """
@ -299,14 +300,14 @@ class Playlists(Base):
.all() .all()
) )
def mark_open(self, session: Session, tab_index: int) -> None: def mark_open(self, session: scoped_session, tab_index: int) -> None:
"""Mark playlist as loaded and used now""" """Mark playlist as loaded and used now"""
self.tab = tab_index self.tab = tab_index
self.last_used = datetime.now() self.last_used = datetime.now()
@staticmethod @staticmethod
def move_tab(session: Session, frm: int, to: int) -> None: def move_tab(session: scoped_session, frm: int, to: int) -> None:
"""Move tabs""" """Move tabs"""
row_frm = session.execute( row_frm = session.execute(
@ -326,7 +327,7 @@ class Playlists(Base):
row_frm.tab = to row_frm.tab = to
@staticmethod @staticmethod
def save_as_template(session: Session, def save_as_template(session: scoped_session,
playlist_id: int, template_name: str) -> None: playlist_id: int, template_name: str) -> None:
"""Save passed playlist as new template""" """Save passed playlist as new template"""
@ -357,7 +358,7 @@ class PlaylistRows(Base):
) )
def __init__(self, def __init__(self,
session: Session, session: scoped_session,
playlist_id: int, playlist_id: int,
track_id: int, track_id: int,
row_number: int, row_number: int,
@ -373,7 +374,7 @@ class PlaylistRows(Base):
session.flush() session.flush()
@staticmethod @staticmethod
def copy_playlist(session: Session, def copy_playlist(session: scoped_session,
src_id: int, src_id: int,
dst_id: int) -> None: dst_id: int) -> None:
"""Copy playlist entries""" """Copy playlist entries"""
@ -388,7 +389,7 @@ class PlaylistRows(Base):
plr.note) plr.note)
@staticmethod @staticmethod
def delete_plrids_not_in_list(session: Session, playlist_id: int, def delete_plrids_not_in_list(session: scoped_session, playlist_id: int,
plrids: List["PlaylistRows"]) -> None: plrids: List["PlaylistRows"]) -> None:
""" """
Delete rows in given playlist that have a higher row number Delete rows in given playlist that have a higher row number
@ -406,7 +407,7 @@ class PlaylistRows(Base):
session.commit() session.commit()
@staticmethod @staticmethod
def fixup_rownumbers(session: Session, playlist_id: int) -> None: def fixup_rownumbers(session: scoped_session, playlist_id: int) -> None:
""" """
Ensure the row numbers for passed playlist have no gaps Ensure the row numbers for passed playlist have no gaps
""" """
@ -424,7 +425,7 @@ class PlaylistRows(Base):
session.commit() session.commit()
@staticmethod @staticmethod
def get_track_plr(session: Session, track_id: int, def get_track_plr(session: scoped_session, track_id: int,
playlist_id: int) -> Optional["PlaylistRows"]: playlist_id: int) -> Optional["PlaylistRows"]:
"""Return first matching PlaylistRows object or None""" """Return first matching PlaylistRows object or None"""
@ -438,7 +439,7 @@ class PlaylistRows(Base):
).first() ).first()
@staticmethod @staticmethod
def get_last_used_row(session: Session, playlist_id: int) -> Optional[int]: def get_last_used_row(session: scoped_session, playlist_id: int) -> Optional[int]:
"""Return the last used row for playlist, or None if no rows""" """Return the last used row for playlist, or None if no rows"""
return session.execute( return session.execute(
@ -447,7 +448,7 @@ class PlaylistRows(Base):
).scalar_one() ).scalar_one()
@classmethod @classmethod
def get_played_rows(cls, session: Session, def get_played_rows(cls, session: scoped_session,
playlist_id: int) -> List[int]: playlist_id: int) -> List[int]:
""" """
For passed playlist, return a list of rows that For passed playlist, return a list of rows that
@ -466,7 +467,7 @@ class PlaylistRows(Base):
return plrs return plrs
@classmethod @classmethod
def get_rows_with_tracks(cls, session: Session, def get_rows_with_tracks(cls, session: scoped_session,
playlist_id: int) -> List[int]: playlist_id: int) -> List[int]:
""" """
For passed playlist, return a list of rows that For passed playlist, return a list of rows that
@ -485,8 +486,8 @@ class PlaylistRows(Base):
return plrs return plrs
@classmethod @classmethod
def get_unplayed_rows(cls, session: Session, def get_unplayed_rows(cls, session: scoped_session,
playlist_id: int) -> List["PlaylistRows]: playlist_id: int) -> List["PlaylistRows"]:
""" """
For passed playlist, return a list of playlist rows that For passed playlist, return a list of playlist rows that
have not been played. have not been played.
@ -505,7 +506,7 @@ class PlaylistRows(Base):
return plrs return plrs
@staticmethod @staticmethod
def move_rows_down(session: Session, playlist_id: int, starting_row: int, def move_rows_down(session: scoped_session, playlist_id: int, starting_row: int,
move_by: int) -> None: move_by: int) -> None:
""" """
Create space to insert move_by additional rows by incremented row Create space to insert move_by additional rows by incremented row
@ -522,7 +523,7 @@ class PlaylistRows(Base):
) )
@staticmethod @staticmethod
def indexed_by_id(session: Session, plr_ids: List[int]) -> dict: def indexed_by_id(session: scoped_session, plr_ids: List[int]) -> dict:
""" """
Return a dictionary of playlist_rows indexed by their plr id from Return a dictionary of playlist_rows indexed by their plr id from
the passed plr_id list. the passed plr_id list.
@ -558,7 +559,7 @@ class Settings(Base):
return f"<Settings(id={self.id}, name={self.name}, {value=}>" return f"<Settings(id={self.id}, name={self.name}, {value=}>"
@classmethod @classmethod
def get_int_settings(cls, session: Session, name: str) -> "Settings": def get_int_settings(cls, session: scoped_session, name: str) -> "Settings":
"""Get setting for an integer or return new setting record""" """Get setting for an integer or return new setting record"""
int_setting: Settings int_setting: Settings
@ -577,7 +578,7 @@ class Settings(Base):
return int_setting return int_setting
def update(self, session: Session, data: "Settings"): def update(self, session: scoped_session, data: "Settings"):
for key, value in data.items(): for key, value in data.items():
assert hasattr(self, key) assert hasattr(self, key)
setattr(self, key, value) setattr(self, key, value)
@ -609,7 +610,7 @@ class Tracks(Base):
def __init__( def __init__(
self, self,
session: Session, session: scoped_session,
path: str, path: str,
title: Optional[str] = None, title: Optional[str] = None,
artist: Optional[str] = None, artist: Optional[str] = None,
@ -640,7 +641,7 @@ class Tracks(Base):
return session.execute(select(cls)).scalars().all() return session.execute(select(cls)).scalars().all()
@classmethod @classmethod
def get_by_path(cls, session: Session, path: str) -> "Tracks": def get_by_path(cls, session: scoped_session, path: str) -> "Tracks":
""" """
Return track with passed path, or None. Return track with passed path, or None.
""" """
@ -656,7 +657,7 @@ class Tracks(Base):
return None return None
@classmethod @classmethod
def search_artists(cls, session: Session, text: str) -> List["Tracks"]: def search_artists(cls, session: scoped_session, text: str) -> List["Tracks"]:
"""Search case-insenstively for artists containing str""" """Search case-insenstively for artists containing str"""
return ( return (
@ -670,7 +671,7 @@ class Tracks(Base):
) )
@classmethod @classmethod
def search_titles(cls, session: Session, text: str) -> List["Tracks"]: def search_titles(cls, session: scoped_session, text: str) -> List["Tracks"]:
"""Search case-insenstively for titles containing str""" """Search case-insenstively for titles containing str"""
return ( return (
session.execute( session.execute(

3
app/playlists.py
View File

@ -554,7 +554,8 @@ class PlaylistTab(QTableWidget):
return [self._get_playlistrow_id(a) for a in self._get_selected_rows()] return [self._get_playlistrow_id(a) for a in self._get_selected_rows()]
def get_selected_playlistrows(self, session: scoped_session) -> Optional[List]: def get_selected_playlistrows(self,
session: scoped_session) -> Optional[List]:
""" """
Return a list of PlaylistRows of the selected rows Return a list of PlaylistRows of the selected rows
""" """