From 129a3440e6a74fad3f73dca64d98a8306ff3e9da Mon Sep 17 00:00:00 2001
From: Joakim Soderlund <joakim.soderlund@gmail.com>
Date: Sun, 29 Oct 2023 16:18:52 +0100
Subject: [PATCH] Add type stubs for dependencies jmespath and tqdm

---
 fimfarchive/utils.py | 33 +++++++++++++++++++--------------
 requirements.txt     |  2 ++
 2 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/fimfarchive/utils.py b/fimfarchive/utils.py
index b533ab5..3138fb9 100644
--- a/fimfarchive/utils.py
+++ b/fimfarchive/utils.py
@@ -5,7 +5,7 @@ Various utilities.
 
 #
 # Fimfarchive, preserves stories from Fimfiction.
-# Copyright (C) 2015  Joakim Soderlund
+# Copyright (C) 2023  Joakim Soderlund
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -25,16 +25,15 @@ Various utilities.
 import json
 import os
 import shutil
-from functools import partial
 from importlib import import_module
 from importlib_resources import files
 from pathlib import Path
 from typing import (
-    cast, Any, Callable, Dict, Iterator,
+    cast, Any, Callable, Dict, Iterable, Iterator,
     Optional, Set, Tuple, Type, TypeVar, Union,
 )
 
-from tqdm import tqdm
+from tqdm import tqdm as _tqdm
 
 from fimfarchive.flavors import Flavor
 from fimfarchive.stories import Story
@@ -51,17 +50,9 @@ __all__ = (
 )
 
 
-F = TypeVar('F', bound=Flavor)
 ByteFunc = Callable[[bytes], bytes]
-
-
-tqdm = partial(
-    tqdm,
-    ascii=True,
-    leave=False,
-    smoothing=0,
-    ncols=72,
-)
+F = TypeVar('F', bound=Flavor)
+T = TypeVar('T')
 
 
 #
@@ -309,3 +300,17 @@ class ResourceLoader:
             return resource.read_bytes()
         else:
             return resource.read_text()
+
+
+def tqdm(iterable: Iterable[T], **kwargs) -> Iterable[T]:
+    """
+    Adds an ASCII progress bar to the iterable.
+    """
+    return _tqdm(
+        iterable,
+        ascii=True,
+        leave=False,
+        smoothing=0,
+        ncols=72,
+        **kwargs,
+    )
diff --git a/requirements.txt b/requirements.txt
index 4ad9359..bf4a00c 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -11,4 +11,6 @@ pytest
 requests
 requests-mock
 tqdm
+types-jmespath
 types-requests
+types-tqdm