stackit-redis 0.0.1a0__tar.gz → 0.2.0__tar.gz

{stackit_redis-0.0.1a0 → stackit_redis-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stackit-redis
-Version: 0.0.1a0
+Version: 0.2.0
 Summary: STACKIT Redis API
 Author: STACKIT Developer Tools
 Author-email: developer-tools@stackit.cloud

{stackit_redis-0.0.1a0 → stackit_redis-0.2.0}/pyproject.toml

@@ -1,6 +1,9 @@
+[project]
+name = "stackit-redis"
+
 [tool.poetry]
 name = "stackit-redis"
-version = "v0.0.1a"
+version = "v0.2.0"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

{stackit_redis-0.0.1a0 → stackit_redis-0.2.0}/src/stackit/redis/configuration.py

@@ -11,6 +11,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -22,7 +24,14 @@ class HostConfiguration:
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
         self._base_path = "https://redis.api.eu01.stackit.cloud"
         """Default Base url
         """
@@ -64,6 +73,7 @@ class HostConfiguration:
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -82,8 +92,25 @@ class HostConfiguration:
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]: