Как программно установить docstring?

у меня есть функция-оболочка, которая возвращает функцию. Есть ли способ программно установить docstring возвращаемой функции? Если бы я мог написать __doc__ Я бы сделал следующее:

def wrapper(a):
    def add_something(b):
       return a + b
    add_something.__doc__ = 'Adds ' + str(a) + ' to `b`'
    return add_something

тогда я мог бы сделать

>>> add_three = wrapper(3)
>>> add_three.__doc__
'Adds 3 to `b`
С __doc__ доступно только для чтения, я не могу этого сделать. Каков правильный путь?

Edit: хорошо, я хотел сохранить это простым, но, конечно, это не то, что я на самом деле пытаюсь сделать. Хотя в целом __doc__ записывается в моем случае это не так.

Я пытаюсь создать тестовые наборы для unittest автоматически. У меня есть функция-обертка, которая создает объект класса, который является подклассом unittest.TestCase:

import unittest
def makeTestCase(filename, my_func):
    class ATest(unittest.TestCase):
        def testSomething(self):
            # Running test in here with data in filename and function my_func
            data  = loadmat(filename)
            result = my_func(data)
            self.assertTrue(result > 0)

    return ATest

если я создам этот класс и попытаюсь установить docstring testSomething Я получаю сообщение об ошибке:

>>> def my_func(): pass
>>> MyTest = makeTestCase('some_filename', my_func)
>>> MyTest.testSomething.__doc__ = 'This should be my docstring'
AttributeError: attribute '__doc__' of 'instancemethod' objects is not writable
40
docstring python

6 ответов

Я бы передал docstring в заводскую функцию и использовал type чтобы вручную построить класс.

def make_testcase(filename, myfunc, docstring):
    def test_something(self):
        data = loadmat(filename)
        result = myfunc(data)
        self.assertTrue(result > 0)

    clsdict = {'test_something': test_something,
               '__doc__': docstring}
    return type('ATest', (unittest.TestCase,), clsdict)

MyTest = makeTestCase('some_filename', my_func, 'This is a docstring')
16

An instancemethod получает свою docstring из своего __func__. Изменить строкой документации из __func__ вместо. (The __doc__ атрибут функций являются записываемыми.)

>>> class Foo(object):
...     def bar(self):
...         pass
...
>>> Foo.bar.__func__.__doc__ = "A super docstring"
>>> help(Foo.bar)
Help on method bar in module __main__:

bar(self) unbound __main__.Foo method
    A super docstring

>>> foo = Foo()
>>> help(foo.bar)
Help on method bar in module __main__:

bar(self) method of __main__.Foo instance
    A super docstring

С 2.7 docs:

пользовательские методы

определяемый пользователем объект метода объединяет класс, экземпляр класса (или нет) и любой вызываемый объект (обычно определяемая пользователем функция).

специальные атрибуты только для чтения: im_self-объект экземпляра класса, im_func-функция object; im_class-это класс im_self для связанных методов или класс, который запросил метод для несвязанных методов;__doc__ является документацией метода (такой же, как im_func.__doc__); __name__ - это имя метода (такое же, как im_func.__name__); __module__ - это имя модуля, в котором был определен метод, или нет, если он недоступен.

изменено в версии 2.2: im_self используется для ссылки на класс это определило метод.

изменено в версии 2.6: для 3.0 совместимость, im_func также __func__, и im_self as __self__.

43

это дополнение к тому, что __doc__ атрибут классов типа type невозможно изменить. Интересно, что это верно только до тех пор, пока класс создается с использованием type. Как только вы используете метакласс, вы можете просто изменить __doc__.

в примере используется модуль abc (AbstractBaseClass). Он работает с помощью специального ABCMeta метакласс

import abc

class MyNewClass(object):
    __metaclass__ = abc.ABCMeta

MyClass.__doc__ = "Changing the docstring works !"

help(MyNewClass)

в результате 

"""
Help on class MyNewClass in module __main__:

class MyNewClass(__builtin__.object)
 |  Changing the docstring works !
"""

Я предполагаю, что это должен быть комментарий, но все равно набираю первые 50 очков...

6

просто использовать декораторы. Вот ваш случай:

def add_doc(value):
    def _doc(func):
        func.__doc__ = value
        return func
    return _doc

import unittest
def makeTestCase(filename, my_func):
    class ATest(unittest.TestCase):
        @add_doc('This should be my docstring')
        def testSomething(self):
            # Running test in here with data in filename and function my_func
            data  = loadmat(filename)
            result = my_func(data)
            self.assertTrue(result > 0)

    return ATest

def my_func(): pass

MyTest = makeTestCase('some_filename', my_func)
print MyTest.testSomething.__doc__
> 'This should be my docstring'

вот похожий пример: динамическая справка Python и генерация автозаполнения

5

__doc__ не доступен для записи только тогда, когда ваш объект имеет тип "type".

в вашем случае, add_three - это функция, и вы можете просто установить __doc__ к любой строке.

4

в случае, когда вы пытаетесь автоматически генерировать unittest.Подклассы TestCase, у вас может быть больше пробега, переопределяющего их shortDescription метод.

Это метод, который удаляет базовую строку документа до первой строки, Как видно из обычного вывода unittest; переопределения было достаточно, чтобы дать нам контроль над тем, что появилось в таких инструментах отчетности, как TeamCity, что нам было нужно.

0