From: Fred Drake <fdrake@acm.org>
Date: Tue, 21 Dec 2004 23:46:34 +0000 (+0000)
Subject: add __file__ to the globals available for tests loaded via DocFileSuite;
X-Git-Tag: v2.5a0~2234
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7c404a4bf7b9061ee013bef361b6eba951218d80;p=thirdparty%2FPython%2Fcpython.git

add __file__ to the globals available for tests loaded via DocFileSuite;
this is useful for locating supporting data files, just as it is in Python
modules
---

diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index b982a73e54cc..0f32f7dc891e 100644
--- a/Doc/lib/libdoctest.tex
+++ b/Doc/lib/libdoctest.tex
@@ -1107,6 +1107,10 @@ instances from text files and modules with doctests:
   defaults to a normal parser (i.e., \code{\class{DocTestParser}()}).
 
   \versionadded{2.4}
+
+  Starting in Python 2.5, the global \code{__file__} was added to the
+  globals provided to doctests loaded from a text file using
+  \function{DocFileSuite()}.
 \end{funcdesc}
 
 \begin{funcdesc}{DocTestSuite}{\optional{module}\optional{,
diff --git a/Lib/doctest.py b/Lib/doctest.py
index 0a13d77586a9..2708fc7da069 100644
--- a/Lib/doctest.py
+++ b/Lib/doctest.py
@@ -2328,6 +2328,8 @@ def DocFileTest(path, module_relative=True, package=None,
                 globs=None, parser=DocTestParser(), **options):
     if globs is None:
         globs = {}
+    else:
+        globs = globs.copy()
 
     if package and not module_relative:
         raise ValueError("Package may only be specified for module-"
@@ -2337,6 +2339,8 @@ def DocFileTest(path, module_relative=True, package=None,
     if module_relative:
         package = _normalize_module(package)
         path = _module_relative_path(package, path)
+    if "__file__" not in globs:
+        globs["__file__"] = path
 
     # Find the file and read it.
     name = os.path.basename(path)
diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py
index 0ae6b8d18010..fe4d863b97af 100644
--- a/Lib/test/test_doctest.py
+++ b/Lib/test/test_doctest.py
@@ -2010,6 +2010,14 @@ def test_DocFileSuite():
        modified the test globals.  The test globals are
        automatically cleared for us after a test.
 
+       Tests in a file run using `DocFileSuite` can also access the
+       `__file__` global, which is set to the name of the file
+       containing the tests:
+
+         >>> suite = doctest.DocFileSuite('test_doctest3.txt')
+         >>> suite.run(unittest.TestResult())
+         <unittest.TestResult run=1 errors=0 failures=0>
+
        """
 
 def test_trailing_space_in_test():
diff --git a/Lib/test/test_doctest3.txt b/Lib/test/test_doctest3.txt
new file mode 100644
index 000000000000..54a96d58e143
--- /dev/null
+++ b/Lib/test/test_doctest3.txt
@@ -0,0 +1,5 @@
+
+Here we check that `__file__` is provided:
+
+  >>> type(__file__)
+  <type 'str'>