set request parameters via function

Using a function instead of a parameter in __init__ is easier
to handle and makes it simple to detect if the new functionality
is available.

Author: lonvia

src/osmium/replication/server.py

@@ -37,25 +37,14 @@ class ReplicationServer:
         replication service serves something other than osc.gz files, set
         the `diff_type` to the given file suffix.
 
-        `extra_parameters` may be used to define additional parameters to be
-        handed to the `requests.get()` method when downloading files. This
-        may be used to set custom headers, timeouts and similar parameters.
-        See the `requests documentation <https://requests.readthedocs.io/en/latest/api/?highlight=get#requests.request>`_
-        for possible parameters. The default is to set a timeout of 60 sec
-        and enable streaming download.
-
         ReplicationServer may be used as a context manager. In this case, it
         internally keeps a connection to the server making downloads faster.
     """
 
-    def __init__(self, url: str, diff_type: str = 'osc.gz',
-                 extra_request_params: Optional[Mapping[str, Any]] = None) -> None:
+    def __init__(self, url: str, diff_type: str = 'osc.gz') -> None:
         self.baseurl = url
         self.diff_type = diff_type
-        if extra_request_params is None:
-            self.extra_request_params = dict(timeout=60, stream=True)
-        else:
-            self.extra_request_params = extra_request_params
+        self.extra_request_params: Mapping[str, Any] = dict(timeout=60, stream=True)
         self.session: Optional[requests.Session] = None
 
     def close(self) -> None:
@@ -72,6 +61,16 @@ def __enter__(self) -> 'ReplicationServer':
     def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
         self.close()
 
+    def set_request_parameter(self, key: str, value: Any) -> None:
+        """ Set a parameter which will be handed to the requests library
+            when calling `requests.get()`. This
+            may be used to set custom headers, timeouts and similar parameters.
+            See the `requests documentation <https://requests.readthedocs.io/en/latest/api/?highlight=get#requests.request>`_
+            for possible parameters. Per default, a timeout of 60 sec is set
+            and streaming download enabled.
+        """
+        self.extra_request_params[key] = value
+
     def make_request(self, url: str) -> urlrequest.Request:
         headers = {"User-Agent" : f"pyosmium/{version.pyosmium_release}"}
         return urlrequest.Request(url, headers=headers)

tools/pyosmium-get-changes

@@ -27,7 +27,7 @@ cookies to the server and will save received cookies to the jar file.
 
 from argparse import ArgumentParser, RawDescriptionHelpFormatter, ArgumentTypeError
 import datetime as dt
-import http.cookiejar as cookiejarlib
+import http.cookiejar
 
 from osmium.replication import server as rserv
 from osmium.replication import newest_change_from_file
@@ -207,15 +207,14 @@ def main(args):
             or 'https://planet.osm.org/replication/minute/'
     logging.info("Using replication server at %s" % url)
 
-    extra_request_params = dict(stream=True,
-                                timeout=options.socket_timeout or None)
+    with rserv.ReplicationServer(url) as svr:
+        svr.set_request_parameter('timeout', options.socket_timeout or None)
 
-    if options.cookie is not None:
-        cookie_jar = cookiejarlib.MozillaCookieJar(options.cookie)
-        cookie_jar.load(options.cookie)
-        extra_request_params['cookies'] = cookie_jar
+        if options.cookie is not None:
+            cookie_jar = http.cookiejar.MozillaCookieJar(options.cookie)
+            cookie_jar.load(options.cookie)
+            svr.set_request_parameter('cookies', cookie_jar)
 
-    with rserv.ReplicationServer(url, extra_request_params=extra_request_params) as svr:
         startseq = options.start.get_sequence(svr)
         if startseq is None:
             log.error("Cannot read state file from server. Is the URL correct?")

tools/pyosmium-up-to-date

@@ -61,16 +61,15 @@ def update_from_osm_server(ts, options):
 
 def update_from_custom_server(url, seq, ts, options):
     """Update from a custom URL, simply using the diff sequence as is."""
-    extra_request_params = dict(stream=True,
-                                timeout=options.socket_timeout or None)
+    with rserv.ReplicationServer(url, "osc.gz") as svr:
+        log.info("Using replication service at %s", url)
 
-    if options.cookie is not None:
-        cookie_jar = http.cookiejar.MozillaCookieJar(options.cookie)
-        cookie_jar.load(options.cookie)
-        extra_request_params['cookies'] = cookie_jar
+        svr.set_request_parameter('timeout', options.socket_timeout or None)
 
-    with rserv.ReplicationServer(url, "osc.gz", extra_request_params=extra_request_params) as svr:
-        log.info("Using replication service at %s", url)
+        if options.cookie is not None:
+            cookie_jar = http.cookiejar.MozillaCookieJar(options.cookie)
+            cookie_jar.load(options.cookie)
+            svr.set_request_parameter('cookies', cookie_jar)
 
         current = svr.get_state_info()
         if current is None: