Run black on source code

Author: arnaudlimbourg

transloadit/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.12'
+__version__ = "0.1.12"

transloadit/assembly.py

@@ -25,6 +25,7 @@ class Assembly(optionbuilder.OptionBuilder):
             Params to send along with the assembly. Please see
             https://transloadit.com/docs/api-docs/#21-create-a-new-assembly for available options.
     """
+
     def __init__(self, transloadit, files=None, options=None):
         super().__init__(options)
         self.transloadit = transloadit
@@ -45,14 +46,14 @@ def add_file(self, file_stream, field_name=None):
         self.files[field_name] = file_stream
 
     def _get_field_name(self):
-        name = 'file'
+        name = "file"
         if name not in self.files:
             return name
 
         counter = 1
-        while f'{name}_{counter}' in self.files:
+        while f"{name}_{counter}" in self.files:
             counter += 1
-        return f'{name}_{counter}'
+        return f"{name}_{counter}"
 
     def remove_file(self, field_name):
         """
@@ -65,14 +66,16 @@ def remove_file(self, field_name):
 
     def _do_tus_upload(self, assembly_url, tus_url, retries):
         tus_client = tus.TusClient(tus_url)
-        metadata = {'assembly_url': assembly_url}
+        metadata = {"assembly_url": assembly_url}
         for key in self.files:
-            metadata['fieldname'] = key
-            metadata['filename'] = os.path.basename(self.files[key].name)
-            tus_client.uploader(file_stream=self.files[key],
-                                chunk_size=5*1024*1024,
-                                metadata=metadata,
-                                retries=retries).upload()
+            metadata["fieldname"] = key
+            metadata["filename"] = os.path.basename(self.files[key].name)
+            tus_client.uploader(
+                file_stream=self.files[key],
+                chunk_size=5 * 1024 * 1024,
+                metadata=metadata,
+                retries=retries,
+            ).upload()
 
     def create(self, wait=False, resumable=True, retries=3):
         """
@@ -89,35 +92,40 @@ def create(self, wait=False, resumable=True, retries=3):
         """
         data = self.get_options()
         if resumable:
-            extra_data = {'tus_num_expected_upload_files': len(self.files)}
+            extra_data = {"tus_num_expected_upload_files": len(self.files)}
             response = self.transloadit.request.post(
-                '/assemblies', extra_data=extra_data, data=data)
-            self._do_tus_upload(response.data.get('assembly_ssl_url'),
-                                response.data.get('tus_url'),
-                                retries)
+                "/assemblies", extra_data=extra_data, data=data
+            )
+            self._do_tus_upload(
+                response.data.get("assembly_ssl_url"),
+                response.data.get("tus_url"),
+                retries,
+            )
         else:
             response = self.transloadit.request.post(
-                '/assemblies', data=data, files=self.files)
+                "/assemblies", data=data, files=self.files
+            )
 
         if wait:
             while not self._assembly_finished(response):
                 response = self.transloadit.get_assembly(
-                    assembly_url=response.data.get('assembly_ssl_url'))
+                    assembly_url=response.data.get("assembly_ssl_url")
+                )
 
         if self._rate_limit_reached(response) and retries:
             # wait till rate limit is expired
-            sleep(response.data.get('info', {}).get('retryIn', 0))
+            sleep(response.data.get("info", {}).get("retryIn", 0))
             self.create(wait, resumable, retries - 1)
 
         return response
 
     def _assembly_finished(self, response):
-        status = response.data.get('ok')
-        is_aborted = status == 'REQUEST_ABORTED'
-        is_canceled = status == 'ASSEMBLY_CANCELED'
-        is_completed = status == 'ASSEMBLY_COMPLETED'
-        is_failed = response.data.get('error') is not None
+        status = response.data.get("ok")
+        is_aborted = status == "REQUEST_ABORTED"
+        is_canceled = status == "ASSEMBLY_CANCELED"
+        is_completed = status == "ASSEMBLY_COMPLETED"
+        is_failed = response.data.get("error") is not None
         return is_aborted or is_canceled or is_completed or is_failed
 
     def _rate_limit_reached(self, response):
-        return response.data.get('error') == 'RATE_LIMIT_REACHED'
+        return response.data.get("error") == "RATE_LIMIT_REACHED"

transloadit/client.py

@@ -24,9 +24,16 @@ class Transloadit:
             How long in seconds for which a Transloadit request should be valid. Defaults to 300
             if not specified.
     """
-    def __init__(self, auth_key, auth_secret, service='https://api2.transloadit.com', duration=300):
-        if not service.startswith(('http://', 'https://')):
-            service = 'https://' + service
+
+    def __init__(
+        self,
+        auth_key,
+        auth_secret,
+        service="https://api2.transloadit.com",
+        duration=300,
+    ):
+        if not service.startswith(("http://", "https://")):
+            service = "https://" + service
 
         self.service = service
         self.auth_key = auth_key
@@ -49,13 +56,13 @@ def get_assembly(self, assembly_id=None, assembly_url=None):
         :Args:
             - assembly_id (Optional[str])
             - assembly_url (Optional[str])
-        
+
         Return an instance of <transloadit.response.Response>
         """
         if not (assembly_id or assembly_url):
             raise ValueError("Either 'assembly_id' or 'assembly_url' cannot be None.")
 
-        url = assembly_url if assembly_url else f'/assemblies/{assembly_id}'
+        url = assembly_url if assembly_url else f"/assemblies/{assembly_id}"
         return self.request.get(url)
 
     def list_assemblies(self, params=None):
@@ -66,10 +73,10 @@ def list_assemblies(self, params=None):
             - options (Optional[dict]):
                 params to send along with the request. Please see
                 https://transloadit.com/docs/api-docs/#25-retrieve-assembly-list for available options.
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/assemblies', params=params)
+        return self.request.get("/assemblies", params=params)
 
     def cancel_assembly(self, assembly_id=None, assembly_url=None):
         """
@@ -79,13 +86,13 @@ def cancel_assembly(self, assembly_id=None, assembly_url=None):
         :Args:
             - assembly_id (Optional[str])
             - assembly_url (Optional[str])
-        
+
         Return an instance of <transloadit.response.Response>
         """
         if not (assembly_id or assembly_url):
             raise ValueError("Either 'assembly_id' or 'assembly_url' cannot be None.")
 
-        url = assembly_url if assembly_url else f'/assemblies/{assembly_id}'
+        url = assembly_url if assembly_url else f"/assemblies/{assembly_id}"
         return self.request.delete(url)
 
     def get_template(self, template_id):
@@ -94,10 +101,10 @@ def get_template(self, template_id):
 
         :Args:
             - template_id (str)
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get(f'/templates/{template_id}')
+        return self.request.get(f"/templates/{template_id}")
 
     def list_templates(self, params=None):
         """
@@ -107,10 +114,10 @@ def list_templates(self, params=None):
             - options (Optional[dict]):
                 params to send along with the request. Please see
                 https://transloadit.com/docs/api-docs/#45-retrieve-template-list for available options.
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get('/templates', params=params)
+        return self.request.get("/templates", params=params)
 
     def new_template(self, name, params=None):
         """
@@ -132,7 +139,7 @@ def update_template(self, template_id, data):
 
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.put(f'/templates/{template_id}', data=data)
+        return self.request.put(f"/templates/{template_id}", data=data)
 
     def delete_template(self, template_id):
         """
@@ -143,7 +150,7 @@ def delete_template(self, template_id):
 
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.delete(f'/templates/{template_id}')
+        return self.request.delete(f"/templates/{template_id}")
 
     def get_bill(self, month, year):
         """
@@ -152,7 +159,7 @@ def get_bill(self, month, year):
         :Args:
             - month (int): e.g 1 for January
             - year (int)
-        
+
         Return an instance of <transloadit.response.Response>
         """
-        return self.request.get(f'/bill/{year}-{month:02d}')
+        return self.request.get(f"/bill/{year}-{month:02d}")

transloadit/optionbuilder.py

@@ -17,6 +17,7 @@ class OptionBuilder:
             params to send along with the assembly. Please see
             https://transloadit.com/docs/api-docs/#21-create-a-new-assembly for available options.
     """
+
     def __init__(self, options=None):
         super().__init__()
         self.options = options or {}
@@ -31,7 +32,7 @@ def add_step(self, name, robot, options):
             - robot (str): The name of the robot for the step
             - options (dict): The options to apply to the step
         """
-        options['robot'] = robot
+        options["robot"] = robot
         self.steps[name] = options
 
     def remove_step(self, name):
@@ -45,8 +46,8 @@ def remove_step(self, name):
 
     def get_options(self):
         """
-        Return the Assembly/Template options in Transloadit, ready format. 
+        Return the Assembly/Template options in Transloadit, ready format.
         """
         options = copy.deepcopy(self.options)
-        options['steps'] = self.steps
+        options["steps"] = self.steps
         return options

transloadit/request.py

@@ -23,7 +23,7 @@ class Request:
         - transloadit (<transloadit.client.Transloadit>)
     """
 
-    HEADERS = {'Transloadit-Client': 'python-sdk:' + __version__}
+    HEADERS = {"Transloadit-Client": "python-sdk:" + __version__}
 
     def __init__(self, transloadit):
         self.transloadit = transloadit
@@ -39,9 +39,11 @@ def get(self, path, params=None):
 
         Return an instance of <transloadit.response.Response>
         """
-        return requests.get(self._get_full_url(path),
-                            params=self._to_payload(params),
-                            headers=self.HEADERS)
+        return requests.get(
+            self._get_full_url(path),
+            params=self._to_payload(params),
+            headers=self.HEADERS,
+        )
 
     @as_response
     def post(self, path, data=None, extra_data=None, files=None):
@@ -61,8 +63,9 @@ def post(self, path, data=None, extra_data=None, files=None):
         data = self._to_payload(data)
         if extra_data:
             data.update(extra_data)
-        return requests.post(self._get_full_url(path), data=data,
-                             files=files, headers=self.HEADERS)
+        return requests.post(
+            self._get_full_url(path), data=data, files=files, headers=self.HEADERS
+        )
 
     @as_response
     def put(self, path, data=None):
@@ -90,26 +93,27 @@ def delete(self, path, data=None):
         Return an instance of <transloadit.response.Response>
         """
         data = self._to_payload(data)
-        return requests.delete(self._get_full_url(path), data=data, headers=self.HEADERS)
+        return requests.delete(
+            self._get_full_url(path), data=data, headers=self.HEADERS
+        )
 
     def _to_payload(self, data):
         data = copy.deepcopy(data or {})
         expiry = timedelta(seconds=self.transloadit.duration) + datetime.utcnow()
-        data['auth'] = {
-            'key': self.transloadit.auth_key,
-            'expires': expiry.strftime("%Y/%m/%d %H:%M:%S+00:00")
+        data["auth"] = {
+            "key": self.transloadit.auth_key,
+            "expires": expiry.strftime("%Y/%m/%d %H:%M:%S+00:00"),
         }
         json_data = json.dumps(data)
-        return {'params': json_data,
-                'signature': self._sign_data(json_data)}
+        return {"params": json_data, "signature": self._sign_data(json_data)}
 
     def _sign_data(self, message):
-        return hmac.new(b(self.transloadit.auth_secret),
-                        message.encode('utf-8'),
-                        hashlib.sha1).hexdigest()
+        return hmac.new(
+            b(self.transloadit.auth_secret), message.encode("utf-8"), hashlib.sha1
+        ).hexdigest()
 
     def _get_full_url(self, url):
-        if url.startswith(('http://', 'https://')):
+        if url.startswith(("http://", "https://")):
             return url
         else:
             return self.transloadit.service + url

transloadit/response.py

@@ -16,6 +16,7 @@ class Response:
     :Constructor Args:
         - response (<requests.Response>): The bare response object from the requests library.
     """
+
     def __init__(self, response):
         self._response = response
         self.data = self._response.json()
@@ -40,7 +41,9 @@ def as_response(func):
     Decorator function that converts the output of a function into an instance
     of the <transloadit.response.Response> class.
     """
+
     @wraps(func)
     def _wrapper(*args, **kwargs):
         return Response(func(*args, **kwargs))
+
     return _wrapper

transloadit/template.py

@@ -18,6 +18,7 @@ class Template(optionbuilder.OptionBuilder):
             Params to send along with the template. Please see
             https://transloadit.com/docs/api-docs/#4-templates for available options.
     """
+
     def __init__(self, transloadit, name, options=None):
         super().__init__(options)
         self.transloadit = transloadit
@@ -28,5 +29,5 @@ def create(self):
         Save/Submit the template to the Transloadit server.
         """
         data = self.get_options()
-        data.update({'name': self.name})
-        return self.transloadit.request.post('/templates', data=data)
+        data.update({"name": self.name})
+        return self.transloadit.request.post("/templates", data=data)