envstack 0.6.3__tar.gz → 0.6.4__tar.gz

{envstack-0.6.3/lib/envstack.egg-info → envstack-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.6.3
+Version: 0.6.4
 Summary: Stacked environment variable management system
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: PyYAML>=5.1.2
+Requires-Dist: PyYAML==5.1.2
 
 envstack
 ========
@@ -303,7 +303,7 @@ the output of the `--export` command:
 
 #### bash
 ```bash
-alias envstack-set='source <(envstack "$1" --export)';
+alias envstack-init='source <(envstack --export)';
 ```
 
 #### cmd
@@ -311,13 +311,13 @@ alias envstack-set='source <(envstack "$1" --export)';
 doskey envstack-set=for /f "usebackq" %i in (`envstack --export $*`) do %%i
 ```
 
-Then you can set the environment stack in your shell with the `envstack-set`
+Then you can set the environment stack in your shell with the `envstack-init`
 command. To clear the environment in your current shell, create an alias that
 sources the output of the `--clear` command:
 
 #### bash
 ```bash
-alias envstack-clear='source <(envstack "$1" --clear)';
+alias envstack-clear='source <(envstack --clear)';
 ```
 
 #### cmd
@@ -325,18 +325,6 @@ alias envstack-clear='source <(envstack "$1" --clear)';
 doskey envstack-clear=for /f "usebackq" %i in (`envstack --clear $*`) do %%i
 ```
 
-Create a function for convenience that does both in one command:
-
-#### bash
-```bash
-envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
-```
-
-#### cmd
-```cmd
-doskey envstack-init=envstack-clear $* & envstack-set $*
-```
-
 ## Config
 
 Default config settings are in the config.py module. The following environment

{envstack-0.6.3 → envstack-0.6.4}/README.md

@@ -280,7 +280,7 @@ the output of the `--export` command:
 
 #### bash
 ```bash
-alias envstack-set='source <(envstack "$1" --export)';
+alias envstack-init='source <(envstack --export)';
 ```
 
 #### cmd
@@ -288,13 +288,13 @@ alias envstack-set='source <(envstack "$1" --export)';
 doskey envstack-set=for /f "usebackq" %i in (`envstack --export $*`) do %%i
 ```
 
-Then you can set the environment stack in your shell with the `envstack-set`
+Then you can set the environment stack in your shell with the `envstack-init`
 command. To clear the environment in your current shell, create an alias that
 sources the output of the `--clear` command:
 
 #### bash
 ```bash
-alias envstack-clear='source <(envstack "$1" --clear)';
+alias envstack-clear='source <(envstack --clear)';
 ```
 
 #### cmd
@@ -302,18 +302,6 @@ alias envstack-clear='source <(envstack "$1" --clear)';
 doskey envstack-clear=for /f "usebackq" %i in (`envstack --clear $*`) do %%i
 ```
 
-Create a function for convenience that does both in one command:
-
-#### bash
-```bash
-envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
-```
-
-#### cmd
-```cmd
-doskey envstack-init=envstack-clear $* & envstack-set $*
-```
-
 ## Config
 
 Default config settings are in the config.py module. The following environment

{envstack-0.6.3 → envstack-0.6.4}/lib/envstack/__init__.py

@@ -34,6 +34,6 @@ Stacked environment variable management system.
 """
 
 __prog__ = "envstack"
-__version__ = "0.6.3"
+__version__ = "0.6.4"
 
-from envstack.env import Env, getenv, init, load_file, revert, save
+from envstack.env import Env, clear, getenv, init, load_file, revert, save

{envstack-0.6.3 → envstack-0.6.4}/lib/envstack/cli.py

@@ -38,7 +38,14 @@ import sys
 import traceback
 
 from envstack import __version__, config
-from envstack.env import build_sources, expandvars, export, load_environ, trace_var
+from envstack.env import (
+    build_sources,
+    expandvars,
+    clear,
+    export,
+    load_environ,
+    trace_var,
+)
 from envstack.wrapper import run_command
 
 
@@ -139,7 +146,7 @@ def main():
             for source in sources:
                 print(source)
         elif args.clear:
-            print(export(args.namespace, config.SHELL, clear=True))
+            print(clear(args.namespace, config.SHELL))
         elif args.export:
             print(export(args.namespace, config.SHELL))
         elif command:

{envstack-0.6.3 → envstack-0.6.4}/lib/envstack/env.py

@@ -533,59 +533,128 @@ def expandvars(var, env=None, recursive=False):
     return EnvVar(var).expand(env, recursive=recursive)
 
 
-def export(name, shell=config.SHELL, resolve=False, scope=None, clear=False):
-    """Returns environment commands that can be sourced.
+def clear(
+    name=config.DEFAULT_NAMESPACE,
+    shell=config.SHELL,
+    scope=None,
+):
+    """Returns shell commands that can be sourced to unset or restore env stack
+    environment variables. Should only be run after a previous export:
 
-       $ source <(envstack --export)
+        $ source <(envstack --export)
+        $ source <(envstack --clear)
 
-    or to clear existing values:
+    List of shell names: bash, sh, tcsh, cmd, pwsh
+    (see output of config.detect_shell()).
 
-        $ source <(envstack --clear)
+    :param name: stack namespace.
+    :param shell: name of shell (default: current shell).
+    :param scope: environment scope (default: cwd).
+    :returns: shell commands as string.
+    """
+    if "ENVSTACK" not in os.environ:
+        logger.log.info("Environment is already clear")
+        return ""
+
+    env = load_environ(name, environ=None, scope=scope)
+    export_vars = dict(env.items())
+    export_list = list()
+
+    # vars that should never be unset
+    restricted_vars = ["PATH", "PS1", "PWD", "PROMPT", "DEFAULT_ENV_DIR"]
+
+    for key in export_vars:
+        if key not in os.environ:
+            continue
+        old_key = f"_ES_OLD_{key}"
+        old_val = os.environ.get(old_key)
+        if shell in ["bash", "sh", "zsh"]:
+            if old_val:
+                export_list.append("export %s=%s" % (key, old_val))
+                export_list.append("unset %s" % (old_key))
+            elif key not in restricted_vars:
+                export_list.append(f"unset {key}")
+        elif shell == "tcsh":
+            if old_val:
+                export_list.append(f"setenv {key} {old_val}")
+                export_list.append(f"unsetenv {old_key}")
+            elif key not in restricted_vars:
+                export_list.append(f"unsetenv {key}")
+        elif shell == "cmd":
+            if old_val:
+                export_list.append(f"set {key}={old_val}")
+                export_list.append(f"set {old_key}=")
+            elif key not in restricted_vars:
+                export_list.append(f"set {key}=")
+        elif shell == "pwsh":
+            if old_val:
+                export_list.append(f"$env:{key}='{old_val}'")
+                export_list.append(f"Remove-Item Env:{old_key}")
+            elif key not in restricted_vars:
+                export_list.append(f"Remove-Item Env:{key}")
+        elif shell == "unknown":
+            raise Exception("unknown shell")
+
+    export_list.sort()
+    exp = "\n".join(export_list)
+
+    return exp
+
+
+def export(
+    name=config.DEFAULT_NAMESPACE,
+    shell=config.SHELL,
+    scope=None,
+):
+    """Returns shell set env commands that can be sourced to set env stack
+    environment variables.
 
     List of shell names: bash, sh, tcsh, cmd, pwsh
     (see output of config.detect_shell()).
 
     :param name: stack namespace.
     :param shell: name of shell (default: current shell).
-    :param resolve: resolve values (default: True).
     :param scope: environment scope (default: cwd).
-    :param clear: clear existing values (default: False).
     :returns: shell commands as string.
     """
     env = load_environ(name, scope=scope)
-    expList = list()
-    for k, v in env.items():
-        if resolve:
-            v = expandvars(v, env, recursive=False)
+    export_vars = dict(env.items())
+    export_list = list()
+
+    for key, val in export_vars.items():
+        val = expandvars(val, env, recursive=False)
+        old_key = f"_ES_OLD_{key}"
+        old_val = os.environ.get(key)
+        if key == "PATH" and not val:
+            logger.log.warning("PATH is empty")
+            continue
         if shell in ["bash", "sh", "zsh"]:
-            if clear:
-                expList.append(f"unset {k}")
-            else:
-                expList.append(f'export {k}="{v}"')
+            export_list.append(f"export {key}={val}")
+            if old_val:
+                export_list.append(f"export {old_key}={old_val}")
         elif shell == "tcsh":
-            if clear:
-                expList.append(f"unsetenv {k}")
-            else:
-                expList.append(f'setenv {k}:"{v}"')
+            export_list.append(f'setenv {key}:"{val}"')
+            if old_val:
+                export_list.append(f'setenv {old_key}:"{old_val}"')
         elif shell == "cmd":
-            if clear:
-                expList.append(f"set {k}=")
-            else:
-                expList.append(f'set {k}="{v}"')
+            export_list.append(f'set {key}="{val}"')
+            if old_val:
+                export_list.append(f'set {old_key}="{old_val}"')
         elif shell == "pwsh":
-            if clear:
-                expList.append(f"Remove-Item Env:{k}")
-            else:
-                expList.append(f'$env:{k}="{v}"')
+            export_list.append(f'$env:{key}="{val}"')
+            if old_val:
+                export_list.append(f'$env:{old_key}="{old_val}"')
         elif shell == "unknown":
             raise Exception("unknown shell")
-    expList.sort()
-    exp = "\n".join(expList)
+
+    export_list.sort()
+    exp = "\n".join(export_list)
+
     return exp
 
 
 def save():
-    """Saves the current environment."""
+    """Saves the current environment for later restoration."""
     global SAVED_ENVIRONMENT
     if not SAVED_ENVIRONMENT:
         SAVED_ENVIRONMENT = dict(os.environ.copy())
@@ -593,56 +662,62 @@ def save():
 
 
 def revert():
-    """Reverts the environment to the saved environment."""
+    """Reverts the environment to the saved environment. Updates sys.path using
+    paths found in PYTHONPATH.
+
+    Initialize the default environment stack:
+    >>> envstack.init()
+
+    Revert to the previous environment:
+    >>> envstack.revert()
+    """
     global SAVED_ENVIRONMENT
     if SAVED_ENVIRONMENT is None:
         return
+
+    # clear current sys.path values
+    util.clear_sys_path()
+
+    # restore the original environment
     os.environ.clear()
     os.environ.update(SAVED_ENVIRONMENT)
 
+    # restore sys.path from PYTHONPATH
+    util.load_sys_path()
+
+    SAVED_ENVIRONMENT = None
+
 
 def init(name=config.DEFAULT_NAMESPACE):
-    """Initializes the environment for a given namespace. Modifies sys.path
-    from PYTHONPATH.
+    """Initializes the environment from a given stack namespace. Environments
+    propogate downwards with subsequent calls to init().
 
-        # initialize the default environemnt
-        >>> envstack.init()
+    Updates sys.path using paths found in PYTHONPATH.
 
-        # initialize the dev environment
-        >>> envstack.init('dev')
+    Initialize the default environment stack:
+    >>> envstack.init()
 
-        # revert to the original environment
-        >>> envstack.revert()
+    Initialize the dev environment stack (inherits from previous call):
+    >>> envstack.init('dev')
 
-    :param name: stack namespace (default stack).
-    """
-    logger.log.debug("initializing env stack: %s", name)
+    Revert to the original environment:
+    >>> envstack.revert()
 
-    # save the current environment
+    :param name: stack namespace (default: 'stack').
+    :param reset: clear existing values first (default: False).
+    """
+    # save environment to restore later using envstack.revert()
     save()
 
     # clear old sys.path values
-    for path in util.get_paths_from_var("PYTHONPATH"):
-        if path and path in sys.path:
-            sys.path.remove(path)
-
-    # clear vars from stack namespace
-    env = load_environ(name, environ=None)
-    for key in env.keys():
-        if key in os.environ:
-            del os.environ[key]
+    util.clear_sys_path()
 
-    # store the name of the environment stack (e.g. for $PS1)
-    os.environ["ENVSTACK"] = name
-
-    # load the new environment
+    # load the stack and update the environment
     env = load_environ(name)
     os.environ.update(encode(env))
 
     # update sys.path from PYTHONPATH
-    for path in util.get_paths_from_var("PYTHONPATH"):
-        if path and path not in sys.path:
-            sys.path.insert(0, path)
+    util.load_sys_path()
 
 
 def load_environ(
@@ -672,7 +747,6 @@ def load_environ(
     :param includes: merge included namespaces.
     :returns: dict of environment variables.
     """
-
     # build list of sources from namespace(s) and scope
     if not sources:
         sources = build_sources(name, scope=scope, includes=includes)
@@ -687,6 +761,9 @@ def load_environ(
     for source in sources:
         env.update(source.load(platform=platform))
 
+    # store the name of the environment stack
+    env["ENVSTACK"] = env.get("ENVSTACK", "|".join(name))
+
     # merge values from given environment
     if environ:
         return merge(env, environ, platform=platform)

{envstack-0.6.3 → envstack-0.6.4}/lib/envstack/util.py

@@ -34,6 +34,31 @@ Contains common utility functions and classes.
 """
 
 import os
+import sys
+
+
+def clear_sys_path(var="PYTHONPATH"):
+    """
+    Remove paths from sys.path that are in the given environment variable.
+
+    :param var: The environment variable to remove paths from.
+    """
+    for path in get_paths_from_var(var):
+        if path and path in sys.path:
+            sys.path.remove(path)
+
+
+def load_sys_path(var="PYTHONPATH", pathsep=os.pathsep, reverse=True):
+    """
+    Add paths from the given environment variable to sys.path.
+
+    :param var: The environment variable to add paths from.
+    :param pathsep: The path separator to use.
+    :param reverse: Reverse the order of the paths.
+    """
+    for path in get_paths_from_var(var, pathsep, reverse):
+        if path and path not in sys.path:
+            sys.path.insert(0, path)
 
 
 def dict_diff(dict1, dict2):

{envstack-0.6.3 → envstack-0.6.4/lib/envstack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.6.3
+Version: 0.6.4
 Summary: Stacked environment variable management system
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: PyYAML>=5.1.2
+Requires-Dist: PyYAML==5.1.2
 
 envstack
 ========
@@ -303,7 +303,7 @@ the output of the `--export` command:
 
 #### bash
 ```bash
-alias envstack-set='source <(envstack "$1" --export)';
+alias envstack-init='source <(envstack --export)';
 ```
 
 #### cmd
@@ -311,13 +311,13 @@ alias envstack-set='source <(envstack "$1" --export)';
 doskey envstack-set=for /f "usebackq" %i in (`envstack --export $*`) do %%i
 ```
 
-Then you can set the environment stack in your shell with the `envstack-set`
+Then you can set the environment stack in your shell with the `envstack-init`
 command. To clear the environment in your current shell, create an alias that
 sources the output of the `--clear` command:
 
 #### bash
 ```bash
-alias envstack-clear='source <(envstack "$1" --clear)';
+alias envstack-clear='source <(envstack --clear)';
 ```
 
 #### cmd
@@ -325,18 +325,6 @@ alias envstack-clear='source <(envstack "$1" --clear)';
 doskey envstack-clear=for /f "usebackq" %i in (`envstack --clear $*`) do %%i
 ```
 
-Create a function for convenience that does both in one command:
-
-#### bash
-```bash
-envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
-```
-
-#### cmd
-```cmd
-doskey envstack-init=envstack-clear $* & envstack-set $*
-```
-
 ## Config
 
 Default config settings are in the config.py module. The following environment

envstack-0.6.4/lib/envstack.egg-info/requires.txt

@@ -0,0 +1 @@
+PyYAML==5.1.2

{envstack-0.6.3 → envstack-0.6.4}/setup.py

@@ -74,7 +74,7 @@ class PostInstallCommand(install):
 
 setup(
     name="envstack",
-    version="0.6.3",
+    version="0.6.4",
     description="Stacked environment variable management system",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -106,7 +106,7 @@ setup(
         ],
     },
     install_requires=[
-        "PyYAML>=5.1.2",
+        "PyYAML==5.1.2",
     ],
     python_requires=">=3.6",
     data_files=[(".", ["stack.env", "dev.env", "dist.json"])],

envstack-0.6.3/lib/envstack.egg-info/requires.txt

@@ -1 +0,0 @@
-PyYAML>=5.1.2