codestyle

Author: sjanssen2

qiita_client/plugin.py

@@ -136,33 +136,44 @@ def __init__(self, name, description, can_be_submitted_to_ebi,
 
 
 class BaseQiitaPlugin(object):
-    _ALLOWED_PLUGIN_COUPLINGS = ['filesystem', 'https']  # default must be first element
-    def __init__(self, name, version, description, publications=None, plugincoupling=_ALLOWED_PLUGIN_COUPLINGS[0]):
+    # default must be first element
+    _ALLOWED_PLUGIN_COUPLINGS = ['filesystem', 'https']
+
+    def __init__(self, name, version, description, publications=None,
+                 plugincoupling=_ALLOWED_PLUGIN_COUPLINGS[0]):
         logger.debug('Entered BaseQiitaPlugin.__init__()')
         self.name = name
         self.version = version
         self.description = description
         self.publications = dumps(publications) if publications else ""
 
-        # Depending on your compute architecture, there are multiple options available how
-        # "thight" plugins are coupled to the central Qiita master/workers
+        # Depending on your compute architecture, there are multiple options
+        # available how "thight" plugins are coupled to the central
+        # Qiita master/workers
         # --- filesystem ---
-        # The default scenario is "filesystem", i.e. plugins as well as master/worker have
-        # unrestricted direct access to a shared filesystem, e.g. a larger volume / directory,
-        # defined in the server configuration as base_data_dir
+        # The default scenario is "filesystem", i.e. plugins as well as
+        # master/worker have unrestricted direct access to a shared filesystem,
+        # e.g. a larger volume / directory, defined in the server configuration
+        # as base_data_dir
         # --- https ---
-        # A second scenario is that your plugins execute as independent jobs on another machine,
-        # e.g. as docker containers or other cloud techniques. Intentionally, you don't want to
-        # use a shared filesystem, but you have to make sure necessary input files are 
-        # provided to the containerized plugin before execution and resulting files are
-        # transfered back to the central Qiita master/worker. In this case, files are
-        # pulled / pushed through functions qiita_client.fetch_file_from_central and
+        # A second scenario is that your plugins execute as independent jobs on
+        # another machine, e.g. as docker containers or other cloud techniques.
+        # Intentionally, you don't want to use a shared filesystem, but you
+        # have to make sure necessary input files are provided to the
+        # containerized plugin before execution and resulting files are
+        # transfered back to the central Qiita master/worker. In this case,
+        # files are pulled / pushed through functions
+        # qiita_client.fetch_file_from_central and
         # qiita_client.push_file_to_central, respectivey.
-        # Actually, all files need to be decorated with this function. The decision how
-        # data are transferred is then made within these two functions according to the
-        # "plugincoupling" setting.
+        # Actually, all files need to be decorated with this function.
+        # The decision how data are transferred is then made within these two
+        # functions according to the "plugincoupling" setting.
         if plugincoupling not in self._ALLOWED_PLUGIN_COUPLINGS:
-            raise ValueError("valid plugincoupling values are ['%s'], but you provided %s" % ("', '".join(self._ALLOWED_PLUGIN_COUPLINGS), plugincoupling))
+            raise ValueError(
+                ("valid plugincoupling values are ['%s'], but you "
+                 "provided %s") % (
+                     "', '".join(self._ALLOWED_PLUGIN_COUPLINGS),
+                     plugincoupling))
         self.plugincoupling = plugincoupling
 
         # Will hold the different commands
@@ -173,7 +184,8 @@ def __init__(self, name, version, description, publications=None, plugincoupling
             'QIITA_PLUGINS_DIR', join(expanduser('~'), '.qiita_plugins'))
         self.conf_fp = join(conf_dir, "%s_%s.conf" % (self.name, self.version))
 
-    def generate_config(self, env_script, start_script, server_cert=None, plugin_couling=_ALLOWED_PLUGIN_COUPLINGS[0]):
+    def generate_config(self, env_script, start_script, server_cert=None,
+                        plugin_couling=_ALLOWED_PLUGIN_COUPLINGS[0]):
         """Generates the plugin configuration file
 
         Parameters
@@ -188,7 +200,7 @@ def generate_config(self, env_script, start_script, server_cert=None, plugin_cou
             path to the Qiita certificate so the plugin can connect over
             HTTPS to it
         plugin_coupling : str
-            Type of coupling of plugin to central for file exchange. 
+            Type of coupling of plugin to central for file exchange.
             Valid values are 'filesystem' and 'https'.
         """
         logger.debug('Entered BaseQiitaPlugin.generate_config()')
@@ -214,7 +226,8 @@ def _register_command(self, command):
         command: QiitaCommand
             The command to be added to the plugin
         """
-        logger.debug('Entered BaseQiitaPlugin._register_command(%s)' % command.name)
+        logger.debug('Entered BaseQiitaPlugin._register_command(%s)' %
+                     command.name)
         self.task_dict[command.name] = command
 
     def _register(self, qclient):
@@ -277,7 +290,8 @@ def __call__(self, server_url, job_id, output_dir):
                               # from validating the server's cert using
                               # certifi's pem cache.
                               ca_cert=config.get('oauth2', 'SERVER_CERT'),
-                              plugincoupling=config.get('network', 'PLUGINCOUPLING'))
+                              plugincoupling=config.get('network',
+                                                        'PLUGINCOUPLING'))
 
         if job_id == 'register':
             self._register(qclient)

qiita_client/qiita_client.py

@@ -183,7 +183,8 @@ class QiitaClient(object):
     get
     post
     """
-    def __init__(self, server_url, client_id, client_secret, ca_cert=None, plugincoupling='filesystem'):
+    def __init__(self, server_url, client_id, client_secret, ca_cert=None,
+                 plugincoupling='filesystem'):
         self._server_url = server_url
         self._session = requests.Session()
 
@@ -367,7 +368,8 @@ def _request_retry(self, req, url, rettype='json', **kwargs):
         retries = MAX_RETRIES
         while retries > 0:
             retries -= 1
-            r = self._request_oauth2(req, rettype, url, verify=self._verify, **kwargs)
+            r = self._request_oauth2(
+                req, rettype, url, verify=self._verify, **kwargs)
             r.close()
             # There are some error codes that the specification says that they
             # shouldn't be retried
@@ -389,7 +391,10 @@ def _request_retry(self, req, url, rettype='json', **kwargs):
                         if rettype == 'content':
                             return r.content
                         else:
-                            raise ValueError("return type rettype='%s' cannot be understand. Choose from 'json' (default) or 'content!" % rettype)
+                            raise ValueError(
+                                ("return type rettype='%s' cannot be "
+                                 "understand. Choose from 'json' (default) "
+                                 "or 'content!") % rettype)
                 except ValueError:
                     return None
             stime = randint(MIN_TIME_SLEEP, MAX_TIME_SLEEP)
@@ -420,7 +425,8 @@ def get(self, url, rettype='json', **kwargs):
             The JSON response from the server
         """
         logger.debug('Entered QiitaClient.get()')
-        return self._request_retry(self._session.get, url, rettype=rettype, **kwargs)
+        return self._request_retry(
+            self._session.get, url, rettype=rettype, **kwargs)
 
     def post(self, url, **kwargs):
         """Execute a post request against the Qiita server
@@ -438,7 +444,8 @@ def post(self, url, **kwargs):
             The JSON response from the server
         """
         logger.debug('Entered QiitaClient.post(%s)' % url)
-        return self._request_retry(self._session.post, url, rettype='json', **kwargs)
+        return self._request_retry(
+            self._session.post, url, rettype='json', **kwargs)
 
     def patch(self, url, op, path, value=None, from_p=None, **kwargs):
         """Executes a JSON patch request against the Qiita server
@@ -497,7 +504,8 @@ def patch(self, url, op, path, value=None, from_p=None, **kwargs):
         # we made sure that data is correctly formatted here
         kwargs['data'] = data
 
-        return self._request_retry(self._session.patch, url, rettype='json', **kwargs)
+        return self._request_retry(
+            self._session.patch, url, rettype='json', **kwargs)
 
     # The functions are shortcuts for common functionality that all plugins
     # need to implement.
@@ -520,7 +528,8 @@ def http_patch(self, url, **kwargs):
             The JSON response from the server
         """
         logger.debug('Entered QiitaClient.http_patch()')
-        return self._request_retry(self._session.patch, url, rettype='json', **kwargs)
+        return self._request_retry(
+            self._session.patch, url, rettype='json', **kwargs)
 
     def start_heartbeat(self, job_id):
         """Create and start a thread that would send heartbeats to the server
@@ -741,7 +750,9 @@ def fetch_file_from_central(self, filepath):
             logger.debug('Requesting file %s from qiita server.' % filepath)
 
             # actual call to Qiita central to obtain file content
-            content = self.get('/cloud/fetch_file_from_central/' + filepath, rettype='content')
+            content = self.get(
+                '/cloud/fetch_file_from_central/' + filepath,
+                rettype='content')
 
             # create necessary directory locally
             os.makedirs(os.path.dirname(filepath), exist_ok=True)
@@ -752,7 +763,9 @@ def fetch_file_from_central(self, filepath):
 
             return filepath
 
-        raise ValueError("File communication protocol '%s' as defined in plugins configuration is NOT defined." % self._plugincoupling)
+        raise ValueError(
+            ("File communication protocol '%s' as defined in plugins "
+             "configuration is NOT defined.") % self._plugincoupling)
 
     def push_file_to_central(self, filepath):
         if self._plugincoupling == 'filesystem':
@@ -761,9 +774,12 @@ def push_file_to_central(self, filepath):
         if self._plugincoupling == 'https':
             logger.debug('Submitting file %s to qiita server.' % filepath)
 
-            self.post('/cloud/push_file_to_central/',
+            self.post(
+                '/cloud/push_file_to_central/',
                 files={os.path.dirname(filepath): open(filepath, 'rb')})
 
             return filepath
 
-        raise ValueError("File communication protocol '%s' as defined in plugins configuration is NOT defined." % self._plugincoupling)
+        raise ValueError(
+            ("File communication protocol '%s' as defined in plugins "
+             "configuration is NOT defined.") % self._plugincoupling)