codey/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docstring stuff

Browse Source
This commit is contained in:
codey
2025-01-19 07:01:07 -05:00
parent 151643c5dc
commit be0ef08f3d
9 changed files with 118 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
lyric_search_new/sources/aggregate.py
View File

@@ -14,7 +14,9 @@ logger = logging.getLogger()
logger.setLevel(logging.INFO)
class Aggregate:
"""Aggregate all source methods"""
"""
Aggregate all source methods
"""
def __init__(self, exclude_methods=None):
if not exclude_methods:
@@ -22,7 +24,15 @@ class Aggregate:
self.exclude_methods = exclude_methods
async def search(self, artist: str, song: str, plain: bool = True) -> Optional[LyricsResult]:
"""Aggregate Search"""
"""
Aggregate Search
Args:
artist (str): Artist to search
song (str): Song to search
plain (bool): Search for plain lyrics (lrc otherwise)
Returns:
LyricsResult|None: The result, if found - None otherwise.
"""
if not plain:
logging.info("LRCs requested, limiting search to LRCLib")
self.exclude_methods = ["genius", "cache"]

36
lyric_search_new/sources/cache.py
View File

@@ -7,7 +7,6 @@ import regex
import logging
import sys
import traceback
import asyncio
sys.path.insert(1,'..')
sys.path.insert(1,'.')
from typing import Optional, Any
@@ -29,9 +28,6 @@ class Cache:
"cached_lyrics.db")
self.redis_cache = redis_cache.RedisCache()
asyncio.get_event_loop().create_task(
self.redis_cache.create_index())
self.cache_pre_query: str = "pragma journal_mode = WAL; pragma synchronous = normal;\
pragma temp_store = memory; pragma mmap_size = 30000000000;"
self.sqlite_exts: list[str] = ['/usr/local/lib/python3.11/dist-packages/spellfix1.cpython-311-x86_64-linux-gnu.so']
@@ -39,7 +35,16 @@ class Cache:
def get_matched(self, matched_candidate: tuple, confidence: int,
sqlite_rows: list[sqlite3.Row] = None, redis_results: Any = None) -> Optional[LyricsResult]:
"""Get Matched Result"""
"""
Get Matched Result
Args:
matched_candidate (tuple): the correctly matched candidate returned by matcher.best_match
confidence (int): % confidence
sqlite_rows (list[sqlite3.Row]|None): List of returned rows from SQLite DB, or None if Redis
redis_results (Any): List of Redis returned data, or None if SQLite
Returns:
LyricsResult|None: The result, if found - None otherwise.
"""
matched_id: int = matched_candidate[0]
if redis_results:
for res in redis_results:
@@ -68,7 +73,10 @@ class Cache:
async def check_existence(self, artistsong: str) -> Optional[bool]:
"""
Check whether lyrics are already stored for track
@artistsong: artist and song in artist\nsong format
Args:
artistsong (str): artist and song in artist\\nsong format
Returns:
bool: Whether track was found in cache
"""
logging.debug("Checking whether %s is already stored",
artistsong.replace("\n", " - "))
@@ -88,8 +96,11 @@ class Cache:
async def store(self, lyr_result: LyricsResult) -> None:
"""
store
@lyr_result: the returned lyrics to cache
Store lyrics to cache
Args:
lyr_result: the returned lyrics to cache
Returns:
None
"""
logging.info("Storing %s",
@@ -127,11 +138,12 @@ class Cache:
# pylint: disable=unused-argument
async def search(self, artist: str, song: str, **kwargs) -> Optional[LyricsResult]:
"""
search
@artist: the artist to search
@song: the song to search
Cache Search
Args:
artist: the artist to search
song: the song to search
Returns:
- LyricsResult corresponding to nearest match found (if found), **None** otherwise
LyricsResult|None: The result, if found - None otherwise.
"""
try:
# pylint: enable=unused-argument

8
lyric_search_new/sources/genius.py
View File

@@ -40,8 +40,12 @@ class Genius:
# pylint: disable=unused-argument
async def search(self, artist: str, song: str, **kwargs) -> Optional[LyricsResult]:
"""
@artist: the artist to search
@song: the song to search
Genius Search
Args:
artist (str): the artist to search
song (str): the song to search
Returns:
LyricsResult|None: The result, if found - None otherwise.
"""
try:
# pylint: enable=unused-argument

8
lyric_search_new/sources/lrclib.py
View File

@@ -34,8 +34,12 @@ class LRCLib:
async def search(self, artist: str, song: str, plain: bool = True) -> Optional[LyricsResult]:
"""
@artist: the artist to search
@song: the song to search
LRCLib Search
Args:
artist (str): the artist to search
song (str): the song to search
Returns:
LyricsResult|None: The result, if found - None otherwise.
"""
try:
artist: str = artist.strip().lower()

25
lyric_search_new/sources/redis_cache.py
View File

@@ -1,10 +1,14 @@
#!/usr/bin/env python3.12
# pylint: disable=bare-except, broad-exception-caught
# pylint: disable=bare-except, broad-exception-caught, wrong-import-order
# pylint: disable=wrong-import-position
import logging
import traceback
import json
import sys
sys.path.insert(1,'..')
from lyric_search_new import notifier
import redis.asyncio as redis
from redis.commands.search.query import Query
from redis.commands.search.indexDefinition import IndexDefinition, IndexType
@@ -12,6 +16,7 @@ from redis.commands.search.field import TextField
from . import private
logger = logging.getLogger()
log_level = logging.getLevelName(logger.level)
@@ -27,6 +32,8 @@ class RedisCache:
def __init__(self):
self.redis_client = redis.Redis(password=private.REDIS_PW)
self.notifier = notifier.DiscordNotifier()
self.notify_warnings = True
async def create_index(self):
"""Create Index"""
@@ -41,8 +48,8 @@ class RedisCache:
schema, definition=IndexDefinition(prefix=["lyrics:"], index_type=IndexType.JSON))
if str(result) != "OK":
raise RedisException(f"Redis: Failed to create index: {result}")
except:
pass
except Exception as e:
await self.notifier.send(f"ERROR @ {__file__}", f"Failed to create idx: {str(e)}")
async def search(self, **kwargs):
"""Search Redis Cache
@@ -62,13 +69,13 @@ class RedisCache:
raise RedisException("Lyric search not yet implemented")
if not is_random_search:
artist = artist.replace("-", "")
song = song.replace("-", "")
artist = artist.replace("-", " ")
song = song.replace("-", " ")
search_res = await self.redis_client.ft().search(
Query(f"@artist:{artist} @song:{song}"
))
search_res_out = [(result['id'].split(":",
maxsplit=1)[1][:-1], dict(json.loads(result['json'])))
maxsplit=1)[1], dict(json.loads(result['json'])))
for result in search_res.docs]
else:
random_redis_key = await self.redis_client.randomkey()
@@ -77,8 +84,10 @@ class RedisCache:
search_res = await self.redis_client.json().get(random_redis_key)
search_res_out = [(out_id, search_res)]
if not search_res_out and self.notify_warnings:
await self.notifier.send("WARNING", f"Redis cache miss for: \n## *{artist} - {song}*")
return search_res_out
except:
except Exception as e:
await self.notifier.send(f"ERROR @ {__file__}", str(e))
traceback.print_exc()