envstack 0.6.2__tar.gz → 0.6.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.6.2
+Version: 0.6.3
 Summary: Stacked environment variable management system
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -184,19 +184,34 @@ $ envstack [STACK] --sources
 
 ## Python API
 
-To init the environment stack, use the `init` function:
+To initialize the environment stack in Python, use the `init` function:
 
 ```python
->>> envstack.init("thing")
->>> os.getenv("FOO")
-'bar'
+>>> envstack.init()
+>>> os.getenv("HELLO")
+'world'
+```
+
+To initialize the "dev" stack:
+
+```python
+>>> envstack.init("dev")
+>>> os.getenv("ENV")
+'dev'
+```
+
+To revert the original environment:
+
+```python
+>>> envstack.revert()
+>>> os.getenv("HELLO")
+>>> 
 ```
 
 Alternatively, `envstack.getenv` can be a drop-in replacement for `os.getenv`
 for the default environment stack:
 
 ```python
->>> import envstack
 >>> envstack.getenv("HELLO")
 'world'
 ```

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

@@ -161,19 +161,34 @@ $ envstack [STACK] --sources
 
 ## Python API
 
-To init the environment stack, use the `init` function:
+To initialize the environment stack in Python, use the `init` function:
 
 ```python
->>> envstack.init("thing")
->>> os.getenv("FOO")
-'bar'
+>>> envstack.init()
+>>> os.getenv("HELLO")
+'world'
+```
+
+To initialize the "dev" stack:
+
+```python
+>>> envstack.init("dev")
+>>> os.getenv("ENV")
+'dev'
+```
+
+To revert the original environment:
+
+```python
+>>> envstack.revert()
+>>> os.getenv("HELLO")
+>>> 
 ```
 
 Alternatively, `envstack.getenv` can be a drop-in replacement for `os.getenv`
 for the default environment stack:
 
 ```python
->>> import envstack
 >>> envstack.getenv("HELLO")
 'world'
 ```

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

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

{envstack-0.6.2 → envstack-0.6.3}/lib/envstack/config.py

@@ -76,14 +76,13 @@ DEFAULT_ENV = {
     "USER": USERNAME,
 }
 
-# default location of envstack files
-# NOTE: the siteconf sitecustomize.py module may override this
+# default location of env stack .env files
 DEFAULT_ENV_DIR = os.getenv(
     "DEFAULT_ENV_DIR",
     {
-        "darwin": "{HOME}/Library/Application Support/envstack",
-        "linux": "{HOME}/.local/envstack",
-        "windows": "C:\\ProgramData\\envstack",
+        "darwin": "{HOME}/Library/Application Support/pipe/{ENV}/env",
+        "linux": "{HOME}/.local/pipe/{ENV}/env",
+        "windows": "C:\\ProgramData\\pipe\\{ENV}\\env",
     }
     .get(PLATFORM)
     .format(**DEFAULT_ENV),

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

@@ -36,8 +36,9 @@ Contains functions and classes for processing scoped .env files.
 import os
 import re
 import string
+import sys
 
-from envstack import config, logger, path
+from envstack import config, logger, path, util
 from envstack.exceptions import *
 
 # value delimiter pattern (splits values by colons or semicolons)
@@ -49,6 +50,9 @@ load_file_cache = {}
 # value for unresolvable variables
 null = ""
 
+# stores the original environment
+SAVED_ENVIRONMENT = None
+
 
 class EnvVar(string.Template, str):
     """A string class for supporting $-substitutions, e.g.: ::
@@ -529,7 +533,7 @@ def expandvars(var, env=None, recursive=False):
     return EnvVar(var).expand(env, recursive=recursive)
 
 
-def export(name, shell="bash", resolve=False, scope=None, clear=False):
+def export(name, shell=config.SHELL, resolve=False, scope=None, clear=False):
     """Returns environment commands that can be sourced.
 
        $ source <(envstack --export)
@@ -542,7 +546,7 @@ def export(name, shell="bash", resolve=False, scope=None, clear=False):
     (see output of config.detect_shell()).
 
     :param name: stack namespace.
-    :param shell: name of shell (default: bash).
+    :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).
@@ -580,14 +584,66 @@ def export(name, shell="bash", resolve=False, scope=None, clear=False):
     return exp
 
 
+def save():
+    """Saves the current environment."""
+    global SAVED_ENVIRONMENT
+    if not SAVED_ENVIRONMENT:
+        SAVED_ENVIRONMENT = dict(os.environ.copy())
+        return SAVED_ENVIRONMENT
+
+
+def revert():
+    """Reverts the environment to the saved environment."""
+    global SAVED_ENVIRONMENT
+    if SAVED_ENVIRONMENT is None:
+        return
+    os.environ.clear()
+    os.environ.update(SAVED_ENVIRONMENT)
+
+
 def init(name=config.DEFAULT_NAMESPACE):
-    """Initializes the environment for a given namespace.
+    """Initializes the environment for a given namespace. Modifies sys.path
+    from PYTHONPATH.
 
-    :param name: namespace (basename of env files).
+        # initialize the default environemnt
+        >>> envstack.init()
+
+        # initialize the dev environment
+        >>> envstack.init('dev')
+
+        # revert to the original environment
+        >>> envstack.revert()
+
+    :param name: stack namespace (default stack).
     """
+    logger.log.debug("initializing env stack: %s", name)
+
+    # save the current environment
+    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]
+
+    # store the name of the environment stack (e.g. for $PS1)
+    os.environ["ENVSTACK"] = name
+
+    # load the new 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)
+
 
 def load_environ(
     name=config.DEFAULT_NAMESPACE,
@@ -688,9 +744,11 @@ def merge(env, other, strict=False, platform=config.PLATFORM):
     """
     merged = env.copy()
     for key, value in merged.items():
-        var = "${%s}" % key
+        varstr = "${%s}" % key
+        # replace variables in other with values from env
         if key in other:
-            if var in str(value):
+            # replace variables in value with values from other
+            if varstr in str(value):
                 value = re.sub(
                     r"\${(\w+)}",
                     lambda match: other.get(match.group(1), match.group(0)),
@@ -699,7 +757,8 @@ def merge(env, other, strict=False, platform=config.PLATFORM):
             elif not strict:
                 value = other.get(key)
         else:
-            value = str(value).replace(var, "")
+            value = str(value).replace(varstr, "")
+        # replace colons with semicolons on windows
         if platform == "windows":
             result = re.sub(r"(?<!\b[A-Za-z]):", ";", str(value))
             value = result.rstrip(";")

envstack-0.6.3/lib/envstack/util.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, Ryan Galloway (ryan@rsgalloway.com)
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  - Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  - Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  - Neither the name of the software nor the names of its contributors
+#    may be used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+__doc__ = """
+Contains common utility functions and classes.
+"""
+
+import os
+
+
+def dict_diff(dict1, dict2):
+    """
+    Compare two dictionaries and return their differences.
+
+    :param dict1: First dictionary.
+    :param dict2: Second dictionary.
+    :returns: diff dict: 'added', 'removed', 'changed', and 'unchanged'.
+    """
+    added = {k: dict2[k] for k in dict2 if k not in dict1}
+    removed = {k: dict1[k] for k in dict1 if k not in dict2}
+    changed = {
+        k: (dict1[k], dict2[k]) for k in dict1 if k in dict2 and dict1[k] != dict2[k]
+    }
+    unchanged = {k: dict1[k] for k in dict1 if k in dict2 and dict1[k] == dict2[k]}
+
+    return {
+        "added": added,
+        "removed": removed,
+        "changed": changed,
+        "unchanged": unchanged,
+    }
+
+
+def get_paths_from_var(var="PYTHONPATH", pathsep=os.pathsep, reverse=True):
+    """Returns a list of paths from a given pathsep separated environment
+    variable.
+
+    :param var: The environment variable to get paths from.
+    :param pathsep: The path separator to use.
+    :param reverse: Reverse the order of the paths.
+    :returns: A list of paths.
+    """
+
+    paths = []
+    value = os.environ.get(var)
+
+    if value:
+        paths = value.split(pathsep)
+
+        if reverse:
+            paths.reverse()
+
+    return paths

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.6.2
+Version: 0.6.3
 Summary: Stacked environment variable management system
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -184,19 +184,34 @@ $ envstack [STACK] --sources
 
 ## Python API
 
-To init the environment stack, use the `init` function:
+To initialize the environment stack in Python, use the `init` function:
 
 ```python
->>> envstack.init("thing")
->>> os.getenv("FOO")
-'bar'
+>>> envstack.init()
+>>> os.getenv("HELLO")
+'world'
+```
+
+To initialize the "dev" stack:
+
+```python
+>>> envstack.init("dev")
+>>> os.getenv("ENV")
+'dev'
+```
+
+To revert the original environment:
+
+```python
+>>> envstack.revert()
+>>> os.getenv("HELLO")
+>>> 
 ```
 
 Alternatively, `envstack.getenv` can be a drop-in replacement for `os.getenv`
 for the default environment stack:
 
 ```python
->>> import envstack
 >>> envstack.getenv("HELLO")
 'world'
 ```

{envstack-0.6.2 → envstack-0.6.3}/lib/envstack.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ lib/envstack/env.py
 lib/envstack/exceptions.py
 lib/envstack/logger.py
 lib/envstack/path.py
+lib/envstack/util.py
 lib/envstack/wrapper.py
 lib/envstack.egg-info/PKG-INFO
 lib/envstack.egg-info/SOURCES.txt

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

@@ -74,7 +74,7 @@ class PostInstallCommand(install):
 
 setup(
     name="envstack",
-    version="0.6.2",
+    version="0.6.3",
     description="Stacked environment variable management system",
     long_description=long_description,
     long_description_content_type="text/markdown",