add namespacing to environment variables and ~/.planet.json variables.

Author: carl-adams-planet

src/planet_auth_utils/constants.py

@@ -12,89 +12,143 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from planet_auth_utils.builtins import Builtins
 
-class EnvironmentVariables:
-    """
-    Environment Variables used in the planet_auth_utils packages
-    """
-
-    AUTH_API_KEY = "PL_API_KEY"
-    """
-    A literal Planet API key.
-    """
-
-    AUTH_CLIENT_ID = "PL_AUTH_CLIENT_ID"
-    """
-    Client ID for an OAuth service account
-    """
-
-    AUTH_CLIENT_SECRET = "PL_AUTH_CLIENT_SECRET"
-    """
-    Client Secret for an OAuth service account
-    """
-
-    AUTH_EXTRA = "PL_AUTH_EXTRA"
-    """
-    List of extra options.  Values should be formatted as <key>=<value>.
-    Multiple options should be whitespace delimited.
-    """
-
-    AUTH_PROFILE = "PL_AUTH_PROFILE"
-    """
-    Name of a profile to use for auth client configuration.
-    """
-
-    AUTH_TOKEN = "PL_AUTH_TOKEN"
-    """
-    Literal token string.
-    """
 
-    AUTH_TOKEN_FILE = "PL_AUTH_TOKEN_FILE"
-    """
-    File path to use for storing tokens.
-    """
-
-    AUTH_ISSUER = "PL_AUTH_ISSUER"
-    """
-    Issuer to use when requesting or validating OAuth tokens.
-    """
-
-    AUTH_AUDIENCE = "PL_AUTH_AUDIENCE"
-    """
-    Audience to use when requesting or validating OAuth tokens.
-    """
-
-    AUTH_ORGANIZATION = "PL_AUTH_ORGANIZATION"
-    """
-    Organization to use when performing client authentication.
-    Only used for some authentication mechanisms.
-    """
+class classproperty(object):
+    def __init__(self, method=None):
+        self.fget = method
 
-    AUTH_PROJECT = "PL_AUTH_PROJECT"
-    """
-    Project ID to use when performing authentication.
-    Not all implementations understand this option.
-    """
+    def __get__(self, instance, cls=None):
+        return self.fget(cls)
 
-    AUTH_PASSWORD = "PL_AUTH_PASSWORD"
-    """
-    Password to use when performing client authentication.
-    Only used for some authentication mechanisms.
-    """
 
-    AUTH_SCOPE = "PL_AUTH_SCOPE"
-    """
-    List of scopes to request when requesting OAuth tokens.
-    Multiple scopes should be whitespace delimited.
-    """
-
-    AUTH_USERNAME = "PL_AUTH_USERNAME"
+class EnvironmentVariables:
     """
-    Username to use when performing client authentication.
-    Only used for some authentication mechanisms.
+    Environment Variables used in the planet_auth_utils packages
     """
 
-    AUTH_LOGLEVEL = "PL_LOGLEVEL"
-    """
-    Specify the log level.
-    """
+    @staticmethod
+    def _namespace_variable(undecorated_variable: str):
+        """
+        Decorate the variable name with a namespace.
+        This is done so that multiple applications may use
+        the Planet auth library without conflicting.
+        """
+
+        namespace = Builtins.namespace()
+        if namespace:
+            return f"{namespace.upper()}_{undecorated_variable}"
+        return undecorated_variable
+
+    @classproperty
+    def AUTH_API_KEY(cls):  # pylint: disable=no-self-argument
+        """
+        A literal Planet API key.
+        """
+        return cls._namespace_variable("PL_API_KEY")
+
+    @classproperty
+    def AUTH_CLIENT_ID(cls):  # pylint: disable=no-self-argument
+        """
+        Client ID for an OAuth service account
+        """
+        # traceback.print_stack(file=sys.stdout)
+        return cls._namespace_variable("PL_AUTH_CLIENT_ID")
+
+    @classproperty
+    def AUTH_CLIENT_SECRET(cls):  # pylint: disable=no-self-argument
+        """
+        Client Secret for an OAuth service account
+        """
+        return cls._namespace_variable("PL_AUTH_CLIENT_SECRET")
+
+    @classproperty
+    def AUTH_EXTRA(cls):  # pylint: disable=no-self-argument
+        """
+        List of extra options. Values should be formatted as <key>=<value>.
+        Multiple options should be whitespace delimited.
+        """
+        return cls._namespace_variable("PL_AUTH_EXTRA")
+
+    @classproperty
+    def AUTH_PROFILE(cls):  # pylint: disable=no-self-argument
+        """
+        Name of a profile to use for auth client configuration.
+        """
+        return cls._namespace_variable("PL_AUTH_PROFILE")
+
+    @classproperty
+    def AUTH_TOKEN(cls):  # pylint: disable=no-self-argument
+        """
+        Literal token string.
+        """
+        return cls._namespace_variable("PL_AUTH_TOKEN")
+
+    @classproperty
+    def AUTH_TOKEN_FILE(cls):  # pylint: disable=no-self-argument
+        """
+        File path to use for storing tokens.
+        """
+        return cls._namespace_variable("PL_AUTH_TOKEN_FILE")
+
+    @classproperty
+    def AUTH_ISSUER(cls):  # pylint: disable=no-self-argument
+        """
+        Issuer to use when requesting or validating OAuth tokens.
+        """
+        return cls._namespace_variable("PL_AUTH_ISSUER")
+
+    @classproperty
+    def AUTH_AUDIENCE(cls):  # pylint: disable=no-self-argument
+        """
+        Audience to use when requesting or validating OAuth tokens.
+        """
+        return cls._namespace_variable("PL_AUTH_AUDIENCE")
+
+    @classproperty
+    def AUTH_ORGANIZATION(cls):  # pylint: disable=no-self-argument
+        """
+        Organization to use when performing client authentication.
+        Only used for some authentication mechanisms.
+        """
+        return cls._namespace_variable("PL_AUTH_ORGANIZATION")
+
+    @classproperty
+    def AUTH_PROJECT(cls):  # pylint: disable=no-self-argument
+        """
+        Project ID to use when performing authentication.
+        Not all implementations understand this option.
+        """
+        return cls._namespace_variable("PL_AUTH_PROJECT")
+
+    @classproperty
+    def AUTH_PASSWORD(cls):  # pylint: disable=no-self-argument
+        """
+        Password to use when performing client authentication.
+        Only used for some authentication mechanisms.
+        """
+        return cls._namespace_variable("PL_AUTH_PASSWORD")
+
+    @classproperty
+    def AUTH_SCOPE(cls):  # pylint: disable=no-self-argument
+        """
+        List of scopes to request when requesting OAuth tokens.
+        Multiple scopes should be whitespace delimited.
+        """
+        return cls._namespace_variable("PL_AUTH_SCOPE")
+
+    @classproperty
+    def AUTH_USERNAME(cls):  # pylint: disable=no-self-argument
+        """
+        Username to use when performing client authentication.
+        Only used for some authentication mechanisms.
+        """
+        return cls._namespace_variable("PL_AUTH_USERNAME")
+
+    @classproperty
+    def AUTH_LOGLEVEL(cls):  # pylint: disable=no-self-argument
+        """
+        Specify the log level.
+        """
+        return cls._namespace_variable("PL_LOGLEVEL")