From be7a627c11ef0cca22e1a27c17f0396ea7bdd401 Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Fri, 11 Mar 2016 12:34:49 +0100
Subject: [PATCH 1/2] Make Spawner.env configurable

moves `_env_default` logic to `get_env`,
so that `Spawner.env` can be safely configurable
---
 jupyterhub/spawner.py | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/jupyterhub/spawner.py b/jupyterhub/spawner.py
index 9691fd2e..8c613904 100644
--- a/jupyterhub/spawner.py
+++ b/jupyterhub/spawner.py
@@ -116,14 +116,9 @@ class Spawner(LoggingConfigurable):
     ], config=True,
         help="Whitelist of environment variables for the subprocess to inherit"
     )
-    env = Dict()
-    def _env_default(self):
-        env = {}
-        for key in self.env_keep:
-            if key in os.environ:
-                env[key] = os.environ[key]
-        env['JPY_API_TOKEN'] = self.api_token
-        return env
+    env = Dict(config=True,
+        help="Environment variables to load into the Spawner environment."
+    )
     
     cmd = Command(['jupyterhub-singleuser'], config=True,
         help="""The command used for starting notebooks."""
@@ -204,12 +199,19 @@ class Spawner(LoggingConfigurable):
         self.api_token = ''
     
     def get_env(self):
-        """Return the environment we should use
-        
-        Default returns a copy of self.env.
+        """Return the environment dict to use for the Spawner.
+
+        This applies things like `env_keep`, anything defined in `Spawner.env`,
+        and adds the API token to the env.
+
         Use this to access the env in Spawner.start to allow extension in subclasses.
         """
-        return self.env.copy()
+        env = self.env.copy()
+        for key in self.env_keep:
+            if key in os.environ:
+                env[key] = os.environ[key]
+        env['JPY_API_TOKEN'] = self.api_token
+        return env
     
     def get_args(self):
         """Return the arguments to be passed after self.cmd"""

From d0f152064257b0f8cca07fc8e3805103e2990eaf Mon Sep 17 00:00:00 2001
From: Min RK <benjaminrk@gmail.com>
Date: Tue, 22 Mar 2016 13:48:26 +0100
Subject: [PATCH 2/2] Add Spawner.environment configurable

instead of making existing Spawner.env configurable

Spawner.env is deprecated
---
 jupyterhub/spawner.py | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/jupyterhub/spawner.py b/jupyterhub/spawner.py
index 8c613904..685679dc 100644
--- a/jupyterhub/spawner.py
+++ b/jupyterhub/spawner.py
@@ -116,8 +116,14 @@ class Spawner(LoggingConfigurable):
     ], config=True,
         help="Whitelist of environment variables for the subprocess to inherit"
     )
-    env = Dict(config=True,
-        help="Environment variables to load into the Spawner environment."
+    env = Dict(help="""Deprecated: use Spawner.get_env or Spawner.environment
+    
+    - extend Spawner.get_env for adding required env in Spawner subclasses
+    - Spawner.environment for config-specified env
+    """)
+    
+    environment = Dict(config=True,
+        help="Environment variables to load for the Spawner."
     )
     
     cmd = Command(['jupyterhub-singleuser'], config=True,
@@ -201,15 +207,23 @@ class Spawner(LoggingConfigurable):
     def get_env(self):
         """Return the environment dict to use for the Spawner.
 
-        This applies things like `env_keep`, anything defined in `Spawner.env`,
+        This applies things like `env_keep`, anything defined in `Spawner.environment`,
         and adds the API token to the env.
 
         Use this to access the env in Spawner.start to allow extension in subclasses.
         """
-        env = self.env.copy()
+        env = {}
+        if self.env:
+            warnings.warn("Spawner.env is deprecated, found %s" % self.env, DeprecationWarning)
+            env.update(self.env)
+        
         for key in self.env_keep:
             if key in os.environ:
                 env[key] = os.environ[key]
+        
+        # config overrides
+        env.update(self.environment)
+        
         env['JPY_API_TOKEN'] = self.api_token
         return env