Use apeye for caching and API access.

Author: domdfcoding

.isort.cfg

@@ -13,6 +13,7 @@ use_parentheses = True
 remove_redundant_aliases = True
 default_section = THIRDPARTY
 known_third_party =
+    apeye
     appdirs
     beautifulsoup4
     coverage

requirements.txt

@@ -1,7 +1,7 @@
+apeye
 appdirs>=1.4.4
 domdf_python_tools>=0.4.10
 importlib_resources
 packaging>=20.4
 requests>=2.24.0
-slumber>=0.7.1
 sphinx>=3.0.3

seed_intersphinx_mapping/cache.py

@@ -26,117 +26,9 @@
 #  OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-# stdlib
-import inspect
-import json
-import shutil
-import warnings
-from functools import wraps
-from typing import Any, Callable, Dict, Iterable, Optional
-
 # 3rd party
-from appdirs import user_cache_dir
-from domdf_python_tools.paths import PathPlus
-from domdf_python_tools.utils import posargs2kwargs
-
-__all__ = ["Cache"]
-
-
-class Cache:
-
-	def __init__(self, app_name: str):
-		self.app_name: str = str(app_name)
-		self.cache_dir = PathPlus(user_cache_dir(f"{self.app_name}_cache"))
-		self.cache_dir.maybe_make(parents=True)
-
-		# Mapping of function names to their caches
-		self.caches: Dict[str, Dict[str, Any]] = {}
-
-	def clear(self, func: Optional[Callable] = None) -> bool:
-		"""
-		Clear the cache.
-
-		:param func: Optional function to clear the cache for.
-			By default, the whole cache is cleared.
-		:no-default func:
-
-		:returns: True to indicate success. False otherwise.
-		"""
-
-		try:
-			if func is None:
-				shutil.rmtree(self.cache_dir)
-				self.cache_dir.maybe_make()
-				for function in self.caches:
-					del self.caches[function]
-					self.caches[function] = {}
-			else:
-				function_name = func.__name__
-				cache_file = self.cache_dir / f"{function_name}.json"
-				if cache_file.is_file():
-					cache_file.unlink()
-
-				if function_name in self.caches:
-					del self.caches[function_name]
-				self.caches[function_name] = {}
-
-			return True
-
-		except Exception as e:  # pragma: no cover
-			warnings.warn(f"Could not remove cache. The error was: {e}")
-			return False
-
-	def load_cache(self, func: Callable) -> None:
-		"""
-		Loads the cache for the given function
-
-		:param func:
-		"""
-
-		cache_file: PathPlus = self.cache_dir / f"{func.__name__}.json"
-
-		if cache_file.is_file():
-			cache = json.loads(cache_file.read_text())
-		else:
-			cache = {}
-
-		self.caches[func.__name__] = cache
-		return cache
-
-	def __call__(self, func: Callable):
-		"""
-		Decorator to cache the return values of a function based on its inputs.
-
-		:param func:
-		"""
-
-		function_name = func.__name__
-		posargs: Iterable[str] = inspect.getfullargspec(func).args
-		cache_file: PathPlus = self.cache_dir / f"{function_name}.json"
-		self.load_cache(func)
-
-		@wraps(func)
-		def wrapper(*args, **kwargs):
-			kwargs: Dict[str, Any] = posargs2kwargs(args, posargs, kwargs)  # type: ignore
-			key: str = json.dumps(kwargs)
-			response: Any
-
-			cache = self.caches[function_name]
-			if key in cache:
-				# Return cached response
-				response = json.loads(cache[key])
-			else:
-				response = func(**kwargs)
-
-				if response is not None:
-					# Don't cache None values.
-					cache[key] = json.dumps(response)
-
-			cache_file.write_text(json.dumps(cache))
-
-			return response
-
-		return wrapper
+from apeye.cache import Cache
 
+__all__ = ["cache"]
 
 cache = Cache("seed_intersphinx_mapping")

seed_intersphinx_mapping/core.py

@@ -35,16 +35,17 @@
 # 3rd party
 import importlib_resources
 import requests
-import slumber
+from apeye.url import SlumberURL
 from domdf_python_tools.typing import PathLike
 
 # this package
 from seed_intersphinx_mapping.cache import cache
 from seed_intersphinx_mapping.requirements_parsers import parse_requirements_txt
 
-__all__ = ["search_dict", "get_sphinx_doc_url", "fallback_mapping", "seed_intersphinx_mapping"]
+__all__ = ["search_dict", "get_sphinx_doc_url", "fallback_mapping", "seed_intersphinx_mapping", "pypi_api"]
 
-pypi_simple = slumber.API("https://pypi.org/pypi/")
+#: :class:`apeye.url.SlumberURL` for the PyPI REST API endpoint.
+pypi_api = SlumberURL("https://pypi.org/pypi/")
 
 
 def search_dict(dictionary: Dict[str, Any], regex: Union[str, Pattern]) -> Dict[str, Any]:
@@ -86,7 +87,7 @@ def get_sphinx_doc_url(pypi_name: str) -> str:
 		| :exc:`slumber.exceptions.HttpNotFoundError` if the project could not be found on PyPI.
 	"""
 
-	pypi_data = getattr(pypi_simple, pypi_name).json.get()
+	pypi_data = (pypi_api / pypi_name / "json").get()
 
 	if "project_urls" in pypi_data["info"]:
 		docs_dict = search_dict(pypi_data["info"]["project_urls"], r"^[dD]oc(s|umentation)")

tests/test_cache.py

@@ -150,7 +150,7 @@ commands =
 
 [flake8]
 max-line-length = 120
-select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 W292 E265 E101 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 SXL001  PT001 PT002 PT003 PT004 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q000 Q001 Q002 Q003 A001 A002 A003 TYP001 TYP002 TYP003 TYP004 TYP005 TYP006 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
+select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 W292 E265 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 SXL001  PT001 PT002 PT003 PT004 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q000 Q001 Q002 Q003 A001 A002 A003 TYP001 TYP002 TYP003 TYP004 TYP005 TYP006 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
 exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py
 rst-roles =
     class