Changed how cache is cleared as previous approach didn't cache anything.

Author: domdfcoding

seed_intersphinx_mapping/__main__.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+#
+#  __main__.py
+"""
+CLI entry point for seed_intersphinx_mapping.
+"""
+#
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+#  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+#  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+#  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+#  OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__all__ = ["clear_cache"]
+
+# stdlib
+import sys
+
+# this package
+from seed_intersphinx_mapping import cache, get_sphinx_doc_url
+
+
+def clear_cache():
+	"""
+	Clear any cached URLs.
+	"""
+
+	if cache.clear(get_sphinx_doc_url):
+		print("Cache cleared successfully.")
+		return 0
+	else:
+		return 1
+
+
+if __name__ == "__main__":
+	sys.exit(clear_cache())

seed_intersphinx_mapping/core.py

@@ -71,14 +71,13 @@ def get_sphinx_doc_url(pypi_name: str) -> str:
 	Not all projects include this URl in their distributions and therefore it may not be possible to determine it from PyPI.
 
 	Responses are cached to prevent overloading the PyPI server.
-	If using the Sphinx extension the cache is cleared whenever a document is rebuilt.
-	It can also be cleared manually as follows:
+	The cache can be cleared as follows:
 
-	.. code-block:: python
+	.. prompt:: bash
 
-		>>> from seed_intersphinx_mapping import cache, get_sphinx_doc_url
-		>>> cache.clear(get_sphinx_doc_url)
-		True
+		python3 -m seed_intersphinx_mapping
+
+	.. TODO:: automatic cache clearing
 
 	:param pypi_name: The name of the project on PyPI
 

seed_intersphinx_mapping/extension.py

@@ -69,17 +69,6 @@ def sphinx_seed_intersphinx_mapping(app: Sphinx, config: Config) -> None:
 	# input(">")
 
 
-def sphinx_purge_cache(app: Sphinx, env: BuildEnvironment, docname):
-	"""
-	Clear any cached URLs.
-
-	:param app: The sphinx application.
-	:param env: The sphinx build environment.
-	"""
-
-	cache.clear(get_sphinx_doc_url)
-
-
 def setup(app: Sphinx) -> Dict[str, Any]:
 	"""
 	Setup Sphinx Extension.
@@ -100,9 +89,6 @@ def setup(app: Sphinx) -> Dict[str, Any]:
 
 	app.connect("config-inited", sphinx_seed_intersphinx_mapping, priority=850)
 
-	# Clear Cache
-	app.connect("env-purge-doc", sphinx_purge_cache)
-
 	return {
 			"version": __version__,
 			"parallel_read_safe": True,