Wikipedia-API 0.15.0__tar.gz → 0.16.0__tar.gz

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/CHANGES.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.16.0
+----------
+
+* Allow passing a custom ``transport`` to the underlying ``httpx`` client (e.g. a caching transport such as Hishel) - `PR 659`_
+
+.. _PR 659: https://github.com/martin-majlis/Wikipedia-API/pull/659
+
 0.15.0
 ----------
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/DESIGN.rst

@@ -317,6 +317,8 @@ SyncHTTPClient
 Provides a blocking ``_get(language, params) -> dict`` method in ``sync_http_client.py`` backed by
 ``httpx.Client``.  Retry logic uses ``tenacity`` with exponential
 backoff; ``Retry-After`` headers are honoured for HTTP 429 responses.
+The client defaults to ``httpx.HTTPTransport`` but honours a caller-supplied
+``transport`` kwarg (e.g. a caching transport).
 
 AsyncHTTPClient
 ~~~~~~~~~~~~~~~
@@ -324,6 +326,8 @@ AsyncHTTPClient
 Provides an ``async def _get(language, params) -> dict`` coroutine in ``async_http_client.py``
 backed by ``httpx.AsyncClient``.  Retry logic mirrors
 ``SyncHTTPClient`` but uses ``tenacity``'s ``AsyncRetrying``.
+The client defaults to ``httpx.AsyncHTTPTransport`` but honours a caller-supplied
+``transport`` kwarg.
 
 Both clients construct the endpoint URL as::
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: Wikipedia-API
-Version: 0.15.0
+Version: 0.16.0
 Summary: Python Wrapper for Wikipedia
 Project-URL: Homepage, https://github.com/martin-majlis/Wikipedia-API
 Project-URL: Repository, https://github.com/martin-majlis/Wikipedia-API
@@ -26,7 +26,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Communications :: Email
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: click==8.4.1
+Requires-Dist: click==8.5.0
 Requires-Dist: httpx==0.28.1
 Requires-Dist: tenacity==9.1.4
 Description-Content-Type: text/x-rst
@@ -1045,6 +1045,31 @@ The same options apply to both ``Wikipedia`` and ``AsyncWikipedia``.
         max_retries=0,
     )
 
+Custom HTTP Transport
+~~~~~~~~~~~~~~~~~~~~~~
+
+Any keyword argument that is not recognised by ``Wikipedia`` / ``AsyncWikipedia`` is
+forwarded to the underlying ``httpx`` client. This includes ``transport``, which lets you
+plug in a custom transport such as a caching transport
+(e.g. `Hishel <https://hishel.com/httpx.html>`_). When ``transport`` is omitted, the default
+``httpx.HTTPTransport`` (sync) / ``httpx.AsyncHTTPTransport`` (async) is used.
+
+.. code-block:: python
+
+    import hishel
+    import httpx
+    import wikipediaapi
+
+    # Cache responses so repeated lookups avoid hitting Wikipedia again
+    wiki_wiki = wikipediaapi.Wikipedia(
+        user_agent='MyProjectName (merlin@example.com)',
+        language='en',
+        transport=hishel.CacheTransport(transport=httpx.HTTPTransport()),
+    )
+
+For ``AsyncWikipedia`` use an async transport (e.g.
+``hishel.AsyncCacheTransport(transport=httpx.AsyncHTTPTransport())``).
+
 How To See Underlying API Call
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/README.rst

@@ -1012,6 +1012,31 @@ The same options apply to both ``Wikipedia`` and ``AsyncWikipedia``.
         max_retries=0,
     )
 
+Custom HTTP Transport
+~~~~~~~~~~~~~~~~~~~~~~
+
+Any keyword argument that is not recognised by ``Wikipedia`` / ``AsyncWikipedia`` is
+forwarded to the underlying ``httpx`` client. This includes ``transport``, which lets you
+plug in a custom transport such as a caching transport
+(e.g. `Hishel <https://hishel.com/httpx.html>`_). When ``transport`` is omitted, the default
+``httpx.HTTPTransport`` (sync) / ``httpx.AsyncHTTPTransport`` (async) is used.
+
+.. code-block:: python
+
+    import hishel
+    import httpx
+    import wikipediaapi
+
+    # Cache responses so repeated lookups avoid hitting Wikipedia again
+    wiki_wiki = wikipediaapi.Wikipedia(
+        user_agent='MyProjectName (merlin@example.com)',
+        language='en',
+        transport=hishel.CacheTransport(transport=httpx.HTTPTransport()),
+    )
+
+For ``AsyncWikipedia`` use an async transport (e.g.
+``hishel.AsyncCacheTransport(transport=httpx.AsyncHTTPTransport())``).
+
 How To See Underlying API Call
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/README_processed.rst

@@ -1012,6 +1012,31 @@ The same options apply to both ``Wikipedia`` and ``AsyncWikipedia``.
         max_retries=0,
     )
 
+Custom HTTP Transport
+~~~~~~~~~~~~~~~~~~~~~~
+
+Any keyword argument that is not recognised by ``Wikipedia`` / ``AsyncWikipedia`` is
+forwarded to the underlying ``httpx`` client. This includes ``transport``, which lets you
+plug in a custom transport such as a caching transport
+(e.g. `Hishel <https://hishel.com/httpx.html>`_). When ``transport`` is omitted, the default
+``httpx.HTTPTransport`` (sync) / ``httpx.AsyncHTTPTransport`` (async) is used.
+
+.. code-block:: python
+
+    import hishel
+    import httpx
+    import wikipediaapi
+
+    # Cache responses so repeated lookups avoid hitting Wikipedia again
+    wiki_wiki = wikipediaapi.Wikipedia(
+        user_agent='MyProjectName (merlin@example.com)',
+        language='en',
+        transport=hishel.CacheTransport(transport=httpx.HTTPTransport()),
+    )
+
+For ``AsyncWikipedia`` use an async transport (e.g.
+``hishel.AsyncCacheTransport(transport=httpx.AsyncHTTPTransport())``).
+
 How To See Underlying API Call
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "Wikipedia-API"
-version = "0.15.0"
+version = "0.16.0"
 description = "Python Wrapper for Wikipedia"
 readme = {file = "README_processed.rst", content-type = "text/x-rst"}
 license = {text = "MIT"}
@@ -32,29 +32,28 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "click==8.4.1",
+    "click==8.5.0",
     "httpx==0.28.1",
     "tenacity==9.1.4",
 ]
 
 [dependency-groups]
 dev = [
-    "coverage==7.14.0",
-    "ruff>=0.11.0",
+    "coverage==7.14.3",
+    "ruff==0.16.5",
     "ty==0.0.27",
     "pre-commit==4.6.0",
-    "pygments==2.20.0",
+    "pygments==2.21.0",
     "pyupgrade==3.21.2",
-    "pytest==9.0.3",
-    "pytest-asyncio==1.3.0",
+    "pytest==9.1.1",
+    "pytest-asyncio==1.4.0",
     "pytest-cov==7.1.0",
-    "tox==4.54.0",
-    "anyio[trio]==4.13.0",
+    "tox==4.56.1",
+    "anyio[trio]==4.14.2",
     "respx==0.23.1",
     "types-setuptools==82.0.0.20260518",
-    "pytest-recording>=0.13.2",
-    "vcrpy>=6.0.0",
-    "ty>=0.0.27",
+    "pytest-recording==0.13.4",
+    "vcrpy==8.2.1",
 ]
 doc = [
     "sphinx==9.1.0; python_version >= '3.12'",
@@ -62,11 +61,11 @@ doc = [
 build = [
     "rst2html==2020.7.4",
     "setuptools==82.0.1",
-    "twine>=6.2.0",
-    "wheel==0.47.0",
+    "twine==7.0.0",
+    "wheel==0.48.0",
 ]
 testing = [
-    "anyio[trio]==4.13.0",
+    "anyio[trio]==4.14.2",
     "respx==0.23.1",
 ]
 

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_http_client/async_http_client.py

@@ -48,10 +48,12 @@ class AsyncHTTPClient(BaseHTTPClient):
             :class:`BaseHTTPClient`
         """
         super().__init__(*args, **kwargs)
+        # Use a caller-supplied transport (e.g. a caching transport such as
+        # Hishel) if one was passed; otherwise fall back to the default.
+        self._client_kwargs.setdefault("transport", httpx.AsyncHTTPTransport())
         self._client = httpx.AsyncClient(
             headers=self._default_headers,
             **self._client_kwargs,
-            transport=httpx.AsyncHTTPTransport(),
         )
 
     async def _do_get(self, url: str, params: dict[str, Any]) -> dict[str, Any]:

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_http_client/base_http_client.py

@@ -96,6 +96,10 @@ class BaseHTTPClient(ABC):
         :param kwargs: forwarded to ``httpx`` client constructor
             (e.g. ``timeout=30.0``, ``proxy={'https://': 'http://proxy.example.com:8080'}``,
             ``verify=False``, ``http2=True``); ``timeout`` defaults to ``10.0``.
+            A custom ``transport`` may also be supplied (e.g. a caching
+            transport such as `Hishel <https://hishel.com/httpx.html>`_); when
+            omitted, the default ``httpx.HTTPTransport`` /
+            ``httpx.AsyncHTTPTransport`` is used.
             **Advanced Usage**: These parameters provide direct access to httpx
             capabilities.  For standard Wikipedia API usage, prefer the
             documented parameters above.  Use httpx parameters only for

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_http_client/sync_http_client.py

@@ -46,10 +46,12 @@ class SyncHTTPClient(BaseHTTPClient):
             :class:`BaseHTTPClient`
         """
         super().__init__(*args, **kwargs)
+        # Use a caller-supplied transport (e.g. a caching transport such as
+        # Hishel) if one was passed; otherwise fall back to the default.
+        self._client_kwargs.setdefault("transport", httpx.HTTPTransport())
         self._client = httpx.Client(
             headers=self._default_headers,
             **self._client_kwargs,
-            transport=httpx.HTTPTransport(),
         )
 
     def _do_get(self, url: str, params: dict[str, Any]) -> dict[str, Any]:

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_version.py

@@ -1,4 +1,4 @@
 """Version information for Wikipedia-API."""
 
-__version__ = (0, 15, 0)
+__version__ = (0, 16, 0)
 __version_str__ = ".".join(str(s) for s in __version__)

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_wikipedia/async_wikipedia.py

@@ -66,7 +66,8 @@ class AsyncWikipedia(AsyncWikipediaResource, AsyncHTTPClient):
         ``1.0``.
     :param kwargs: additional keyword arguments forwarded to
         ``httpx.AsyncClient`` (e.g. ``timeout=30.0``, ``proxies={…}``,
-        ``verify=False``).  **Advanced Usage**: These provide direct
+        ``verify=False``, or a custom ``transport`` such as a caching
+        transport).  **Advanced Usage**: These provide direct
         access to httpx capabilities.  For most use cases, prefer the
         standard parameters above.  Use httpx parameters only for specific
         requirements like custom proxies, SSL configuration, or connection pooling.

{wikipedia_api-0.15.0 → wikipedia_api-0.16.0}/wikipediaapi/_wikipedia/wikipedia.py

@@ -58,7 +58,8 @@ class Wikipedia(WikipediaResource, SyncHTTPClient):
         ``1.0``.
     :param kwargs: additional keyword arguments forwarded to
         ``httpx.Client`` (e.g. ``timeout=30.0``, ``proxies={…}``,
-        ``verify=False``).  **Advanced Usage**: These provide direct
+        ``verify=False``, or a custom ``transport`` such as a caching
+        transport).  **Advanced Usage**: These provide direct
         access to httpx capabilities.  For most use cases, prefer the
         standard parameters above.  Use httpx parameters only for specific
         requirements like custom proxies, SSL configuration, or connection pooling.