comb-utils 0.5.2__tar.gz → 0.6.3__tar.gz

{comb_utils-0.5.2/src/comb_utils.egg-info → comb_utils-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comb_utils
-Version: 0.5.2
+Version: 0.6.3
 Summary: Handy utils for Python projects.
 Author: Kaleb Coberly
 Maintainer-email: kaleb.coberly@gmail.com
@@ -25,6 +25,7 @@ Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
 Provides-Extra: qc
 Requires-Dist: bandit; extra == "qc"
 Requires-Dist: black; extra == "qc"
+Requires-Dist: comb_utils[test]; extra == "qc"
 Requires-Dist: flake8; extra == "qc"
 Requires-Dist: flake8-annotations; extra == "qc"
 Requires-Dist: flake8-bandit; extra == "qc"
@@ -33,10 +34,10 @@ Requires-Dist: flake8-bugbear; extra == "qc"
 Requires-Dist: flake8-docstrings; extra == "qc"
 Requires-Dist: flake8-isort; extra == "qc"
 Requires-Dist: isort; extra == "qc"
-Requires-Dist: jake; extra == "qc"
-Requires-Dist: pytype; extra == "qc"
-Requires-Dist: comb_utils[test]; extra == "qc"
+Requires-Dist: mypy; extra == "qc"
+Requires-Dist: pip-audit; extra == "qc"
 Requires-Dist: safety; extra == "qc"
+Requires-Dist: types-requests; extra == "qc"
 Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: pytest; extra == "test"
@@ -136,6 +137,14 @@ When making smaller commits, you might just want to run some of the smaller comm
     $ make clean format full-qc full-test
 ```
 
+#### Type checking
+
+This project uses [mypy](https://mypy-lang.org) for type checking. Run it with:
+
+```bash
+    $ make typecheck
+```
+
 #### Using act
 
 As a final step, it's good practice to test run the workflow before opening a PR or pushing to an open PR. We don't want to waste GitHub runtime on a glitch that we could have caught before. You can use a make target for that:

{comb_utils-0.5.2 → comb_utils-0.6.3}/README.md

@@ -91,6 +91,14 @@ When making smaller commits, you might just want to run some of the smaller comm
     $ make clean format full-qc full-test
 ```
 
+#### Type checking
+
+This project uses [mypy](https://mypy-lang.org) for type checking. Run it with:
+
+```bash
+    $ make typecheck
+```
+
 #### Using act
 
 As a final step, it's good practice to test run the workflow before opening a PR or pushing to an open PR. We don't want to waste GitHub runtime on a glitch that we could have caught before. You can use a make target for that:

{comb_utils-0.5.2 → comb_utils-0.6.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = comb_utils
-version = 0.5.2
+version = 0.6.3
 description = Handy utils for Python projects.
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -20,6 +20,9 @@ install_requires =
 [options.packages.find]
 where = src
 
+[options.package_data]
+comb_utils = py.typed
+
 [options.extras_require]
 dev = 
 	comb_utils[build]
@@ -37,6 +40,7 @@ doc =
 qc = 
 	bandit
 	black
+	comb_utils[test]
 	flake8
 	flake8-annotations
 	flake8-bandit
@@ -45,10 +49,10 @@ qc =
 	flake8-docstrings
 	flake8-isort
 	isort
-	jake
-	pytype
-	comb_utils[test]
+	mypy
+	pip-audit
 	safety
+	types-requests
 test = 
 	coverage[toml]
 	pytest

{comb_utils-0.5.2 → comb_utils-0.6.3}/src/comb_utils/lib/api_callers.py

@@ -1,8 +1,8 @@
 """Classes for making API calls."""
 
 import logging
-from abc import abstractmethod
-from collections.abc import Callable
+from abc import ABC, abstractmethod
+from collections.abc import Callable as _Callable
 from time import sleep
 from typing import Any
 from urllib.parse import parse_qs, urlencode, urlparse, urlunparse
@@ -23,7 +23,7 @@ logger = logging.getLogger(__name__)
 # Why are we using _set_request_call instead of the _request_call property?
 
 
-class BaseCaller:
+class BaseCaller(ABC):
     """An abstract class for making API calls.
 
     See :doc:`api_callers`.
@@ -82,7 +82,7 @@ class BaseCaller:
 
     # Must set in child class with _set*:
     #: The requests call method. (get, post, etc.)
-    _request_call: Callable
+    _request_call: _Callable[..., requests.Response]
     #: The URL for the API call.
     _url: str
 
@@ -208,12 +208,12 @@ class BaseCaller:
             )
 
     @typechecked
-    def _get_API_key(self) -> str | None:
+    def _get_API_key(self) -> str:
         """Get the API key.
 
         Defaults to None, but can be overridden in child class.
         """
-        return None
+        return ""
 
     @typechecked
     def _handle_429(self) -> None:
@@ -394,8 +394,10 @@ class BasePagedResponseGetter(BaseGetCaller):
                     f"Duplicate entries found in query string: {duplicate_entries}"
                 )
 
-            query_params = {key: val[0] for key, val in query_params.items()}
-            updated_query = urlencode(query_params)
+            query_params_flat: dict[str, str] = {
+                key: val[0] for key, val in query_params.items()
+            }
+            updated_query = urlencode(query_params_flat)
             self._page_url = urlunparse(parsed_url._replace(query=updated_query))
 
     @typechecked
@@ -455,7 +457,7 @@ def get_responses(
         A list of dictionaries containing the responses from all pages.
     """
     # Calling the token salsa to trick bandit into ignoring what looks like a hardcoded token.
-    next_page_salsa = ""
+    next_page_salsa: str | None = ""
     next_page_cookie = ""
     responses = []
 

{comb_utils-0.5.2 → comb_utils-0.6.3/src/comb_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comb_utils
-Version: 0.5.2
+Version: 0.6.3
 Summary: Handy utils for Python projects.
 Author: Kaleb Coberly
 Maintainer-email: kaleb.coberly@gmail.com
@@ -25,6 +25,7 @@ Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
 Provides-Extra: qc
 Requires-Dist: bandit; extra == "qc"
 Requires-Dist: black; extra == "qc"
+Requires-Dist: comb_utils[test]; extra == "qc"
 Requires-Dist: flake8; extra == "qc"
 Requires-Dist: flake8-annotations; extra == "qc"
 Requires-Dist: flake8-bandit; extra == "qc"
@@ -33,10 +34,10 @@ Requires-Dist: flake8-bugbear; extra == "qc"
 Requires-Dist: flake8-docstrings; extra == "qc"
 Requires-Dist: flake8-isort; extra == "qc"
 Requires-Dist: isort; extra == "qc"
-Requires-Dist: jake; extra == "qc"
-Requires-Dist: pytype; extra == "qc"
-Requires-Dist: comb_utils[test]; extra == "qc"
+Requires-Dist: mypy; extra == "qc"
+Requires-Dist: pip-audit; extra == "qc"
 Requires-Dist: safety; extra == "qc"
+Requires-Dist: types-requests; extra == "qc"
 Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: pytest; extra == "test"
@@ -136,6 +137,14 @@ When making smaller commits, you might just want to run some of the smaller comm
     $ make clean format full-qc full-test
 ```
 
+#### Type checking
+
+This project uses [mypy](https://mypy-lang.org) for type checking. Run it with:
+
+```bash
+    $ make typecheck
+```
+
 #### Using act
 
 As a final step, it's good practice to test run the workflow before opening a PR or pushing to an open PR. We don't want to waste GitHub runtime on a glitch that we could have caught before. You can use a make target for that:

{comb_utils-0.5.2 → comb_utils-0.6.3}/src/comb_utils.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 setup.cfg
 src/comb_utils/__init__.py
+src/comb_utils/py.typed
 src/comb_utils.egg-info/PKG-INFO
 src/comb_utils.egg-info/SOURCES.txt
 src/comb_utils.egg-info/dependency_links.txt

{comb_utils-0.5.2 → comb_utils-0.6.3}/src/comb_utils.egg-info/requires.txt

@@ -20,6 +20,7 @@ sphinx-autodoc-typehints
 [qc]
 bandit
 black
+comb_utils[test]
 flake8
 flake8-annotations
 flake8-bandit
@@ -28,10 +29,10 @@ flake8-bugbear
 flake8-docstrings
 flake8-isort
 isort
-jake
-pytype
-comb_utils[test]
+mypy
+pip-audit
 safety
+types-requests
 
 [test]
 coverage[toml]