eodag 3.9.0__py3-none-any.whl → 3.10.0__py3-none-any.whl

eodag/api/product/metadata_mapping.py

@@ -149,42 +149,38 @@ def format_metadata(search_param: str, *args: Any, **kwargs: Any) -> str:
     """Format a string of form ``{<field_name>#<conversion_function>}``
 
     The currently understood converters are:
-        - ``datetime_to_timestamp_milliseconds``: converts a utc date string to a timestamp in
-          milliseconds
-        - ``to_rounded_wkt``: simplify the WKT of a geometry
-        - ``to_bounds_lists``: convert to list(s) of bounds
-        - ``to_nwse_bounds``: convert to North,West,South,East bounds
-        - ``to_nwse_bounds_str``: convert to North,West,South,East bounds string with given separator
-        - ``to_geojson``: convert to a GeoJSON (via __geo_interface__ if exists)
+        - ``ceda_collection_name``: generate a CEDA collection name from a string
+        - ``csv_list``: convert to a comma separated list
+        - ``datetime_to_timestamp_milliseconds``: converts a utc date string to a timestamp in milliseconds
+        - ``dict_filter_and_sub``: filter dict items using jsonpath and then apply recursive_sub_str
+        - ``fake_l2a_title_from_l1c``: used to generate SAFE format metadata for data from AWS
+        - ``from_alternate``: update assets using given alternate
         - ``from_ewkt``: convert EWKT to shapely geometry / WKT in DEFAULT_PROJ
-        - ``to_ewkt``: convert to EWKT (Extended Well-Known text)
         - ``from_georss``: convert GeoRSS to shapely geometry / WKT in DEFAULT_PROJ
-        - ``csv_list``: convert to a comma separated list
-        - ``to_iso_utc_datetime_from_milliseconds``: convert a utc timestamp in given
-          milliseconds to a utc iso datetime
-        - ``to_iso_utc_datetime``: convert a UTC datetime string to ISO UTC datetime
-          string
-        - ``to_iso_date``: remove the time part of a iso datetime string
-        - ``remove_extension``: on a string that contains dots, only take the first
-          part of the list obtained by splitting the string on dots
+        - ``get_ecmwf_time``: get the time of a datetime string in the ECMWF format
         - ``get_group_name``: get the matching regex group name
+        - ``recursive_sub_str``: recursively substitue in the structure (e.g. dict) values matching a regex
+        - ``remove_extension``: on a string that contains dots, only take the first part of the list obtained by
+          splitting the string on dots
         - ``replace_str``: execute "string".replace(old, new)
-        - ``recursive_sub_str``: recursively substitue in the structure (e.g. dict)
-          values matching a regex
-        - ``slice_str``: slice a string (equivalent to s[start, end, step])
-        - ``to_lower``: Convert a string to lowercase
-        - ``to_upper``: Convert a string to uppercase
-        - ``to_title``: Convert a string to title case
-        - ``fake_l2a_title_from_l1c``: used to generate SAFE format metadata for data from AWS
         - ``s2msil2a_title_to_aws_productinfo``: used to generate SAFE format metadata for data from AWS
+        - ``sanitize``: sanitize string
+        - ``slice_str``: slice a string (equivalent to s[start, end, step])
         - ``split_cop_dem_id``: get the bbox by splitting the product id
         - ``split_corine_id``: get the product type by splitting the product id
+        - ``to_bounds_lists``: convert to list(s) of bounds
         - ``to_datetime_dict``: convert a datetime string to a dictionary where values are either a string or a list
-        - ``get_ecmwf_time``: get the time of a datetime string in the ECMWF format
-        - ``sanitize``: sanitize string
-        - ``ceda_collection_name``: generate a CEDA collection name from a string
-        - ``convert_dict_filter_and_sub``: filter dict items using jsonpath and then apply recursive_sub_str
-        - ``convert_from_alternate``: update assets using given alternate
+        - ``to_ewkt``: convert to EWKT (Extended Well-Known text)
+        - ``to_geojson``: convert to a GeoJSON (via __geo_interface__ if exists)
+        - ``to_iso_date``: remove the time part of a iso datetime string
+        - ``to_iso_utc_datetime_from_milliseconds``: convert a utc timestamp in given milliseconds to a utc iso datetime
+        - ``to_iso_utc_datetime``: convert a UTC datetime string to ISO UTC datetime string
+        - ``to_lower``: Convert a string to lowercase
+        - ``to_nwse_bounds_str``: convert to North,West,South,East bounds string with given separator
+        - ``to_nwse_bounds``: convert to North,West,South,East bounds
+        - ``to_rounded_wkt``: simplify the WKT of a geometry
+        - ``to_title``: Convert a string to title case
+        - ``to_upper``: Convert a string to uppercase
 
     :param search_param: The string to be formatted
     :param args: (optional) Additional arguments to use in the formatting process
@@ -490,9 +486,9 @@ def format_metadata(search_param: str, *args: Any, **kwargs: Any) -> str:
             return {"lon": lon, "lat": lat}
 
         @staticmethod
-        def convert_csv_list(values_list: Any) -> Any:
+        def convert_csv_list(values_list: Any, separator=",") -> Any:
             if isinstance(values_list, list):
-                return ",".join([str(x) for x in values_list])
+                return separator.join([str(x) for x in values_list])
             else:
                 return values_list
 

eodag/plugins/authentication/aws_auth.py

@@ -24,9 +24,11 @@ import boto3
 from botocore.exceptions import ClientError, ProfileNotFound
 from botocore.handlers import disable_signing
 
+from eodag.api.product._assets import Asset
 from eodag.plugins.authentication.base import Authentication
 from eodag.types import S3SessionKwargs
-from eodag.utils.exceptions import AuthenticationError
+from eodag.utils import get_bucket_name_and_prefix
+from eodag.utils.exceptions import AuthenticationError, EodagError
 
 if TYPE_CHECKING:
     from mypy_boto3_s3 import S3Client, S3ServiceResource
@@ -106,9 +108,12 @@ class AwsAuth(Authentication):
     def _create_s3_session_from_credentials(self) -> boto3.Session:
         credentials = getattr(self.config, "credentials", {}) or {}
         if "aws_profile" in credentials:
+            logger.debug("Authentication using AWS profile")
             return create_s3_session(profile_name=credentials["aws_profile"])
         # auth using aws keys
-        elif credentials:
+        elif credentials.get("aws_access_key_id") and credentials.get(
+            "aws_secret_access_key"
+        ):
             s3_session_kwargs: S3SessionKwargs = {
                 "aws_access_key_id": credentials["aws_access_key_id"],
                 "aws_secret_access_key": credentials["aws_secret_access_key"],
@@ -120,6 +125,7 @@ class AwsAuth(Authentication):
             return create_s3_session(**s3_session_kwargs)
         else:
             # auth using env variables or ~/.aws
+            logger.debug("Authentication using AWS environment")
             return create_s3_session()
 
     def _create_s3_resource(self) -> S3ServiceResource:
@@ -133,6 +139,9 @@ class AwsAuth(Authentication):
                 endpoint_url=endpoint_url,
             )
         # could not auth using credentials: use no-sign-request strategy
+        logger.debug(
+            "Authentication using AWS no-sign-request strategy (no credentials found)"
+        )
         s3_resource = boto3.resource(service_name="s3", endpoint_url=endpoint_url)
         s3_resource.meta.client.meta.events.register(
             "choose-signer.s3.*", disable_signing
@@ -276,3 +285,36 @@ class AwsAuth(Authentication):
             "session": self.s3_session,
             **rio_env_kwargs,
         }
+
+    def presign_url(
+        self,
+        asset: Asset,
+        expires_in: int = 3600,
+    ) -> str:
+        """This method is used to presign a url to download an asset from S3.
+
+        :param asset: asset for which the url shall be presigned
+        :param expires_in: expiration time of the presigned url in seconds
+        :returns: presigned url
+        :raises: :class:`~eodag.utils.exceptions.EodagError`
+        :raises: :class:`NotImplementedError`
+        """
+        if not getattr(self.config, "support_presign_url", True):
+            raise NotImplementedError(
+                f"presign_url is not supported for provider {self.provider}"
+            )
+
+        s3_client = self.get_s3_client()
+        bucket, prefix = get_bucket_name_and_prefix(asset["href"])
+        try:
+            presigned_url = s3_client.generate_presigned_url(
+                "get_object",
+                Params={
+                    "Bucket": bucket,
+                    "Key": prefix,
+                },
+                ExpiresIn=expires_in,
+            )
+            return presigned_url
+        except ClientError:
+            raise EodagError(f"Couldn't get a presigned URL for '{asset}'.")

eodag/plugins/authentication/base.py

@@ -19,6 +19,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Optional, Union
 
+from eodag.api.product._assets import Asset
 from eodag.plugins.base import PluginTopic
 from eodag.utils.exceptions import MisconfiguredError
 
@@ -80,3 +81,19 @@ class Authentication(PluginTopic):
         Authenticates with s3 and retrieves the available objects
         """
         raise NotImplementedError
+
+    def presign_url(
+        self,
+        asset: Asset,
+        expires_in: int = 3600,
+    ) -> str:
+        """This method is used to presign a url to download an asset from S3.
+
+        :param asset: asset for which the url shall be presigned
+        :param expires_in: expiration time of the presigned url in seconds
+        :returns: presigned url
+        :raises: :class:`NotImplementedError`
+        """
+        raise NotImplementedError(
+            f"presign_url is not implemented for plugin {type(self).__name__}"
+        )

eodag/plugins/authentication/sas_auth.py

@@ -25,6 +25,7 @@ from typing import TYPE_CHECKING, Optional
 import requests
 from requests.auth import AuthBase
 
+from eodag.api.product._assets import Asset
 from eodag.plugins.authentication.base import Authentication
 from eodag.utils import HTTP_REQ_TIMEOUT, USER_AGENT, deepcopy, format_dict_items
 from eodag.utils.exceptions import AuthenticationError, TimeOutError
@@ -143,3 +144,17 @@ class SASAuth(Authentication):
             ssl_verify=ssl_verify,
             matching_url=matching_url,
         )
+
+    def presign_url(
+        self,
+        asset: Asset,
+        expires_in: int = 3600,
+    ) -> str:
+        """This method is used to presign a url to download an asset.
+
+        :param asset: asset for which the url shall be presigned
+        :param expires_in: expiration time of the presigned url in seconds
+        :returns: presigned url
+        """
+        url = asset["href"]
+        return self.config.auth_uri.format(url=url)

eodag/plugins/download/creodias_s3.py

@@ -15,12 +15,19 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from __future__ import annotations
+
 from typing import Optional
 
 from eodag import EOProduct
 from eodag.plugins.download.aws import AwsDownload
+from eodag.utils import _deprecated
 
 
+@_deprecated(
+    reason="Plugin that was used in creodias_s3 provider configuration, but not anymore",
+    version="3.10.0",
+)
 class CreodiasS3Download(AwsDownload):
     """
     Download on creodias s3 from their VMs (extension of :class:`~eodag.plugins.download.aws.AwsDownload`)