v3.2.0

Author: bodrovis

docs/additional_info/changelog.rst

@@ -3,6 +3,26 @@
 Changelog
 =========
 
+3.2.0 (17-Feb-2025)
+-------------------
+
+* Add support for `async file downloads <https://developers.lokalise.com/reference/download-files-async>`_:
+
+.. code-block:: python
+
+  process = client.download_files_async(PROJECT_ID, {
+      "format": "json",
+      "original_filenames": True,
+      "replace_breaks": False
+  })
+
+  process_info = client.queued_process(
+    PROJECT_ID,
+    process.process_id
+  )
+
+  process_info.status # => 'finished'
+
 3.1.1 (30-Jan-2025)
 -------------------
 

docs/api/files.rst

@@ -70,6 +70,37 @@ Example:
   })
   response['bundle_url'] # => "https://s3-eu-west-1.amazonaws.com/path/to/bundle.zip"
 
+
+Download files async
+--------------------
+
+.. py:function:: download_files_async(project_id, params)
+
+  :param str project_id: ID of the project to download file from
+  :param dict params: Download params
+  :return: Queued process model
+
+Please note that the async file download will be performed in the background, and this method will
+return a :ref:`QueuedProcess <queued-process>` with a process ID.
+
+Example:
+
+.. code-block:: python
+
+  process = client.download_files_async(PROJECT_ID, {
+      "format": "json",
+      "original_filenames": True,
+      "replace_breaks": False
+  })
+
+  process_info = client.queued_process(
+    PROJECT_ID,
+    process.process_id
+  )
+
+  process_info.status # => 'finished'
+
+
 Delete file
 -----------
 

lokalise/client_methods/files.py

@@ -51,6 +51,18 @@ def download_files(self, project_id: str,
             download(params=params, parent_id=project_id)
         return response
 
+    def download_files_async(self, project_id: str,
+                             params: Dict[str, Any]) -> QueuedProcessModel:
+        """Downloads files from the given project asynchronously.
+
+        :param str project_id: ID of the project to download file from
+        :param dict params: Download params
+        :return: Queued process model
+        """
+        raw_process = self.get_endpoint("files"). \
+            download_async(params=params, parent_id=project_id)
+        return QueuedProcessModel(raw_process)
+
     def delete_file(self, project_id: str,
                     file_id: Union[str, int]) -> Dict:
         """Deletes a file and it's associated keys from the project.

lokalise/endpoints/files_endpoint.py

@@ -34,3 +34,14 @@ def download(self, params: Dict[str, Any],
         """
         path = self.path_with_params(**ids)
         return request.post(self.client, path + 'download', params)
+
+    def download_async(self, params: Dict[str, Any],
+                       **ids: Optional[Union[str, int]]) -> Dict:
+        """Downloads files from the project asynchronously.
+
+        :param dict params: Upload parameters
+        :param ids: Identifiers for path generation
+        :rtype dict:
+        """
+        path = self.path_with_params(**ids)
+        return request.post(self.client, path + 'async-download', params)

poetry.lock

@@ -1,6 +1,6 @@
 [project]
 name = "python-lokalise-api"
-version = "3.1.1"
+version = "3.2.0"
 description = "Official Python interface for the Lokalise API v2"
 authors = [
     {name = "Ilya Krukowski", email = "golosizpru@gmail.com"}

pyproject.toml

@@ -0,0 +1,53 @@
+interactions:
+- request:
+    body: '{"format": "json", "original_filenames": true, "replace_breaks": false}'
+    headers:
+      Accept:
+      - application/json
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '71'
+      User-Agent:
+      - python-lokalise-api plugin/3.1.0
+      x-api-token:
+      - FILTERED
+    method: POST
+    uri: https://api.lokalise.com/api2/projects/6504960967ab53d45e0ed7.15877499/files/async-download
+  response:
+    body:
+      string: '{"process_id":"1efed4e6-461a-6d6e-a779-dea3ae8b7e9e"}'
+    headers:
+      Cache-Control:
+      - max-age=0, must-revalidate, private
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 17 Feb 2025 16:44:01 GMT
+      Expires:
+      - Mon, 17 Feb 2025 16:44:01 GMT
+      Referrer-Policy:
+      - origin
+      Set-Cookie:
+      - PHPSESSID=deleted; expires=Sun, 18-Feb-2024 16:44:00 GMT; Max-Age=0; path=/;
+        httponly
+      Strict-Transport-Security:
+      - max-age=31536000
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Lokalise-Process-Id:
+      - 108b4847-b35e-403a-9cf0-dbaf286ae1c2
+      X-XSS-Protection:
+      - 1; mode=block
+    status:
+      code: 200
+      message: OK
+version: 1

tests/cassettes/files_test/test_download_files_async.yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-lokalise-api plugin/3.1.0
+      x-api-token:
+      - FILTERED
+    method: GET
+    uri: https://api.lokalise.com/api2/projects/6504960967ab53d45e0ed7.15877499/processes/1efed4e6-461a-6d6e-a779-dea3ae8b7e9e
+  response:
+    body:
+      string: '{"process":{"process_id":"1efed4e6-461a-6d6e-a779-dea3ae8b7e9e","type":"async-export","status":"finished","message":null,"created_by":20181,"created_at":"2025-02-17
+        17:44:02 (Europe\/Berlin)","created_at_timestamp":1739810642,"details":{"file_size_kb":1,"total_number_of_keys":4,"download_url":"https:\/\/lokalise-live-lok-s3-fss-export.s3.eu-central-1.amazonaws.com\/export\/176692\/6504960967ab53d45e0ed7.15877499\/export\/d28ed227-ee26-49a3-8630-4f00e7629d2b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAQVSVRZDELRGVB7RH%2F20250217%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250217T164609Z&X-Amz-Expires=86400&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEFEaDGV1LWNlbnRyYWwtMSJHMEUCIQDZ07HeySK1LMUEe3iuBfL7plZdgJGwmmsyOX2BOaHHaAIgKV4EUKjCc7oruE7l%2BOhZ5FDE%2FIyQqPrXyre0EmGRH6wqjgUIehABGgwwNDYzNTAzMjE4NjQiDDMhgC2ljQQxZHkhZirrBF%2FHuTF7gyP0Tt9qq3yYrITevELsg%2Fdhl1HUirQGm%2FE%2Fh9DELYLL5Z%2F0HbvHqKAfG32RE5A6vvX32FNrY%2BduyH2yC%2BM4xJ97Zk6e4cnyXj5tN%2FJw%2Bmke7GpBsK0%2BDM9zeABQs%2Fhczcq%2Fur2hfSPRVDkw1FZsOrvVqfzUdaOOBpL8zSCT2AkDitb5P74u1j4ZyDpxuU7f3xJwyzkrDzOrah%2BQL3Nxy3E4QYQo2HLetVttTKK4yAGF1gL2N2TsTsrIDeEETYJ9QB1pGTyOE2f0XkV3nS6HrAkYwJZpeeg2yTKc5h6Zgj5mmUkuO%2FlgargqSxndZT0GxN6Jpq9ctt40VqfRG7PA0epVhzEuHRcr1jMYEuX0Lsz9Njn3NDtP1rtMLIdwBq%2FOH5xC8sQ9d1h8BZacVPR4TQmALWDDPK%2FMzfwVbhKP3zpoxhMQcmA2B98tnmNIo0zRWra%2F9ozm79mKFhf0dAYGXFNYEAfhe0koDgZG58V6Gq4P%2BBLqaK%2FEJo0rE50E8q54bQcyo%2BU%2BQrExDmCyhUelHoffEK8MX4rrVs%2FHSPVlnTaPjzSLofWy1rD1AZiP%2BK%2Bp9knAmWPxYS4ScTkIBGn0MK9rBwz2czMpZ%2Biv2hVMamsSCGkb9qDWQcWyUdm0rhbkHmxN8815AFv7i2Lc0I5VhWzdHIWVfvp2aGLeCvo4cQYiqX%2BmkOyeGZV0N9Z2LhLqbKKqUPAilzDxwH3jrKP%2BCiGUy0FhPjSDziufoPQuqtz67%2BHYjc68rHXKTKvvKI3lpP8oQFnMd6LmenBK75uus9A6IHsiqYtBJ%2Fjw4oM7pre8BF8ySI0ws87NvQY6mgEVModVeG44pcxxXH9b1CAOe9sVdtURWYTUg6yy%2FU%2FXpK2IE1xQbm3c1kWd998MRxIsaea%2Fo7PIuxhu9UBgFehIE2lB9BFMrGp%2Fv1RqcmATVwv6BdsWJ6s9BYl1uKJoufqJ3vwx9%2FeziarO%2FS5On67OXAvbjxQNBNlo%2BehGvNcNloAtogmRso5%2BYW0%2BwFR4Iq2kxICjx5tk8Uzc&X-Amz-Signature=7e7efee586bdcd34d3288002df2255d23ff6d24f35b1e1c1569d9ed1648c55b7&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject"}}}'
+    headers:
+      Cache-Control:
+      - max-age=0, must-revalidate, no-cache, no-store, private
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 17 Feb 2025 16:46:09 GMT
+      Expires:
+      - Mon, 17 Feb 2025 16:46:09 GMT
+      Pragma:
+      - no-cache
+      Referrer-Policy:
+      - origin
+      Set-Cookie:
+      - PHPSESSID=deleted; expires=Sun, 18-Feb-2024 16:46:08 GMT; Max-Age=0; path=/;
+        httponly
+      Strict-Transport-Security:
+      - max-age=31536000
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - deny
+      X-Lokalise-Process-Id:
+      - f2a1f9b1-4c9f-4305-bc1a-dbb0d2067f87
+      X-XSS-Protection:
+      - 1; mode=block
+    status:
+      code: 200
+      message: OK
+version: 1

tests/cassettes/queued_processes_test/test_queued_process_async_download.yaml

@@ -67,6 +67,19 @@ def test_download_files(client):
     assert r"amazonaws.com" in response['bundle_url']
 
 
+@pytest.mark.vcr
+def test_download_files_async(client):
+    """Tests async files downloading
+    """
+    process = client.download_files_async("6504960967ab53d45e0ed7.15877499", {
+        "format": "json",
+        "original_filenames": True,
+        "replace_breaks": False
+    })
+
+    assert process.process_id == "1efed4e6-461a-6d6e-a779-dea3ae8b7e9e"
+
+
 @pytest.mark.vcr
 def test_delete_file(client):
     """Tests file deletion

tests/client/files_test.py

@@ -38,3 +38,20 @@ def test_queued_process(client):
     assert process.created_at_timestamp == 1592566922
     assert process.details['files'][0]['status'] == 'finished'
     assert process.details['files'][0]['name_original'] == 'en.json'
+
+
+@pytest.mark.vcr
+def test_queued_process_async_download(client):
+    """Tests fetching of a queued process for an async download
+    """
+    project_id = "6504960967ab53d45e0ed7.15877499"
+    process_id = "1efed4e6-461a-6d6e-a779-dea3ae8b7e9e"
+    process = client.queued_process(
+        project_id,
+        process_id
+    )
+
+    assert process.process_id == process_id
+    assert process.type == 'async-export'
+    assert process.status == 'finished'
+    assert 'https://lokalise-live-lok-s3-fss-export' in process.details['download_url']