Merge pull request #7 from andrewsg/config

rename appengine_config to env_config as the name conflicts with appengi...

Author: andrewsg

multicore_runtime/middleware.py

@@ -34,7 +34,7 @@
 
 
 def reset_environment_middleware(app, frozen_environment, frozen_user_env,
-                                 frozen_appengine_config_env):
+                                 frozen_env_config_env):
   """Replace the contents of os.environ with a frozen env + request data.
 
   This requires a single-threaded webserver, or for os.environ to be patched to
@@ -47,7 +47,7 @@ def reset_environment_middleware(app, frozen_environment, frozen_user_env,
       `tuple(os.environ.iteritems())` produces appropriate output.
     frozen_user_env: An iterable of (key, value) tuples that can be used to
       populate os.environ with environment variables specified in app.yaml.
-    frozen_appengine_config_env: An iterable of (key, value) tuples that can be
+    frozen_env_config_env: An iterable of (key, value) tuples that can be
       used to populate os.environ with configuration-dependent env variables.
 
   Returns:
@@ -71,8 +71,8 @@ def reset_environment_wrapper(wsgi_env, start_response):  # pylint: disable=miss
     # Add in wsgi_env data, including request headers.
     os.environ.update(request_environment_for_wsgi_env(wsgi_env))
 
-    # Add in configuration data from appengine_config.
-    os.environ.update(frozen_appengine_config_env)
+    # Add in configuration data from env_config.
+    os.environ.update(frozen_env_config_env)
 
     # Add reserved keys, which draw from wsgi_env as well. These have a very
     # high priority and so are added nearly last.

multicore_runtime/wsgi.py

@@ -25,26 +25,26 @@
 
 from dispatcher import dispatcher
 from middleware import reset_environment_middleware
-from wsgi_config import env_vars_from_appengine_config
+from wsgi_config import env_vars_from_env_config
 from wsgi_config import get_module_config
 from wsgi_config import get_module_config_filename
 from wsgi_config import load_user_scripts_into_handlers
 from wsgi_config import ThreadLocalDict
-from wsgi_config import user_env_vars_from_appinfo_external
+from wsgi_config import user_env_vars_from_appinfo
 
 from google.appengine.ext.vmruntime import vmconfig
 from google.appengine.ext.vmruntime import vmstub
 
 logging.basicConfig(level=logging.INFO)
 
-appinfo_external = get_module_config(get_module_config_filename())
-appengine_config = vmconfig.BuildVmAppengineEnvConfig()
+appinfo = get_module_config(get_module_config_filename())
+env_config = vmconfig.BuildVmAppengineEnvConfig()
 
 # Ensure API requests include a valid ticket by default.
-vmstub.Register(vmstub.VMStub(appengine_config.default_ticket))
+vmstub.Register(vmstub.VMStub(env_config.default_ticket))
 
 # Load user code.
-preloaded_handlers = load_user_scripts_into_handlers(appinfo_external.handlers)
+preloaded_handlers = load_user_scripts_into_handlers(appinfo.handlers)
 
 # Now that all scripts are fully imported, it is safe to use asynchronous
 # API calls.
@@ -57,16 +57,16 @@
 frozen_environment = tuple(os.environ.iteritems())
 
 # Also freeze user env vars specified in app.yaml. Later steps to modify the
-# environment such as env_vars_from_appengine_config and request middleware
+# environment such as env_vars_from_env_config and request middleware
 # will overwrite these changes. This is added to the environment in
 # `reset_environment_middleware`.
 frozen_user_env = tuple(
-    user_env_vars_from_appinfo_external(appinfo_external).iteritems())
+    user_env_vars_from_appinfo(appinfo).iteritems())
 
-# Also freeze environment data from appengine_config. This is added to the
+# Also freeze environment data from env_config. This is added to the
 # environment in `reset_environment_middleware`.
-frozen_appengine_config_env = tuple(
-    env_vars_from_appengine_config(appengine_config).iteritems())
+frozen_env_config_env = tuple(
+    env_vars_from_env_config(env_config).iteritems())
 
 # Monkey-patch os.environ to be thread-local. This is for backwards
 # compatibility with GAE's use of environment variables to store request data.
@@ -86,4 +86,4 @@
 # Reset os.environ to the frozen state and add request-specific data.
 meta_app = reset_environment_middleware(meta_app, frozen_environment,
                                         frozen_user_env,
-                                        frozen_appengine_config_env)
+                                        frozen_env_config_env)

multicore_runtime/wsgi_config.py

@@ -60,10 +60,10 @@ def app_wrapped_in_user_middleware(app):
 def get_add_middleware_from_appengine_config():
   """Tries to import appengine_config and return middleware; fails silently.
 
-  `appengine_config` is optionally part of GAE-compatible user code.
+  `env_config` is optionally part of GAE-compatible user code.
   If the user chooses to define the `webapp_add_wsgi_middleware` function
   there, then we will use it to wrap app scripts. This is used for e.g.
-  appstats. Many user apps do not have or need appengine_config, so failure
+  appstats. Many user apps do not have or need env_config, so failure
   to import it or failure to find `webapp_add_wsgi_middleware` is not an
   error.
 
@@ -81,7 +81,7 @@ def get_add_middleware_from_appengine_config():
 
 
 def load_user_scripts_into_handlers(handlers):
-  """Preloads user scripts, wrapped in appengine_config middleware if present.
+  """Preloads user scripts, wrapped in env_config middleware if present.
 
   Args:
     handlers: appinfo_external.handlers data as provided by get_module_config()
@@ -103,45 +103,45 @@ def load_user_scripts_into_handlers(handlers):
   return loaded_handlers
 
 
-def env_vars_from_appengine_config(appengine_config):
+def env_vars_from_env_config(env_config):
   """Generate a dict suitable for updating os.environ to reflect app config.
 
   This function only returns a dict and does not update os.environ directly.
 
   Args:
-    appengine_config: The app configuration as generated by
-                      vmconfig.BuildVmAppengineEnvConfig()
+    env_config: The app configuration as generated by
+                vmconfig.BuildVmAppengineEnvConfig()
 
   Returns:
     A dict of strings suitable for e.g. `os.environ.update(values)`.
   """
 
-  return {'SERVER_SOFTWARE': appengine_config.server_software,
+  return {'SERVER_SOFTWARE': env_config.server_software,
           'APPENGINE_RUNTIME': 'python27',
-          'APPLICATION_ID': '%s~%s' % (appengine_config.partition,
-                                       appengine_config.appid),
-          'INSTANCE_ID': appengine_config.instance,
-          'BACKEND_ID': appengine_config.major_version,
-          'CURRENT_MODULE_ID': appengine_config.module,
-          'CURRENT_VERSION_ID': '%s.%s' % (appengine_config.major_version,
-                                           appengine_config.minor_version),
-          'DEFAULT_TICKET': appengine_config.default_ticket}
+          'APPLICATION_ID': '%s~%s' % (env_config.partition,
+                                       env_config.appid),
+          'INSTANCE_ID': env_config.instance,
+          'BACKEND_ID': env_config.major_version,
+          'CURRENT_MODULE_ID': env_config.module,
+          'CURRENT_VERSION_ID': '%s.%s' % (env_config.major_version,
+                                           env_config.minor_version),
+          'DEFAULT_TICKET': env_config.default_ticket}
 
 
-def user_env_vars_from_appinfo_external(appinfo_external):
+def user_env_vars_from_appinfo(appinfo):
   """Generate a dict of env variables specified by the user in app.yaml.
 
   This function only returns a dict and does not update os.environ directly.
 
   Args:
-    appinfo_external: The app.yaml configuration info as generated by
-                      get_module_config()
+    appinfo: The configuration info (a parsed yaml object) as generated by
+              get_module_config()
 
   Returns:
     A dict of strings suitable for e.g. `os.environ.update(values)`.
   """
 
-  return appinfo_external.env_variables or {}
+  return appinfo.env_variables or {}
 
 
 # Dictionary with thread-local contents.