Allow specifying the User-Agent when creating a GalaxyClient

galaxyproject · Jan 29, 2020 · 2920de8 · 2920de8
1 parent 8f61859
commit 2920de8
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/bioblend/galaxy/__init__.py b/bioblend/galaxy/__init__.py
@@ -11,7 +11,7 @@
 
 
 class GalaxyInstance(GalaxyClient):
-    def __init__(self, url, key=None, email=None, password=None, verify=True):
+    def __init__(self, url, key=None, email=None, password=None, verify=True, user_agent=None):
         """
         A base representation of a connection to a Galaxy instance, identified
         by the server URL and user credentials.
@@ -50,7 +50,7 @@ def __init__(self, url, key=None, email=None, password=None, verify=True):
         :param verify: Whether to verify the server's TLS certificate
         :type verify: bool
         """
-        super().__init__(url, key, email, password, verify=verify)
+        super().__init__(url, key, email, password, verify=verify, user_agent=user_agent)
         self.libraries = libraries.LibraryClient(self)
         self.histories = histories.HistoryClient(self)
         self.workflows = workflows.WorkflowClient(self)

diff --git a/bioblend/galaxyclient.py b/bioblend/galaxyclient.py
@@ -21,7 +21,7 @@
 
 class GalaxyClient(object):
 
-    def __init__(self, url, key=None, email=None, password=None, verify=True, timeout=None):
+    def __init__(self, url, key=None, email=None, password=None, verify=True, timeout=None, user_agent=None):
         """
         :param verify: Whether to verify the server's TLS certificate
         :type verify: bool
@@ -42,7 +42,12 @@ def __init__(self, url, key=None, email=None, password=None, verify=True, timeou
             self._key = None
             self.email = email
             self.password = password
+        self.user_agent = user_agent
         self.json_headers = {'Content-Type': 'application/json'}
+        self.non_json_headers = {}
+        if self.user_agent:
+            self.json_headers['User-Agent'] = self.user_agent
+            self.non_json_headers = {'User-Agent': self.user_agent}
         self.verify = verify
         self.timeout = timeout
 
@@ -70,6 +75,9 @@ def make_get_request(self, url, **kwargs):
         kwargs['params'] = params
         kwargs.setdefault('verify', self.verify)
         kwargs.setdefault('timeout', self.timeout)
+        if self.non_json_headers:
+            kwargs.setdefault('headers', {})
+            kwargs['headers'].update(self.non_json_headers)
         r = requests.get(url, **kwargs)
         return r
 

diff --git a/bioblend/toolshed/__init__.py b/bioblend/toolshed/__init__.py
@@ -6,7 +6,7 @@
 
 
 class ToolShedInstance(GalaxyClient):
-    def __init__(self, url, key=None, email=None, password=None, verify=True):
+    def __init__(self, url, key=None, email=None, password=None, verify=True, user_agent=None):
         """
         A base representation of a connection to a ToolShed instance, identified
         by the ToolShed URL and user credentials.
@@ -46,7 +46,7 @@ def __init__(self, url, key=None, email=None, password=None, verify=True):
         :param verify: Whether to verify the server's TLS certificate
         :type verify: bool
         """
-        super().__init__(url, key, email, password, verify=verify)
+        super().__init__(url, key, email, password, verify=verify, user_agent=user_agent)
         self.categories = categories.ToolShedCategoryClient(self)
         self.repositories = repositories.ToolShedRepositoryClient(self)
         self.tools = tools.ToolShedToolClient(self)