Merge pull request #2277 from jku/expose-default-fetcher

Expose default fetcher

Author: Lukas Pühringer

docs/api/tuf.ngclient.fetcher.rst

@@ -1,6 +1,9 @@
 Fetcher
 ============
 
-.. automodule:: tuf.ngclient.fetcher
+.. autoclass:: tuf.ngclient.FetcherInterface
    :undoc-members:
-   :private-members: _fetch
+   :private-members: _fetch
+
+.. autoclass:: tuf.ngclient.RequestsFetcher
+   :no-inherited-members:

tests/test_fetcher_ng.py

@@ -20,7 +20,7 @@
 
 from tests import utils
 from tuf.api import exceptions
-from tuf.ngclient._internal.requests_fetcher import RequestsFetcher
+from tuf.ngclient import RequestsFetcher
 
 logger = logging.getLogger(__name__)
 

tuf/ngclient/__init__.py

@@ -4,12 +4,18 @@
 """TUF client public API
 """
 
+
+# requests_fetcher is public but comes from _internal for now (because
+# sigstore-python 1.0 still uses the module from there). requests_fetcher
+# can be moved out of _internal once sigstore-python 1.0 is not relevant.
+from tuf.ngclient._internal.requests_fetcher import RequestsFetcher
 from tuf.ngclient.config import UpdaterConfig
 from tuf.ngclient.fetcher import FetcherInterface
 from tuf.ngclient.updater import Updater
 
 __all__ = [
     FetcherInterface.__name__,
+    RequestsFetcher.__name__,
     Updater.__name__,
     UpdaterConfig.__name__,
 ]

tuf/ngclient/_internal/requests_fetcher.py

@@ -5,6 +5,10 @@
   HTTP library.
 """
 
+# requests_fetcher is public but comes from _internal for now (because
+# sigstore-python 1.0 still uses the module from there). requests_fetcher
+# can be moved out of _internal once sigstore-python 1.0 is not relevant.
+
 import logging
 from typing import Dict, Iterator, Tuple
 from urllib import parse
@@ -24,8 +28,10 @@ class RequestsFetcher(FetcherInterface):
     """An implementation of ``FetcherInterface`` based on the requests library.
 
     Attributes:
-        _sessions: Dictionary of ``Requests.Session`` objects storing a separate
-            session per scheme+hostname combination.
+        socket_timeout: Timeout in seconds, used for both initial connection
+            delay and the maximum delay between bytes received. Default is
+            4 seconds.
+        chunk_size: Chunk size in bytes used when downloading.
     """
 
     def __init__(self) -> None: