restpki-ng-python-client 0.9.2rc1__tar.gz → 0.10.1__tar.gz

{restpki_ng_python_client-0.9.2rc1 → restpki_ng_python_client-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: restpki_ng_python_client
-Version: 0.9.2rc1
+Version: 0.10.1
 Summary: Rest PKI Core API
 Home-page: 
 Author: OpenAPI Generator community

{restpki_ng_python_client-0.9.2rc1 → restpki_ng_python_client-0.10.1}/README.md

@@ -75,6 +75,11 @@ The `dist` folder contains the generated files and the static proprietary module
 ## Steps 
 ### Generating and testing the library
 1. Run `cmd.ps1`
+    * `cmd.ps1` needs `openapi-generator-cli` (and therefore Java). Without them, you can run the same generator version (see `openapitools.json`) through Docker in place of the `openapi-generator-cli generate` line, then run the rest of the script's steps:
+    ```
+    docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v7.1.0 generate -g python -i https://homolog.core.pki.rest/swagger/api/swagger.json -c /local/python-openapi-config.json -o /local/dist
+    ```
+    * After generating, check the new and changed API operations against `manually_generated_files/restpki_ng_client.py` and add facade methods for them. `test/test_restpki_ng_client.py` tests the facade methods offline, without a Rest PKI Core instance.
 2. Test your application, for that we have a copy of the `test` folder outside of the `dist` folder which must overwrite the `dist/test` folder with populated tests. The tests are also kept outside the dist folder so they are not overwritten during the generation process. 
 * Copy and overwrite the `test` folder into `dist/test`.
 * Test all modules using `pytest`, you also may test one at a time by running `pytest [filename.py]`
@@ -82,7 +87,8 @@ The `dist` folder contains the generated files and the static proprietary module
 
 ### Publishing
 
-TODO
+After running `cmd.ps1`, run the `publish.ps1`. Make sure you have the PyPI API Token to be able to publish the package.
+The `publish.ps1` script also contain commands to run the tests present in the `test` folder.
 
 ### Adding new files to the project
 Adding new files is not a complex task, but it requires attention from the devs as not to break previous functionalities, so **it is vital to test them before publishing**. For this project, only integration tests were made available with only a test case for each endpoint. The tests do not cover

{restpki_ng_python_client-0.9.2rc1 → restpki_ng_python_client-0.10.1}/manually_generated_files/api/upload_api.py

@@ -15,7 +15,7 @@
 import io
 import warnings
 
-from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from pydantic import validate_call, Field, StrictBytes, StrictFloat, StrictStr, StrictInt
 from typing import Dict, List, Optional, Tuple, Union, Any
 
 from urllib3 import encode_multipart_formdata
@@ -289,6 +289,7 @@ class UploadApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'ApiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -314,7 +315,8 @@ class UploadApi:
         self,
         token: StrictStr,
         part_number: StrictInt,
-        part_digest: Any,
+        part_content: StrictBytes,
+        part_digest: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -335,6 +337,10 @@ class UploadApi:
         :type token: str
         :param part_number: (required)
         :type part_number: int
+        :param part_content: bytes of this part, sent as the request body (required)
+        :type part_content: bytes
+        :param part_digest: standard (not URL-safe) Base64 of the MD5 of part_content, sent on the Content-MD5 header
+        :type part_digest: str, optional
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -357,15 +363,11 @@ class UploadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        # Add or update the Content-MD5 header in the _headers dictionary
-        # if _headers is None:
-            # _headers = {}
-        # _headers['Content-MD5'] = part_digest
-        # _content_type = 'application/octet-stream'
-
         _param = self._api_multipart_uploads_token_part_number_post_serialize(
             token=token,
             part_number=part_number,
+            part_content=part_content,
+            part_digest=part_digest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -391,6 +393,8 @@ class UploadApi:
         self,
         token: StrictStr,
         part_number: StrictInt,
+        part_content: StrictBytes,
+        part_digest: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -411,6 +415,10 @@ class UploadApi:
         :type token: str
         :param part_number: (required)
         :type part_number: int
+        :param part_content: bytes of this part, sent as the request body (required)
+        :type part_content: bytes
+        :param part_digest: standard (not URL-safe) Base64 of the MD5 of part_content, sent on the Content-MD5 header
+        :type part_digest: str, optional
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -436,6 +444,8 @@ class UploadApi:
         _param = self._api_multipart_uploads_token_part_number_post_serialize(
             token=token,
             part_number=part_number,
+            part_content=part_content,
+            part_digest=part_digest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -461,6 +471,8 @@ class UploadApi:
         self,
         token: StrictStr,
         part_number: StrictInt,
+        part_content: StrictBytes,
+        part_digest: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -481,6 +493,10 @@ class UploadApi:
         :type token: str
         :param part_number: (required)
         :type part_number: int
+        :param part_content: bytes of this part, sent as the request body (required)
+        :type part_content: bytes
+        :param part_digest: standard (not URL-safe) Base64 of the MD5 of part_content, sent on the Content-MD5 header
+        :type part_digest: str, optional
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -506,6 +522,8 @@ class UploadApi:
         _param = self._api_multipart_uploads_token_part_number_post_serialize(
             token=token,
             part_number=part_number,
+            part_content=part_content,
+            part_digest=part_digest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -526,6 +544,8 @@ class UploadApi:
         self,
         token,
         part_number,
+        part_content,
+        part_digest,
         _request_auth,
         _content_type,
         _headers,
@@ -552,14 +572,22 @@ class UploadApi:
             _path_params['partNumber'] = part_number
         # process the query parameters
         # process the header parameters
+        if part_digest is not None:
+            _header_params['Content-MD5'] = part_digest
         # process the form parameters
         # process the body parameter
+        if part_content is not None:
+            _body_params = part_content
 
-
-
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _header_params['Content-Type'] = 'application/octet-stream'
 
         # authentication setting
         _auth_settings: List[str] = [
+            'ApiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -838,6 +866,7 @@ class UploadApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'ApiKey'
         ]
 
         return self.api_client.param_serialize(
@@ -1106,6 +1135,7 @@ class UploadApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'ApiKey'
         ]
 
         return self.api_client.param_serialize(

{restpki_ng_python_client-0.9.2rc1 → restpki_ng_python_client-0.10.1}/manually_generated_files/file_utils.py

@@ -25,11 +25,10 @@ class FileUtils():
         if content_raw is not None:
             stream = Utils._get_raw_stream(content_raw)
         else:
+            url = Utils._get_file_url(self.__file, self.__client)
             stream = BytesIO()
-            with self.__client.get_file_from_url(self.__file.url) as response:
-                for chunk in response.stream(buff_size):
-                    stream.write(chunk)
-                stream.seek(0, 0)
+            Utils._download(self.__client, url, stream, buff_size)
+            stream.seek(0, 0)
         return stream
 
     def write_to(self, f_out, offset=0, from_where=0, buff_size=4096):
@@ -41,25 +40,25 @@ class FileUtils():
             Utils._copy_stream(f_in, f_out, offset, from_where, buff_size)
             f_in.close()
         else:
+            url = Utils._get_file_url(self.__file, self.__client)
             f_out.seek(offset, from_where)
-            with self.__client.get_file_from_url(self.__file.url) as response:
-                for chunk in response.stream(buff_size):
-                    f_out.write(chunk)
-                
+            Utils._download(self.__client, url, f_out, buff_size)
+
 
     def write_to_file(self, path, offset=0, from_where=0, buff_size=4096):
         content_base64 = self.__file.content
         content_raw = Utils._base64_decode(content_base64)\
             if content_base64 is not None else None
+        # Checked before opening the file, so that it is not created or truncated when there is nothing to write
+        url = Utils._get_file_url(self.__file, self.__client) if content_raw is None else None
         with open(path, 'wb') as f_out:
             if content_raw is not None:
                 f_in = self.open()
                 Utils._copy_stream(f_in, f_out, offset, from_where, buff_size)
                 f_in.close()
             else:
-                with self.__client.get_file_from_url(self.__file.url) as response:
-                    for chunk in response.stream(buff_size):
-                        f_out.write(chunk)
+                f_out.seek(offset, from_where)
+                Utils._download(self.__client, url, f_out, buff_size)
 
     # region "content" accessors