libretrofuzz 2.9.2__tar.gz → 2.9.4__tar.gz

{libretrofuzz-2.9.2 → libretrofuzz-2.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libretrofuzz
-Version: 2.9.2
+Version: 2.9.4
 Summary: Fuzzy Retroarch thumbnail downloader
 Home-page: https://github.com/i30817/libretrofuzz
 License: MIT
@@ -13,13 +13,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Requires-Dist: beautifulsoup4 (>=4.10.0,<5.0.0)
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
 Requires-Dist: httpx (>=0.23.0,<0.24.0)
 Requires-Dist: pillow (>=9.2.0,<10.0.0)
 Requires-Dist: prompt_toolkit (>=3.0.30,<4.0.0)
 Requires-Dist: questionary (>=1.10.0,<2.0.0)
 Requires-Dist: rapidfuzz (>=2.4.2,<3.0.0)
 Requires-Dist: regex (>=2023.6.3,<2024.0.0)
-Requires-Dist: tqdm (>=4.64.0,<5.0.0)
+Requires-Dist: tqdm (>=4.65.0,<5.0.0)
 Requires-Dist: typer[all] (>=0.5.0,<0.6.0)
 Project-URL: Bug Tracker, https://github.com/i30817/libretrofuzz/issues
 Project-URL: Repository, https://github.com/i30817/libretrofuzz
@@ -87,7 +88,7 @@ libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
   --delay FLOAT         | Seconds to skip thumbnails download, enter continues.
                         | [1<=x<=30]
   --filter GLOB         Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.
-  --score FUZZ          | Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with ``--no-fail``.
+  --min SCORE           | 0=any, 100=fuzzy match, 200=equal mininames,default. No-op with ``--no-fail``.
                         | [default: 200; 0<=x<=200]
   --no-fail             Download any score. Equivalent to ``--score 0``.
   --no-image            Don't show images even with chafa installed.
@@ -98,7 +99,8 @@ libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
   --before TEXT         Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.
   --address URL         | URL with libretro-thumbnails server. For local files, git clone/unzip packs, run ``'python3 -m http.server'`` in parent dir, and use ``--address 'http://localhost:8000'``.
                         | [default: https://thumbnails.libretro.com]
-  --verbose             Shows the failures, score and normalized local and server names in output.
+  --verbose N           | Show mininame, len N list (maxscore, server mininame).
+                        | [x>=1]
   --install-completion  Install completion for the current shell.
   --show-completion     Show completion for the current shell, to copy it or customize the installation.
   --help                Show this message and exit.

{libretrofuzz-2.9.2 → libretrofuzz-2.9.4}/README.rst

@@ -58,7 +58,7 @@ libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
   --delay FLOAT         | Seconds to skip thumbnails download, enter continues.
                         | [1<=x<=30]
   --filter GLOB         Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.
-  --score FUZZ          | Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with ``--no-fail``.
+  --min SCORE           | 0=any, 100=fuzzy match, 200=equal mininames,default. No-op with ``--no-fail``.
                         | [default: 200; 0<=x<=200]
   --no-fail             Download any score. Equivalent to ``--score 0``.
   --no-image            Don't show images even with chafa installed.
@@ -69,7 +69,8 @@ libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
   --before TEXT         Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.
   --address URL         | URL with libretro-thumbnails server. For local files, git clone/unzip packs, run ``'python3 -m http.server'`` in parent dir, and use ``--address 'http://localhost:8000'``.
                         | [default: https://thumbnails.libretro.com]
-  --verbose             Shows the failures, score and normalized local and server names in output.
+  --verbose N           | Show mininame, len N list (maxscore, server mininame).
+                        | [x>=1]
   --install-completion  Install completion for the current shell.
   --show-completion     Show completion for the current shell, to copy it or customize the installation.
   --help                Show this message and exit.

libretrofuzz-2.9.4/libretrofuzz/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.9.4'

{libretrofuzz-2.9.2 → libretrofuzz-2.9.4}/libretrofuzz/__main__.py

@@ -102,6 +102,13 @@ class StopProgram(Exception):
 skip = False
 escape  = False
 enter = False
+
+@contextmanager
+def handleContinueDownload():
+  try:
+    yield
+  except ContinueDownload:
+    pass
 def checkDownload():
     '''threading.get_native_id() in this and other acesses of these variables
        confirms all accesses are in synchronous functions on one thread so
@@ -169,6 +176,16 @@ async def lock_keys() -> None:
             yield done
 
 #----------------non contextual str manipulation------------------------
+def link(uri, label=None, parameters=''):
+    '''
+    Found in github, windows console and many unix consoles trick to embeed hyperlinks/uri with text
+    '''
+    if label is None:
+        label = uri
+    # OSC 8 ; params ; URI ST <name> OSC 8 ;; ST
+    escape_mask = '\033]8;{};{}\033\\{}\033]8;;\033\\'
+    return escape_mask.format(parameters, uri, label)
+
 ppatterns = { '()': regex.compile(r'\([^)(]*\)'), '[]': regex.compile(r'\[[^][]*\]') }
 def removeparenthesis(s, open_p='(', close_p=')'):
     nb_rep = 1
@@ -225,29 +242,29 @@ def which(executable):
 #-----------------------------------------------------------------------------------------------------------------------
 class TitleScorer(object):
     def __init__(self):
-        #rapidfuzz says to use range 0-100, but this doesn't (it's much easier that way), so it uses internal api to prevent a possible early exit at == 100
-        self._RF_ScorerPy = { 'get_scorer_flags': lambda **kwargs: {'optimal_score': MAX_SCORE, 'worst_score': 0, 'flags': (1 << 6)} }
+      #rapidfuzz says to use range 0-100, but this doesn't (it's much easier that way)
+      #so it uses internal api to prevent a possible early exit at == 100
+      self._RF_ScorerPy = { 'get_scorer_flags': lambda **kwargs: {'optimal_score': MAX_SCORE, 'worst_score': 0, 'flags': (1 << 6)} }
 
     def __call__(self, s1, s2, processor=None, score_cutoff=None):
-        prefix = len(os.path.commonprefix([s1, s2]))
-        if prefix <= 2 and len(s1) != len(s2):
-            #ideally this branch wouldn't exist, but since many games do not have
-            #images, they get caught up on a short title 'score' from token_set_ratio
-            #without the real title to win the similarity+prefix heuristic
-            #this removes many false positives and causes few false negatives.
-            return 0
-        else:
-            if s1 == s2:
-                return MAX_SCORE
-            #score_cutoff needs to be 0 from a combination of 3 factors that create a bug:
-            #1. the caller of this, extractOne passes the 'current best score' as score_cutoff
-            #2. the token_set_ratio function returns 0 if the calculated score < score_cutoff
-            #3. 'current best score' includes the prefix, which this call can't include in 2.
-            similarity = fuzz.token_set_ratio(s1,s2,processor=None,score_cutoff=0)
-            #Combine the scorer with a common prefix heuristic to give priority to longer similar
-            #names, this helps prevents false positives for shorter strings which token set ratio
-            #is prone because it sets score to 100 if one string words are completely on the other.
-            return min(MAX_SCORE-1,similarity + prefix)
+      if (min(len(s1),len(s2)) / max(len(s1),len(s2))) < 0.3:
+        #ideally this branch wouldn't exist, but since many games do not have
+        #images, they get caught up on a short title being completely contained in another
+        #token_set_ratio gives that 100. Skip if the smaller name length is less than 30%
+        return 0
+      #names are whitespace and case normalized
+      if s1 == s2:
+        return MAX_SCORE
+      prefix = len(os.path.commonprefix([s1, s2]))
+      #score_cutoff needs to be 0 from a combination of 3 factors that create a bug:
+      #1. the caller of this, extract passes the 'current best score' as score_cutoff
+      #2. the token_set_ratio function returns 0 if the calculated score < score_cutoff
+      #3. 'current best score' includes the prefix, which this call can't include in 2.
+      similarity = fuzz.token_set_ratio(s1,s2,processor=None,score_cutoff=0)
+      #Combine the scorer with a common prefix heuristic to give priority to longer similar
+      #names, this helps prevents false positives for shorter strings which token set ratio
+      #is prone because it sets score to 100 if one string words are completely on the other.
+      return min(MAX_SCORE-1,similarity + prefix)
 
 #-----------------------------------------------------------------------------------------------------------------------------
 # Normalization functions, part of the functions that change both local labels and remote names to be more similar to compare
@@ -311,9 +328,6 @@ def normalizer(t, nometa, hack):
     #this makes sure that if a remote name has ' and ' instead of ' _ ' to replace ' & ' it works
     #': ' doesn't need this because ':' is a forbidden character and both '_' and '-' turn to ''
     t = t.replace(' and ',  '')
-    #although all names have spaces (now), the local names may have weird spaces,
-    #so to equalize them after the space dependent checks (this also strips)
-    t = ''.join(t.split())
     #Tries to make roman numerals in the range 1-20 equivalent to normal numbers (to handle names that change it).
     #If both sides are roman numerals there is no harm done if XXIV gets turned into 204 in both sides.
     t = t.replace('xviii', '18')
@@ -338,7 +352,8 @@ def normalizer(t, nometa, hack):
     t = t.replace('i',    '1')
     #remove diacritics (does nothing to asian languages diacritics, only for 2 to 1 character combinations)
     t = u''.join([c for c in unicodedata.normalize('NFKD', t) if not unicodedata.combining(c)])
-    return t
+    #normalize spaces (don't remove them for other later score methods to be able to reorder tokens
+    return ' '.join(t.split())
 
 def nosubtitle_normalizer(t, nometa, hack):
     return normalizer(nosubtitle_aux(t), nometa, hack)
@@ -447,6 +462,12 @@ def error(error: str):
 
 def test_common_errors(cfg: Path, playlist: str, system: str, address: str):
     '''returns a tuple with (playlist_dir: Path, thumbnail_dir: Path, PLAYLISTS: [Path], SYSTEMS: [str]) '''
+    #stop showing the variables - a library installed this behind my back
+    try:
+      from rich.traceback import install
+      install(show_locals=False)
+    except ImportError:
+      pass
     global ADDRESS
     ADDRESS = address.rstrip('/')
     global viewer
@@ -494,7 +515,7 @@ def mainfuzzsingle(cfg: Path = typer.Argument(CONFIG, help='Path to the retroarc
         wait_after: Optional[float] = typer.Option(None, '--delay-after', min=1, max=MAX_WAIT_SECS, clamp=True, metavar='FLOAT', help='Seconds after download to skip replacing thumbnails, enter continues. No-op with --no-image.'),
         wait_before: Optional[float] = typer.Option(None, '--delay', min=1, max=MAX_WAIT_SECS, clamp=True, metavar='FLOAT', help='Seconds to skip thumbnails download, enter continues.'),
         filters: Optional[List[str]] = typer.Option(None, '--filter', metavar='GLOB', help='Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, --filter \'*\' redownloads all.'),
-        score: int = typer.Option(MAX_SCORE, '--score', min=0, max=MAX_SCORE, metavar='FUZZ', help='Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with --no-fail.'),
+        score: int = typer.Option(MAX_SCORE, '--min', min=0, max=MAX_SCORE, metavar='SCORE', help=f'0=any, 100=fuzzy match, {MAX_SCORE}=equal mininames,default. No-op with --no-fail.'),
         nofail: bool = typer.Option(False, '--no-fail', help='Download any score. Equivalent to --score 0.'),
         noimage: bool = typer.Option(False, '--no-image', help='Don\'t show images even with chafa installed.'),
         nomerge: bool = typer.Option(False, '--no-merge', help='Disables missing thumbnails download for a label if there is at least one in cache to avoid mixing thumbnails from different server directories on repeated calls. No-op with --filter.'),
@@ -503,7 +524,7 @@ def mainfuzzsingle(cfg: Path = typer.Argument(CONFIG, help='Path to the retroarc
         hack: bool = typer.Option(False, '--hack', help='Matches [] delimited metadata and may cause false positives, Best used if the hack has thumbnails. Ignored with --before.'),
         before: Optional[str] = typer.Option(None, help='Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.'),
         address: Optional[str] = typer.Option(ADDRESS, metavar='URL', help='URL with libretro-thumbnails server. For local files, git clone/unzip packs, run \'python3 -m http.server\' in parent dir, and use --address \'http://localhost:8000\'.'),
-        verbose: bool = typer.Option(False, '--verbose', help='Shows the failures, score and normalized local and server names in output.')
+        verbose: Optional[int] = typer.Option(None, '--verbose', min=1, metavar='N', help=f'Show mininame, len N list (maxscore, server mininame).')
     ):
     if playlist and not playlist.lower().endswith('.lpl'):
         playlist = playlist + '.lpl'
@@ -550,7 +571,7 @@ def mainfuzzall(cfg: Path = typer.Argument(CONFIG, help='Path to the retroarch c
         wait_after: Optional[float] = typer.Option(None, '--delay-after', min=1, max=MAX_WAIT_SECS, clamp=True, metavar='FLOAT', help='Seconds after download to skip replacing thumbnails, enter continues. No-op with --no-image.'),
         wait_before: Optional[float] = typer.Option(None, '--delay', min=1, max=MAX_WAIT_SECS, clamp=True, metavar='FLOAT', help='Seconds to skip thumbnails download, enter continues.'),
         filters: Optional[List[str]] = typer.Option(None, '--filter', metavar='GLOB', help='Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, --filter \'*\' redownloads all.'),
-        score: int = typer.Option(MAX_SCORE, '--score', min=0, max=MAX_SCORE, metavar='FUZZ', help='Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with --no-fail.'),
+        score: int = typer.Option(MAX_SCORE, '--min', min=0, max=MAX_SCORE, metavar='SCORE', help=f'0=any, 100=fuzzy match, {MAX_SCORE}=equal mininames,default. No-op with --no-fail.'),
         nofail: bool = typer.Option(False, '--no-fail', help='Download any score. Equivalent to --score 0.'),
         noimage: bool = typer.Option(False, '--no-image', help='Don\'t show images even with chafa installed.'),
         nomerge: bool = typer.Option(False, '--no-merge', help='Disables missing thumbnails download for a label if there is at least one in cache to avoid mixing thumbnails from different server directories on repeated calls. No-op with --filter.'),
@@ -559,7 +580,7 @@ def mainfuzzall(cfg: Path = typer.Argument(CONFIG, help='Path to the retroarch c
         hack: bool = typer.Option(False, '--hack', help='Matches [] delimited metadata and may cause false positives, Best used if the hack has thumbnails. Ignored with --before.'),
         before: Optional[str] = typer.Option(None, help='Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.'),
         address: Optional[str] = typer.Option(ADDRESS, metavar='URL', help='URL with libretro-thumbnails server. For local files, git clone/unzip packs, run \'python3 -m http.server\' in parent dir, and use --address \'http://localhost:8000\'.'),
-        verbose: bool = typer.Option(False, '--verbose', help='Shows the failures, score and normalized local and server names in output.')
+        verbose: Optional[int] = typer.Option(None, '--verbose', min=1, metavar='N', help=f'Show mininame, len N list (maxscore, server mininame).')
     ):
     playlist_dir, thumbnails_dir, PLAYLISTS, SYSTEMS = test_common_errors(cfg, None, None, address)
     
@@ -623,7 +644,7 @@ async def downloader(names: [(str,str)],
                wait_after: Optional[float],
                filters: Optional[List[str]],
                score: int,
-               noimage : bool, nomerge: bool, nofail: bool, nometa: bool, hack: bool, nosubtitle: bool, verbose: bool,
+               noimage : bool, nomerge: bool, nofail: bool, nometa: bool, hack: bool, nosubtitle: bool, verbose: Optional[int],
                before: Optional[str],
                tmpdir: Path,
                thumbnails_dir: Path,
@@ -632,9 +653,7 @@ async def downloader(names: [(str,str)],
     #not a error to pass a empty playlist
     if len(names) == 0:
         return
-    
     thumbs = Thumbs._make( await downloadgamenames(client, system) )
-    
     #before implies that the names of the playlists may be cut, so the hack and meta matching must be disabled
     if before:
         hack = False
@@ -692,27 +711,34 @@ async def downloader(names: [(str,str)],
         #operate on cache (to speed up by not applying normalization every iteration)
         #the normalization can make it so that the winner has the same score as the runner up(s) so to make sure we catch at least
         #two thumbnails for cases where that happens, we check both best scores if we can't find a thumb in a server directory
-        result = process.extract(nameaux, remote_names, scorer=title_scorer,processor=None,limit=2,score_cutoff=None)
-        norm_thumbnail, i_max, thumbnail = (None, 0, None)
-        thumbnail2 = None
-        if len(result) == 1:
-            norm_thumbnail, i_max, thumbnail = result[0]
-        elif len(result) == 2:
-            norm_thumbnail, i_max, thumbnail = result[0]
-            if result[0][1] == result[1][1]: #equal scores
-                thumbnail2 = result[1][2]
+        result = process.extract(nameaux, remote_names, scorer=title_scorer,processor=None,limit=verbose or 1,score_cutoff=None)
+        #build the verbose format and decompose the first result, with a optimization if verbose is not on
+        thumb_normal, thumb_score, thumb_name = (None, 0, None)
+        verbose_format = []
+        if verbose:
+          for r in reversed(result):
+            thumb_normal, thumb_score, thumb_name = r
+            color = typer.colors.RED if thumb_score < score else typer.colors.GREEN
+            verbose_format.insert(0, f"{typer.style(f'{int(thumb_score)}', fg=f'{color}', bold=True)} {thumb_normal}")
+          verbose_format = '|'.join(verbose_format)
+        elif len(result) > 0:
+          thumb_normal, thumb_score, thumb_name = result[0]
+        #hack, if result 1 and 2 have equal scores use the second thumbnail as a alternative if missing a thumb type
+        #this is done because it's relatively common for the server to have a case mistake on thumb types
+        thumb_name2 = None
+        if len(result) >= 2:
+          if result[0][1] == result[1][1]:
+            thumb_name2 = result[1][2]
         #formating legos
-        zeroth_format  = '  0 ' if verbose else ''
-        prefix_format  = '{:>3} '.format(str(int(i_max))) if verbose else ''
-        name_format    = f'{nameaux} -> {norm_thumbnail}' if verbose else f'{name} -> {thumbnail}'
-        success_format = f'{prefix_format}{typer.style("Success",   fg=typer.colors.GREEN, bold=True)}: {name_format}'
-        failure_format = f'{prefix_format}{typer.style("Failure",     fg=typer.colors.RED, bold=True)}: {name_format}'
-        missing_format = f'{prefix_format}{typer.style("Missing",     fg=typer.colors.RED, bold=True)}:'
-        cancel_format  = f'{prefix_format}{typer.style("Skipped",        fg=(135,135,135), bold=True)}: {name_format}'
-        nomerge_format = f'{zeroth_format}{typer.style("Nomerge",        fg=(128,128,128), bold=True)}: {name_format}'
-        getting_format = f'{prefix_format}{typer.style("Getting",    fg=typer.colors.BLUE, bold=True)}: {name_format}'
-        waiting_format = f'{prefix_format}{typer.style("Waiting",  fg=typer.colors.YELLOW, bold=True)}: {name_format}' '{bar:-9b} {remaining_s:2.1f}s: {bar:10u}'
-        if thumbnail and i_max >= score:
+        name_format    = f'{nameaux} -> {verbose_format}' if verbose else f'{name} -> {thumb_name}'
+        success_format = f'{typer.style("Success",   fg=typer.colors.GREEN, bold=True)}: {name_format}'
+        failure_format = f'{typer.style("Failure",     fg=typer.colors.RED, bold=True)}: {name_format}'
+        missing_format = f'{typer.style("Missing",     fg=typer.colors.RED, bold=True)}: {name_format}'
+        cancel_format  = f'{typer.style("Skipped",        fg=(135,135,135), bold=True)}: {name_format}'
+        nomerge_format = f'{typer.style("Nomerge",        fg=(128,128,128), bold=True)}: {name_format}'
+        getting_format = f'{typer.style("Getting",    fg=typer.colors.BLUE, bold=True)}: {name_format}'
+        waiting_format = f'{typer.style("Waiting",  fg=typer.colors.YELLOW, bold=True)}: {name_format}' '{bar:-9b} {remaining_s:2.1f}s: {bar:10u}'
+        if thumb_name and thumb_score >= score:
             allow = True
             #these parent directories were created when reading the playlist, more efficient than doing it a playlist game loop
             real_thumb_dir = Path(thumbnails_dir,destination)
@@ -725,7 +751,7 @@ async def downloader(names: [(str,str)],
                     real = Path(real_thumb_dir, dirname, name + '.png')
                     if not real.exists():
                         missing_thumbs += 1
-                        if thumbnail in getattr(thumbs, dirname) or thumbnail2 in getattr(thumbs, dirname):
+                        if thumb_name in getattr(thumbs, dirname) or thumb_name2 in getattr(thumbs, dirname):
                             missing_server_thumbs += 1
                 allow = missing_thumbs == 3
                 #despite the above, print only for when it would download if it was allowed, otherwise it is confusing
@@ -742,7 +768,7 @@ async def downloader(names: [(str,str)],
                         downloaded_dict[dirname] = (real, temp)
                         #something to download
                         thumbmap = getattr(thumbs, dirname)
-                        url = thumbmap[thumbnail] if thumbnail in thumbmap else thumbmap.get(thumbnail2, None)
+                        url = thumbmap[thumb_name] if thumb_name in thumbmap else thumbmap.get(thumb_name2, None)
                         #with filters/reset you always download, and without only if it doesn't exist already.
                         if url and (filters or not real.exists()):
                             download_format = f'{getting_format}' '{bar:-9b}' f'{dirname[6:-1]}' ' {percentage:3.0f}%: {bar:10u}'
@@ -777,12 +803,10 @@ async def downloader(names: [(str,str)],
 
 async def printwait(wait : Optional[float], waiting_format: str):
     count = int(wait/0.1)
-    try:
+    with handleContinueDownload():
       for i in trange(count, dynamic_ncols=True, bar_format=waiting_format, colour='YELLOW', leave=False):
         checkDownload()
         await asyncio.sleep(0.1)
-    except ContinueDownload as e:
-      pass
 
 async def download(client, url, destination, download_format, missing_format, waiting_format, first_wait, wait_before, max_retries):
     '''returns True if downloaded. To download, it must have waited, if first_wait is True. Exceptions may happen instead of returning False, but they
@@ -805,8 +829,9 @@ async def download(client, url, destination, download_format, missing_format, wa
                         await printwait(wait_before, waiting_format)
                     with tqdm.wrapattr(f, 'write', total=length, dynamic_ncols=True, bar_format=download_format, colour='BLUE', leave=False) as w:
                         async for chunk in r.aiter_raw(4096):
+                          with handleContinueDownload():
                             checkDownload()
-                            w.write(chunk)
+                          w.write(chunk)
             return True
         except (RequestError,HTTPStatusError) as e:
             if max_retries <= 0:

{libretrofuzz-2.9.2 → libretrofuzz-2.9.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "libretrofuzz"
-version = "2.9.2"
+version = "2.9.4"
 description = "Fuzzy Retroarch thumbnail downloader"
 authors = ["i30817 <i30817@gmail.com>"]
 license = "MIT"
@@ -14,10 +14,11 @@ questionary = "^1.10.0"
 typer = {extras = ["all"], version = "^0.5.0"}
 rapidfuzz = "^2.4.2"
 httpx = "^0.23.0"
-tqdm = "^4.64.0"
+tqdm = "^4.65.0"
 prompt_toolkit = "^3.0.30"
 pillow = "^9.2.0"
 regex = "^2023.6.3"
+colorama = "^0.4.6"
 
 
 [tool.poetry.scripts]

{libretrofuzz-2.9.2 → libretrofuzz-2.9.4}/setup.py

@@ -9,13 +9,14 @@ package_data = \
 
 install_requires = \
 ['beautifulsoup4>=4.10.0,<5.0.0',
+ 'colorama>=0.4.6,<0.5.0',
  'httpx>=0.23.0,<0.24.0',
  'pillow>=9.2.0,<10.0.0',
  'prompt_toolkit>=3.0.30,<4.0.0',
  'questionary>=1.10.0,<2.0.0',
  'rapidfuzz>=2.4.2,<3.0.0',
  'regex>=2023.6.3,<2024.0.0',
- 'tqdm>=4.64.0,<5.0.0',
+ 'tqdm>=4.65.0,<5.0.0',
  'typer[all]>=0.5.0,<0.6.0']
 
 entry_points = \
@@ -24,9 +25,9 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'libretrofuzz',
-    'version': '2.9.2',
+    'version': '2.9.4',
     'description': 'Fuzzy Retroarch thumbnail downloader',
-    'long_description': "**Fuzzy Retroarch thumbnail downloader**\n========================================\n\nIn Retroarch, when you use the manual scanner to get nonstandard games or hacks in playlists, thumbnails often fail to download.\n\nThese programs, for each game label on a playlist, download the most similar named image to display in retroarch.\n\nThere are several options to fit unusual labels and increase fuzziness, but you can just run them to get the most restrictive default (with the least fuzz).\n\nIf you use ``libretro-fuzz``, it will download for a single playlist by asking for the playlist and system if they're not provided.\nIf you use ``libretro-fuzzall``, it will download for all playlists with standard libretro names, and will skip custom playlists.\n\nBesides those differences, if no retroarch.cfg is provided, both programs try to use the default retroarch.cfg.\n\nIf `chafa <https://github.com/hpjansson/chafa>`_ is installed, the program will display new thumbnails of a game, with gray border for images already in use and with green border for new images. Chafa works better with a recent release and on a `sixel <https://en.wikipedia.org/wiki/Sixel>`_ or `kitty <https://sw.kovidgoyal.net/kitty/graphics-protocol/>`_ compatible shell.\n\nExample:\n | ``libretro-fuzz --system 'Commodore - Amiga' --before '_'``\n | then\n | ``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_'``\n \n The Retroplay WHDLoad set has labels like ``MonkeyIsland2_v1.3_0020`` after a manual scan. These labels *often* don't have subtitles (but not always) and all the metadata is not separated from the name by brackets. Select the playlist that contains those whdloads to download from the libretro amiga thumbnails.\n\nNote that the system name you download from doesn't have to be the same as the playlist name.\n\nIf the thumbnail server contains games from multiple releases for the system (like ``ScummVM``), be careful using extra options since it is easy to end up with 'slightly wrong' covers.\n\nExample:\n ``libretro-fuzz --no-meta --no-merge``\n \n After downloading ``ScummVM`` thumbnails (and not before, to minimize false positives), we'd like to try to pickup a few covers from ``DOS`` thumbnails and skip download if there a risk of mixing thumbnails from ``DOS`` and ``ScummVM`` for a single game.\n Choose the ScummVM playlist and DOS system name, and covers would be downloaded with risk of false positives: CD vs floppy covers, USA vs Japan covers, or another platform vs DOS.\n\nBecause of this increased risk of false positives with options, the default is to count everything except hack metadata as part of the match, only select the names that match exactly (after 'safe' heuristics like removing spaces) and the default pre-selected system name to be the same as the playlist name, which is safest.\n\nFalse positives will then be from using ``--score`` (allows inexact matches) or/and one of the commands that do not count metadata (``--before``, ``--no-meta`` and ``--no-subtitle``). A common scenario is the thumbnail server not having a single thumbnail of the game, and the program selecting the best match it can which is still good enough to pass, like a sequel, prequel, or different release, most often regions/languages. It's not recommended to use ``--score`` less than 100 without ``--filter`` to a specific game.\n\nExample:\n  ``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_' --filter '[Ii]shar*'``\n  \n  The best way to solve these issues is to upload the right cover to the respective libretro-thumbnail subproject with the correct name of the game variant. Then you can redownload just the updated thumbnails with a label, in this example, because of ``--filter``, the Ishar series in the WHDLoad playlist would redownload.\n\nlibretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]\n  :CFG:                 Path to the retroarch cfg file. If not default, asked from the user.\n  \n                        Linux default:   ``~/.config/retroarch/retroarch.cfg``\n  \n                        Windows default: ``%APPDATA%/RetroArch/retroarch.cfg``\n  \n                        MacOS default:   ``~/Library/Application Support/RetroArch/config/retroarch.cfg``\n  \n  --playlist <NAME libretro-fuzz only>\n                        Playlist name with labels used for thumbnail fuzzy matching. If not provided, asked from the user.\n  --system <NAME libretro-fuzz only>\n                        Directory name in the server to download thumbnails. If not provided, asked from the user.\n  --delay-after FLOAT   | Seconds after download to skip replacing thumbnails, enter continues. No-op with ``--no-image``.\n                        | [1<=x<=30]\n  --delay FLOAT         | Seconds to skip thumbnails download, enter continues.\n                        | [1<=x<=30]\n  --filter GLOB         Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.\n  --score FUZZ          | Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with ``--no-fail``.\n                        | [default: 200; 0<=x<=200]\n  --no-fail             Download any score. Equivalent to ``--score 0``.\n  --no-image            Don't show images even with chafa installed.\n  --no-merge            Disables missing thumbnails download for a label if there is at least one in cache to avoid mixing thumbnails from different server directories on repeated calls. No-op with ``--filter``.\n  --no-subtitle         Ignores text after last ``' - '`` or ``': '``. ``':'`` can't occur in server names, so if the server has ``'Name_subtitle.png'`` and not ``'Name - subtitle.png'`` (uncommon), this option doesn't help.\n  --no-meta             Ignores () delimited metadata and may cause false positives. Forced with ``--before``.\n  --hack                Matches [] delimited metadata and may cause false positives, Best used if the hack has thumbnails. Ignored with ``--before``.\n  --before TEXT         Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.\n  --address URL         | URL with libretro-thumbnails server. For local files, git clone/unzip packs, run ``'python3 -m http.server'`` in parent dir, and use ``--address 'http://localhost:8000'``.\n                        | [default: https://thumbnails.libretro.com]\n  --verbose             Shows the failures, score and normalized local and server names in output.\n  --install-completion  Install completion for the current shell.\n  --show-completion     Show completion for the current shell, to copy it or customize the installation.\n  --help                Show this message and exit.\n\n\n\nTo install the program, type on the cmd line\n\n+----------------+---------------------------------------------------------------------------------------------+\n| Latest release | ``pip install --force-reinstall libretrofuzz``                                              |\n+----------------+---------------------------------------------------------------------------------------------+\n| Current code   | ``pip install --force-reinstall https://github.com/i30817/libretrofuzz/archive/master.zip`` |\n+----------------+---------------------------------------------------------------------------------------------+\n\nIn windows, you'll want to check the option to “Add Python to PATH” when installing python, to be able to install and execute the script from any path of the cmd line.\n",
+    'long_description': "**Fuzzy Retroarch thumbnail downloader**\n========================================\n\nIn Retroarch, when you use the manual scanner to get nonstandard games or hacks in playlists, thumbnails often fail to download.\n\nThese programs, for each game label on a playlist, download the most similar named image to display in retroarch.\n\nThere are several options to fit unusual labels and increase fuzziness, but you can just run them to get the most restrictive default (with the least fuzz).\n\nIf you use ``libretro-fuzz``, it will download for a single playlist by asking for the playlist and system if they're not provided.\nIf you use ``libretro-fuzzall``, it will download for all playlists with standard libretro names, and will skip custom playlists.\n\nBesides those differences, if no retroarch.cfg is provided, both programs try to use the default retroarch.cfg.\n\nIf `chafa <https://github.com/hpjansson/chafa>`_ is installed, the program will display new thumbnails of a game, with gray border for images already in use and with green border for new images. Chafa works better with a recent release and on a `sixel <https://en.wikipedia.org/wiki/Sixel>`_ or `kitty <https://sw.kovidgoyal.net/kitty/graphics-protocol/>`_ compatible shell.\n\nExample:\n | ``libretro-fuzz --system 'Commodore - Amiga' --before '_'``\n | then\n | ``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_'``\n \n The Retroplay WHDLoad set has labels like ``MonkeyIsland2_v1.3_0020`` after a manual scan. These labels *often* don't have subtitles (but not always) and all the metadata is not separated from the name by brackets. Select the playlist that contains those whdloads to download from the libretro amiga thumbnails.\n\nNote that the system name you download from doesn't have to be the same as the playlist name.\n\nIf the thumbnail server contains games from multiple releases for the system (like ``ScummVM``), be careful using extra options since it is easy to end up with 'slightly wrong' covers.\n\nExample:\n ``libretro-fuzz --no-meta --no-merge``\n \n After downloading ``ScummVM`` thumbnails (and not before, to minimize false positives), we'd like to try to pickup a few covers from ``DOS`` thumbnails and skip download if there a risk of mixing thumbnails from ``DOS`` and ``ScummVM`` for a single game.\n Choose the ScummVM playlist and DOS system name, and covers would be downloaded with risk of false positives: CD vs floppy covers, USA vs Japan covers, or another platform vs DOS.\n\nBecause of this increased risk of false positives with options, the default is to count everything except hack metadata as part of the match, only select the names that match exactly (after 'safe' heuristics like removing spaces) and the default pre-selected system name to be the same as the playlist name, which is safest.\n\nFalse positives will then be from using ``--score`` (allows inexact matches) or/and one of the commands that do not count metadata (``--before``, ``--no-meta`` and ``--no-subtitle``). A common scenario is the thumbnail server not having a single thumbnail of the game, and the program selecting the best match it can which is still good enough to pass, like a sequel, prequel, or different release, most often regions/languages. It's not recommended to use ``--score`` less than 100 without ``--filter`` to a specific game.\n\nExample:\n  ``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_' --filter '[Ii]shar*'``\n  \n  The best way to solve these issues is to upload the right cover to the respective libretro-thumbnail subproject with the correct name of the game variant. Then you can redownload just the updated thumbnails with a label, in this example, because of ``--filter``, the Ishar series in the WHDLoad playlist would redownload.\n\nlibretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]\n  :CFG:                 Path to the retroarch cfg file. If not default, asked from the user.\n  \n                        Linux default:   ``~/.config/retroarch/retroarch.cfg``\n  \n                        Windows default: ``%APPDATA%/RetroArch/retroarch.cfg``\n  \n                        MacOS default:   ``~/Library/Application Support/RetroArch/config/retroarch.cfg``\n  \n  --playlist <NAME libretro-fuzz only>\n                        Playlist name with labels used for thumbnail fuzzy matching. If not provided, asked from the user.\n  --system <NAME libretro-fuzz only>\n                        Directory name in the server to download thumbnails. If not provided, asked from the user.\n  --delay-after FLOAT   | Seconds after download to skip replacing thumbnails, enter continues. No-op with ``--no-image``.\n                        | [1<=x<=30]\n  --delay FLOAT         | Seconds to skip thumbnails download, enter continues.\n                        | [1<=x<=30]\n  --filter GLOB         Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.\n  --min SCORE           | 0=any, 100=fuzzy match, 200=equal mininames,default. No-op with ``--no-fail``.\n                        | [default: 200; 0<=x<=200]\n  --no-fail             Download any score. Equivalent to ``--score 0``.\n  --no-image            Don't show images even with chafa installed.\n  --no-merge            Disables missing thumbnails download for a label if there is at least one in cache to avoid mixing thumbnails from different server directories on repeated calls. No-op with ``--filter``.\n  --no-subtitle         Ignores text after last ``' - '`` or ``': '``. ``':'`` can't occur in server names, so if the server has ``'Name_subtitle.png'`` and not ``'Name - subtitle.png'`` (uncommon), this option doesn't help.\n  --no-meta             Ignores () delimited metadata and may cause false positives. Forced with ``--before``.\n  --hack                Matches [] delimited metadata and may cause false positives, Best used if the hack has thumbnails. Ignored with ``--before``.\n  --before TEXT         Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.\n  --address URL         | URL with libretro-thumbnails server. For local files, git clone/unzip packs, run ``'python3 -m http.server'`` in parent dir, and use ``--address 'http://localhost:8000'``.\n                        | [default: https://thumbnails.libretro.com]\n  --verbose N           | Show mininame, len N list (maxscore, server mininame).\n                        | [x>=1]\n  --install-completion  Install completion for the current shell.\n  --show-completion     Show completion for the current shell, to copy it or customize the installation.\n  --help                Show this message and exit.\n\n\n\nTo install the program, type on the cmd line\n\n+----------------+---------------------------------------------------------------------------------------------+\n| Latest release | ``pip install --force-reinstall libretrofuzz``                                              |\n+----------------+---------------------------------------------------------------------------------------------+\n| Current code   | ``pip install --force-reinstall https://github.com/i30817/libretrofuzz/archive/master.zip`` |\n+----------------+---------------------------------------------------------------------------------------------+\n\nIn windows, you'll want to check the option to “Add Python to PATH” when installing python, to be able to install and execute the script from any path of the cmd line.\n",
     'author': 'i30817',
     'author_email': 'i30817@gmail.com',
     'maintainer': None,

libretrofuzz-2.9.2/libretrofuzz/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.9.2'