python doctest默认命名空间

时间:2011-10-07 01:03:59

标签: python nose doctest

在我的模块的doctests中,我想用完整的命名空间引用我的模块,例如:

  hp.myfunc(1)

我希望通过写下来避免使文档混乱:

  import healpy as hp

在每个doctests中。

如果我运行doctest.testmod,我知道我可以使用globs关键字来提供这个,而如果我运行鼻子,我可以使用setup函数。

是否有其他标准方法可以兼顾两者?

2 个答案:

答案 0 :(得分:3)

你如何运行doctests(没有鼻子,那是)?如果您在尝试运行它们时进入包目录,则会遇到问题(如果您正在进行完全导入,那就是)。

我能够通过nosetests和内置doctest运行器运行一个简单的doctest(使用完全限定的导入)。这是我的设置:

项目结构:

.
└── mypackage
    ├── __init__.py
    └── mod.py

以下是我的'mod.py'文件的内容:

"""foo() providing module

Example:
    >>> import mypackage.mod
    >>> mypackage.mod.foo()
    'bar'
"""

def foo():
    return "bar"

来自'。'目录(项目根目录),我现在可以运行测试:

$ python -m doctest -v mypackage/*.py
1 items had no tests:
    __init__
0 tests in 1 items.
0 passed and 0 failed.
Test passed.
Trying:
    import mypackage.mod
Expecting nothing
ok
Trying:
    mypackage.mod.foo()
Expecting:
    'bar'
ok
1 items had no tests:
    mod.foo
1 items passed all tests:
   2 tests in mod
2 tests in 2 items.
2 passed and 0 failed.
Test passed.

现在的鼻子测试:

$ nosetests --with-doctest
.
----------------------------------------------------------------------
Ran 1 test in 0.008s

OK

如果我尝试从'mypackage'目录中运行doctest,我会收到一个错误(我怀疑,在你的情况下发生了什么)。

最后,我认为这不应该有所作为,但我正在运行Python 2.7.2

答案 1 :(得分:2)

我不了解鼻子,但您可以使用globstestmod()中的testfile()参数。

这是一个简单的模块(名为foobar.py),请注意我不导入os

#!/usr/bin/python
"""
    >>> os.pipe
    <built-in function pipe>
"""

您可以像这样测试模块(控制台示例):

$ python2.7
Python 2.7.2 (default, Jun 29 2011, 11:10:00) 
[GCC 4.6.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import doctest, foobar
2
>>> doctest.testmod(foobar)  ## will fail as expected because os has not been imported
**********************************************************************
File "foobar.py", line 2, in foobar
Failed example:
    os.pipe
Exception raised:
    Traceback (most recent call last):
      File "/usr/lib/python2.7/doctest.py", line 1254, in __run
        compileflags, 1) in test.globs
      File "<doctest foobar[0]>", line 1, in <module>
        os.pipe
    NameError: name 'os' is not defined
**********************************************************************
1 items had failures:
   1 of   1 in foobar
***Test Failed*** 1 failures.
TestResults(failed=1, attempted=1)
>>> import os
>>> globs = {'os': os}
>>> doctest.testmod(foobar, globs=globs)
TestResults(failed=0, attempted=1)
>>> # Win :)

你的例子应该说:

globs = {'hp': healp}