如何在Python中更改TestCase类的文档字符串？

Question

在 Python 2.5（实际上是 Jython）中，对于 UnitTest TestCase 类 - 没有 SetUpClass 方法，并且 __init__ 并不真正可接受（不引用 self）。 当我尝试更改 TestCase 内的文档字符串时：

import os
fileName = os.path.split(__file__)[1]
testCaseName = os.path.splitext(fileName)[0]
setattr(__name__, '__doc__', testCaseName)

我得到：

setattr(__name__, '__doc__', testCaseName)
TypeError: readonly attribute

我尝试通过将文档字符串实例化为对象来更改文档字符串（其中 self.__doc__ 是可写的）。

更新：但我想避免额外的编码 在子类中（即继承 设置文档字符串的超类函数 子类），例如：

File DynamicTestCase.py 包括：

class DynamicTestCase(unittest.TestCase):
    def setDocstring(self, testCaseDocstring=None):
        if not testCaseDocstring:
            fileName = os.path.split(__file__)[1]
            testCaseDocstring = os.path.splitext(fileName)[0]
        setattr(self, '__doc__', testCaseDocstring)

File MyTestCase.py 包括：

class MyTestCase(DynamicTestCase):
    def test_print_docstring(self):
        self.setDocstring()
        print 'MyTestCase Docstring = ', self.__doc__

但是，单元测试运行结果仍然是：

MyTestCase Docstring = DynamicTestCase

当我预期时 MyTestCase Docstring = MyTestCase

Answer 1

更新 - __file__ 是加载当前模块的路径名，因此自然会在 DynamicTestCase 中使用 __file__ 。 py 将生成路径 DynamicTestCase.py。但是，您可以将路径从子类传递到 setDocstring()，如下所示：

DynamicTestCase.py:

class DynamicTestCase(unittest.TestCase):
    def setDocstring(self, docstring=None):
        if docstring is None:
            docstring = __file__
        if os.path.exists(docstring):
            name = os.path.split(docstring)[1]
            docstring = os.path.splitext(name)[0]
        setattr(self, '__doc__', docstring)

MyTestCase.py:

class MyTestCase(DynamicTestCase):
    def __init__(self, *args, **kwargs):
        DynamicTestCase.__init__(self, *args, **kwargs)
        self.setDocstring(__file__)

    def test_print_docstring(self):
        print 'MyTestCase Docstring = ', self.__doc__

    def test_new_docstring(self):
        self.setDocstring('hello')
        print 'MyTestCase Docstring = ', self.__doc__

Output:

MyTestCase Docstring =  MyTestCase
MyTestCase Docstring =  hello

---

其余答案

在上面的原始代码中，__name__是一个字符串，而不是一个类。 Jython 正确地拒绝更改 str 类型上的 __doc__ 属性。

您能否解释一下为什么您想要更改 TestCase 的文档字符串？例如，您可以子类化 TestCase 并给出您自己的文档字符串：

class MyTestCase(unittest.TestCase):
    "Docstring of MyTestCase"

不确定您是否已经尝试过，但是 unittest2 包的 TestCase 具有setUpClass、tearDownClass 类方法。它是 Python 2.7 改进的向后移植，可与 Python 2.6 及更早版本一起使用。

Jython 允许您设置新式类的 __doc__ ，但 CPython 不允许。因此，如果您希望代码可移植，您可能需要找到另一种方法来实现您的目标：

Jython 2.2.1 on java1.6.0_24
>>> unittest.TestCase.__doc__ = 'foo bar'
>>> unittest.TestCase.__doc__
'foo bar'

Python 2.6.6 (r266:84292, Feb 12 2011, 01:07:21)
>>> unittest.TestCase.__doc__ = 'foo bar'
AttributeError: attribute '__doc__' of 'type' objects is not writable

Answer 2

您正在获取 DynamicTestCase 文件的文件名，而不是调用该函数的文件。为了得到它，你必须进入它的堆栈框架：

  import inspect

  class DynamicTestCase(unittest.TestCase):
    def setDocstring(self, testCaseDocstring=None):
        if not testCaseDocstring:
            fileName = 'unknown.py'

            # Go up one stack frame and grab the file name
            stack = inspect.stack()
            try:
                frame = stack[1][0]
                fileName = frame.f_code.co_filename        
            finally:
                del stack

            testCaseDocstring = os.path.splitext(fileName)[0]