Merge branch 'master' of https://github.com/Void-ux/aiob2

aiob2/bucket.py

@@ -229,6 +229,7 @@ async def download_file_by_id(
         self,
         file_id: str,
         *,
+        range_: Optional[str] = None,
         content_disposition: Optional[str] = None,
         content_language: Optional[str] = None,
         expires: Optional[str] = None,
@@ -243,6 +244,10 @@ async def download_file_by_id(
         -----------
         file_id: :class:`str`
             The file id of the file to be downloaded.
+        range_: Optional[:class:`str`]
+            A standard byte-range request, which will return just part of the stored file. For
+            example, "bytes=0,99" selects bytes 0 through 99 (inclusive) of the file, so it will
+            return the first 100 bytes.
         content_disposition: Optional[:class:`str`]
             Overrides the current 'b2-content-disposition' specified when the file was uploaded.
         content_language: Optional[:class:`str`]
@@ -267,6 +272,7 @@ async def download_file_by_id(
 
         data = await self._http.download_file_by_id(
             file_id=file_id,
+            range_=range_,
             content_disposition=content_disposition,
             content_language=content_language,
             expires=expires,
@@ -282,6 +288,7 @@ async def download_file_by_name(
         file_name: str,
         bucket_name: str,
         *,
+        range_: Optional[str] = None,
         content_disposition: Optional[str] = None,
         content_language: Optional[str] = None,
         expires: Optional[str] = None,
@@ -299,6 +306,10 @@ async def download_file_by_name(
         bucket_name: :class:`str`
             The bucket name of the file to be downloaded. This should only be specified if you have specified
             file_name and not file_id.
+        range_: Optional[:class:`str`]
+            A standard byte-range request, which will return just part of the stored file. For
+            example, "bytes=0,99" selects bytes 0 through 99 (inclusive) of the file, so it will
+            return the first 100 bytes.
         content_disposition: Optional[:class:`str`]
             Overrides the current 'b2-content-disposition' specified when the file was uploaded.
         content_language: Optional[:class:`str`]
@@ -324,6 +335,7 @@ async def download_file_by_name(
         data = await self._http.download_file_by_name(
             file_name=file_name,
             bucket_name=bucket_name,
+            range_=range_,
             content_disposition=content_disposition,
             content_language=content_language,
             expires=expires,

aiob2/http.py

@@ -178,16 +178,17 @@ def __init__(
         path: str,
         *,
         base: Optional[str] = None,
+        query_parameters: Optional = None,
         **parameters: Any
     ) -> None:
         self.method: Literal['GET', 'POST', 'PUT', 'DELETE'] = method
         self.path = path
         self.parameters = parameters
+        self.query_parameters = query_parameters
         url = (base or self.BASE) + self.path
         if parameters:
             url = url.format_map({k: quote(v) if isinstance(v, str) else v for k, v in self.parameters.items()})
-
-        self.url: URL = URL(url, encoded=True)
+        self.url: URL = URL(url, encoded=True).with_query(query_parameters)
 
     def __repr__(self) -> str:
         return f'{self.method} {str(self.url)}'
@@ -414,7 +415,7 @@ async def request(
         if self._authorization_token is MISSING and route.path != '/b2_authorize_account':
             await self._find_authorization_token()
             headers['Authorization'] = self._authorization_token
-            route = Route(route.method, route.path, base=self._api_url, **route.parameters)
+            route = Route(route.method, route.path, base=self._api_url, query_parameters=route.query_parameters, **route.parameters)
 
         for tries in range(5):
             if upload_info:
@@ -722,6 +723,7 @@ def download_file_by_id(
         self,
         *,
         file_id: str,
+        range_: Optional[str] = None,
         content_disposition: Optional[str] = None,
         content_language: Optional[str] = None,
         expires: Optional[str] = None,
@@ -732,6 +734,10 @@ def download_file_by_id(
     ) -> Response[Tuple[bytes, Dict[str, Any]]]:
         headers = {
             'Authorization': self._authorization_token,
+            'Range': range_,
+        }
+        headers = {key: value for key, value in headers.items() if value is not None}
+        query_parameters = {
             'b2ContentDisposition': content_disposition,
             'b2ContentLanguage': content_language,
             'b2Expires': expires,
@@ -740,14 +746,15 @@ def download_file_by_id(
             'b2ContentType': content_type,
             'serverSideEncryption': server_side_encryption
         }
-        headers = {key: value for key, value in headers.items() if value is not None}
+        query_parameters = {key: value for key, value in query_parameters.items() if value is not None}
         params = {
             'fileId': file_id
         }
         route = Route(
             'GET',
             '/b2api/v2/b2_download_file_by_id',
-            base=self._download_url
+            base=self._download_url,
+            query_parameters=query_parameters,
         )
 
         return self.request(route, headers=headers, params=params)
@@ -757,6 +764,7 @@ def download_file_by_name(
         *,
         file_name: str,
         bucket_name: str,
+        range_: Optional[str] = None,
         content_disposition: Optional[str] = None,
         content_language: Optional[str] = None,
         expires: Optional[str] = None,
@@ -767,6 +775,10 @@ def download_file_by_name(
     ) -> Response[Tuple[bytes, Dict[str, Any]]]:
         headers = {
             'Authorization': self._authorization_token,
+            'Range': range_,
+        }
+        headers = {key: value for key, value in headers.items() if value is not None}
+        query_parameters = {
             'b2ContentDisposition': content_disposition,
             'b2ContentLanguage': content_language,
             'b2Expires': expires,
@@ -775,11 +787,12 @@ def download_file_by_name(
             'b2ContentType': content_type,
             'serverSideEncryption': server_side_encryption
         }
-        headers = {key: value for key, value in headers.items() if value is not None}
+        query_parameters = {key: value for key, value in query_parameters.items() if value is not None}
         route = Route(
             'GET',
             '/file/{bucket_name}/{file_name}',
             base=self._download_url,
+            query_parameters=query_parameters,
             bucket_name=bucket_name,
             file_name=file_name
         )

aiob2/models/file.py

@@ -242,7 +242,8 @@ def __init__(
 
         self.content_disposition: Optional[str] = headers.get('content-disposition')
         self.content_language: Optional[str] = headers.get('content-language')
-        if (expires := headers.get('cache-control')) is not None:
+        self.cache_control: Optional[str] = headers.get('cache-control')
+        if (expires := headers.get('expires')) is not None:
             expires = datetime.datetime.strptime(expires, '%a, %d %b %Y %H:%M:%S %Z')
         else:
             expires = None

tests/test_download.py

@@ -36,3 +36,85 @@ async def test_download(self):
         assert downloaded_file.content == path.read_bytes()
 
         await client.close()
+
+    @pytest.mark.asyncio
+    @pytest.mark.order(2)
+    async def test_download_range(self):
+        client = Client(os.environ['KEY_ID'], os.environ['KEY'], log_level=logging.DEBUG)
+        file = ValueStorage.test_upload_file
+        assert isinstance(file, File)
+
+        range_length = 100
+        range_str = f"bytes=0-{range_length - 1}"
+
+        downloaded_file = await client.download_file_by_name(
+            file_name=file.name,
+            bucket_name=os.environ['BUCKET_NAME'],
+            range_=range_str
+        )
+
+        assert downloaded_file.name == file.name
+        assert downloaded_file.id == file.id
+        assert len(downloaded_file.content) <= range_length
+        assert int(downloaded_file.content_length) <= range_length
+        assert int(downloaded_file.content_length) == len(downloaded_file.content)
+
+        # Download (by id)
+
+        downloaded_file = await client.download_file_by_id(file_id=file.id, range_=range_str)
+
+        assert downloaded_file.name == file.name
+        assert downloaded_file.id == file.id
+        assert len(downloaded_file.content) <= range_length
+        assert int(downloaded_file.content_length) <= range_length
+        assert int(downloaded_file.content_length) == len(downloaded_file.content)
+
+        await client.close()
+
+    @pytest.mark.asyncio
+    @pytest.mark.order(2)
+    async def test_download_params(self):
+        client = Client(os.environ['KEY_ID'], os.environ['KEY'], log_level=logging.DEBUG)
+        file = ValueStorage.test_upload_file
+        assert isinstance(file, File)
+
+        content_disposition = f'attachment; filename="filename.jpg"'
+        content_language = 'de-DE'
+        expires = 'Wed, 21 Oct 2015 07:28:00 GMT'
+        # TODO: this is a valid value for cache-control, but DownloadedFile tries to parse it as a timestamp
+        # cache_control = 'max-age=604800, must-revalidate'
+        content_encoding = 'compress'
+        content_type = 'text/html;charset=utf-8'
+
+        downloaded_file = await client.download_file_by_name(
+            file_name=file.name,
+            bucket_name=os.environ['BUCKET_NAME'],
+            content_disposition=content_disposition,
+            content_language=content_language,
+            expires=expires,
+            # cache_control=cache_control,
+            content_encoding=content_encoding,
+            content_type=content_type
+        )
+
+        assert downloaded_file.name == file.name
+        assert downloaded_file.id == file.id
+        assert downloaded_file.content == path.read_bytes()
+        assert downloaded_file.content_disposition == content_disposition
+        assert downloaded_file.content_language == content_language
+        # TODO: cache-control header is not exposed by DownloadedFile, and the logic that sets expires needs some
+        #       attention
+        # assert downloaded_file.cache_control == cache_control
+        # assert downloaded_file.expires == expires
+        assert downloaded_file.content_encoding == content_encoding
+        assert downloaded_file.content_type == content_type
+
+        # Download (by id)
+
+        downloaded_file = await client.download_file_by_id(file_id=file.id)
+
+        assert downloaded_file.name == file.name
+        assert downloaded_file.id == file.id
+        assert downloaded_file.content == path.read_bytes()
+
+        await client.close()