Python doctest: пропустить весь блок? - PullRequest
Новая
       7

Python doctest: пропустить весь блок?

11 голосов
/ 27 ноября 2009

У меня есть модуль Python с строкой документации в методах класса и реальный пример в строке документации модуля. Различие состоит в том, что строки-метода были тщательно обработаны, чтобы быть полностью повторяемыми тестами, в то время как реальный пример является просто копией и копией истории из оболочки Linux, которая вызывала интерпретатор python. *

* 1003 Е.Г. * 

"""
Real-world example:

# python2.5
Python 2.5 (release25-maint, Jul 20 2008, 20:47:25)
[GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from packagename import module
>>> module.show_real_world_usage()
'Hello world!'
"""

class SomeClass(object):
    def someMethod(self):
        """
        >>> 1 == 1
        True
        """

Я хочу запустить doctest в SomeClass.someMethod, но не в строках документации модуля.

Директива Doctest +SKIP работает только на строку, что означало бы добавление 10-ти строк в мой пример из реальной жизни. Гадкий!

Есть ли способ заставить doctest пропустить весь блок? Немного похоже на <!-- ... --> в HTML?

Ответы [ 4 ]

16 голосов
/ 01 октября 2011

Оберните пример в функции, а затем пропустите вызов функции: 

"""
>>> def example():
...    from packagename import module
...    module.show_real_world_usage()
...
>>> example() # doctest: +SKIP
'Hello world!'
"""
6 голосов
/ 27 ноября 2009

Мое решение состояло в том, чтобы обрезать 3-символьных лидеров >>> и ..., где я хочу, чтобы doctest пропускал их, делая их 2-символьными.

So 

"""
>>> from packagename import module
>>> module.show_real_world_usage()
'Hello world!'
"""

стало 

"""
>> from packagename import module
>> module.show_real_world_usage()
'Hello world!'
"""

Epydoc не отображает это так же хорошо, как это делает doctests, но я могу жить с этим. Тем не менее, приветствуется указание пропустить до дальнейшего уведомления в doctest.

2 голосов
/ 05 марта 2019

Небольшой обходной путь, основанный на Ответ RobM сохраняет отображение / форматирование, начиная пример с такой >>>: 

""" 
>>>
>> from packagename import module 
>> module.show_real_world_usage() 
'Hello world!' 
"""
2 голосов
/ 27 ноября 2009

Если это не фактическая проверка документов каким-либо образом, вы можете просто присвоить значение переменной. Например, 

example_usage = """
Real-world example:

# python2.5
...
"""

приведет к тому, что этот "тест" не будет оцениваться.

Возможно, было бы лучше использовать __example_usage__ (или что-то еще, окруженное двойным подчеркиванием), чтобы было ясно, что это «волшебная» переменная, а не переменная, используемая в контексте скрипта.

...