Client.close()

CHANGELOG.md

@@ -4,6 +4,7 @@ v0.3.0 (in development)
   `Client` without having to use a custom `Session`
 - Added a `headers` argument to the `Client` constructor for setting arbitrary
   additional headers without having to use a custom `Session`
+- Gave `Client` a `close()` method
 
 v0.2.0 (2023-11-03)
 -------------------

README.rst

@@ -296,6 +296,16 @@ which case the elements of that list are yielded); otherwise, an error occurs.
 If ``raw`` is ``True``, then instead of yielding each page's items, the
 returned iterator will yield each page as a ``requests.Response`` object.
 
+.. code:: python
+
+    Client.close() -> None
+
+Close the client's internal ``requests.Session``.  No more request methods may
+be called afterwards.
+
+This method is called automatically on exit when using ``Client`` as a context
+manager.
+
 .. code:: python
 
     class Endpoint:

src/ghreq/__init__.py

@@ -212,7 +212,7 @@ def __exit__(
         _exc_val: BaseException | None,
         _exc_tb: TracebackType | None,
     ) -> None:
-        self.session.close()
+        self.close()
 
     def __truediv__(self, path: str) -> Endpoint:
         return Endpoint(self, joinurl(self.api_url, path))
@@ -514,6 +514,16 @@ def paginate(
             path = r.links.get("next", {}).get("url")
             params = None
 
+    def close(self) -> None:
+        """
+        Close the client's internal `requests.Session`.  No more request
+        methods may be called afterwards.
+
+        This method is called automatically on exit when using `Client` as a
+        context manager.
+        """
+        self.session.close()
+
 
 @dataclass
 class Endpoint: