rommapp/romm
1
0
Fork 0
mirror of https://github.com/rommapp/romm.git synced 2026-02-18 00:27:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2004 from rommapp/misc/remove-filter-roms-boolean-params

Browse Source 
misc: Remove deprecated boolean parameters from get_roms endpoint
This commit is contained in:
Michael Manganiello
2025-06-19 14:25:08 -03:00
committed by GitHub
parent ffbfb74ca9 3f9957ab40
commit e511584907
2 changed files with 22 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
backend/endpoints/rom.py
View File

@@ -5,7 +5,7 @@ from datetime import datetime, timezone
from io import BytesIO
from shutil import rmtree
from stat import S_IFREG
from typing import Annotated, Any, TypeVar
from typing import Any, TypeVar
from urllib.parse import quote
from zipfile import ZIP_DEFLATED, ZIP_STORED, ZipFile, ZipInfo
@@ -160,15 +160,6 @@ def get_roms(
missing: bool | None = None,
has_ra: bool | None = None,
verified: bool | None = None,
# TODO: Remove deprecated boolean parameters, in favor of their
# optional counterparts.
unmatched_only: Annotated[bool, Query(deprecated=True)] = False,
matched_only: Annotated[bool, Query(deprecated=True)] = False,
favourites_only: Annotated[bool, Query(deprecated=True)] = False,
duplicates_only: Annotated[bool, Query(deprecated=True)] = False,
playables_only: Annotated[bool, Query(deprecated=True)] = False,
missing_only: Annotated[bool, Query(deprecated=True)] = False,
ra_only: Annotated[bool, Query(deprecated=True)] = False,
group_by_meta_id: bool = False,
selected_genre: str | None = None,
selected_franchise: str | None = None,
@@ -195,13 +186,6 @@ def get_roms(
playable (bool, optional): Filter for playable or non-playable roms. Defaults to None.
missing (bool, optional): Filter only roms that are missing from the filesystem. Defaults to False.
verified (bool, optional): Filter only roms that are verified by hasheous from the filesystem. Defaults to False.
unmatched_only (bool, optional): Filter only unmatched roms. Defaults to False. DEPRECATED: use `matched` instead.
matched_only (bool, optional): Filter only matched roms. Defaults to False. DEPRECATED: use `matched` instead.
favourites_only (bool, optional): Filter only favourite roms. Defaults to False. DEPRECATED: use `favourite` instead.
duplicates_only (bool, optional): Filter only duplicate roms. Defaults to False. DEPRECATED: use `duplicate` instead.
playables_only (bool, optional): Filter only playable roms by emulatorjs. Defaults to False. DEPRECATED: use `playable` instead.
ra_only (bool, optional): Filter only roms with Retroachievements compatibility. Defaults to False. DEPRECATED: use `has_ra` instead.
missing_only (bool, optional): Filter only roms that are missing from the filesystem. Defaults to False. DEPRECATED: use `missing` instead.
group_by_meta_id (bool, optional): Group roms by igdb/moby/ssrf/launchbox ID. Defaults to False.
selected_genre (str, optional): Filter by genre. Defaults to None.
selected_franchise (str, optional): Filter by franchise. Defaults to None.
@@ -223,28 +207,6 @@ def get_roms(
order_dir=order_dir.lower(),
)
# Backwards compatibility for matched parameter.
if matched is None:
if unmatched_only:
matched = False
elif matched_only:
matched = True
# Backwards compatibility for favourite parameter.
if favourite is None and favourites_only:
favourite = True
# Backwards compatibility for duplicate parameter.
if duplicate is None and duplicates_only:
duplicate = True
# Backwards compatibility for playable parameter.
if playable is None and playables_only:
playable = True
# Backwards compatibility for has_ra parameter.
if has_ra is None and ra_only:
has_ra = True
# Backwards compatibility for missing parameter.
if missing is None and missing_only:
missing = True
# Filter down the query
query = db_rom_handler.filter_roms(
query=query,

32
backend/handler/database/roms_handler.py
View File

@@ -236,11 +236,17 @@ class DBRomsHandler(DBBaseHandler):
predicate = not_(predicate)
return query.join(Rom.platform).filter(predicate)
def filter_by_has_ra(self, query: Query):
return query.filter(Rom.ra_id.isnot(None))
def filter_by_has_ra(self, query: Query, value: bool) -> Query:
predicate = Rom.ra_id.isnot(None)
if not value:
predicate = not_(predicate)
return query.filter(predicate)
def filter_by_missing_from_fs(self, query: Query):
return query.filter(Rom.missing_from_fs.isnot(False))
def filter_by_missing_from_fs(self, query: Query, value: bool) -> Query:
predicate = Rom.missing_from_fs.isnot(False)
if not value:
predicate = not_(predicate)
return query.filter(predicate)
def filter_by_verified(self, query: Query):
keys_to_check = [
@@ -388,9 +394,9 @@ class DBRomsHandler(DBBaseHandler):
favourite: bool | None = None,
duplicate: bool | None = None,
playable: bool | None = None,
has_ra: bool | None = False,
missing: bool | None = False,
verified: bool | None = False,
has_ra: bool | None = None,
missing: bool | None = None,
verified: bool | None = None,
group_by_meta_id: bool = False,
selected_genre: str | None = None,
selected_franchise: str | None = None,
@@ -431,12 +437,13 @@ class DBRomsHandler(DBBaseHandler):
if playable is not None:
query = self.filter_by_playable(query, value=playable)
if has_ra:
query = self.filter_by_has_ra(query)
if has_ra is not None:
query = self.filter_by_has_ra(query, value=has_ra)
if missing:
query = self.filter_by_missing_from_fs(query)
if missing is not None:
query = self.filter_by_missing_from_fs(query, value=missing)
# TODO: Correctly support true/false values.
if verified:
query = self.filter_by_verified(query)
@@ -612,6 +619,9 @@ class DBRomsHandler(DBBaseHandler):
favourite=kwargs.pop("favourite", None),
duplicate=kwargs.pop("duplicate", None),
playable=kwargs.pop("playable", None),
has_ra=kwargs.pop("has_ra", None),
missing=kwargs.pop("missing", None),
verified=kwargs.pop("verified", None),
selected_genre=kwargs.pop("selected_genre", None),
selected_franchise=kwargs.pop("selected_franchise", None),
selected_collection=kwargs.pop("selected_collection", None),