DOC+BF: users environment dumped into doc build

matthew-brett · matthew-brett · commit e84acca16fe3 · 2017-03-17T13:22:06.000-07:00
The definition of the options method in the doctester has the user's
enviroment as a default variable, which then gets dumped into the doc
build, displaying your secret environment variables and so on.  Drop the
environment as a default variable.
diff --git a/nipy/testing/doctester.py b/nipy/testing/doctester.py
@@ -4,13 +4,17 @@
 --doctest-test``, because this file will be identified as containing tests.
 """
 from __future__ import absolute_import
+
 import re
+import os
+
 from doctest import register_optionflag
 
 import numpy as np
 # Import for testing structured array reprs
 from numpy import array  # noqa
 
+from nipy.utils import _NoValue
 from ..fixes.numpy.testing.noseclasses import (NumpyDoctest,
                                                NumpyOutputChecker)
 
@@ -208,3 +212,12 @@ class NipyDoctest(NumpyDoctest):
     def set_test_context(self, test):
         # set namespace for tests
         test.globs['np'] = np
+
+    def options(self, parser, env=_NoValue):
+        # Override option handling to take environment out of default values.
+        # Parent class has os.environ as default value for env.  This results
+        # in the environment being picked up and printed out in the built API
+        # documentation.  Remove this default, reset it inside the function.
+        if env is _NoValue:
+            env = os.environ
+        super(NipyDoctest, self).options(parser, env)
