envs.py

"""Environment variable hooks."""
import logging
import os
import platform

from tackle import BaseHook, Field

logger = logging.getLogger(__name__)


class GetEnvHook(BaseHook):
    """Hook for getting environment variables."""

    hook_name = 'get_env'
    environment_variable: str = Field(
        None,
        description="Dict for setting and string for getting environment variables",
    )
    fallback: str = Field(None, description="A fallback for getting.")

    args: list = ['environment_variable', 'fallback']

    def exec(self):
        """Set env vars."""
        if platform.system() == 'Windows':
            from tackle.exceptions import ContributionNeededException

            raise ContributionNeededException()
            # robcxyz - Not working on windows support but would love PRs
        else:
            return os.getenv(self.environment_variable, self.fallback)


class EnvironmentVariableHook(BaseHook):
    """Hook for setting environment variables."""

    hook_name = 'set_env'
    environment_variable: str = Field(
        ..., description="The name of the environment variable to set."
    )
    value: str = Field(None, description="The value to set it.")

    args: list = ['environment_variable', 'value']

    def exec(self):
        """Get or set env vars."""
        if platform.system() == 'Windows':
            from tackle.exceptions import ContributionNeededException

            raise ContributionNeededException()
            # robcxyz - Not working on windows support but would love PRs
        else:
            # TODO: Implement parsing for strings to set -> export THING=stuff
            os.environ[self.environment_variable] = self.value
            return self.value


class ExportHook(BaseHook):
    """Hook for setting environment variables that returns None."""

    hook_name = 'export'
    environment_variable: str = Field(
        ..., description="The name of the environment variable to set."
    )
    value: str = Field(None, description="The value to set it.")

    args: list = ['environment_variable', 'value']

    # TODO: Implement parsing for strings to set -> <: export THING=stuff
    def exec(self):
        """Set env vars."""
        if platform.system() == 'Windows':
            from tackle.exceptions import ContributionNeededException

            raise ContributionNeededException()
            # robcxyz - Not working on windows support but would love PRs
        else:
            os.environ[self.environment_variable] = self.value
        return


class UnsetHook(BaseHook):
    """Hook for unsetting environment variables."""

    hook_name = 'unset'
    environment_variable: str = Field(
        ..., description="The name of the environment variable to set."
    )

    args: list = ['environment_variable']

    def exec(self):
        """Set env vars."""
        if platform.system() == 'Windows':
            from tackle.exceptions import ContributionNeededException

            raise ContributionNeededException()
            # robcxyz - Not working on windows support but would love PRs
        else:
            os.unsetenv(self.environment_variable)
        return