doctest Python для сценариев оболочки, которые проверяют синтаксический анализ аргументов, не загрязняя строку документации с помощью os.popen()

Только что нашел что-то похожее на нужный вам ответ: shell-doctest.

doctest предназначен для запуска кода Python, поэтому вам нужно где-то выполнить преобразование. Если вы полны решимости протестировать интерфейс командной строки напрямую через doctest, одна из возможностей — выполнить замену регулярного выражения на __doc__, прежде чем передать его argparse, чтобы удалить оболочку os.popen:

clean = re.sub(r"^>>> os\.popen\('(.*)'\).*", r"% \1", __doc__)
p = ArgumentParser(description=clean, ...)

(Конечно, есть множество более приятных способов сделать это, в зависимости от того, что вы считаете «хорошим»).

Это очистит его для конечного пользователя. Если вы также хотите, чтобы исходный код выглядел чище, вы можете пойти другим путем: поместить примеры командной строки в строку документации и не использовать doctest.testmodule(). Пропустите строку документации через doctest.script_from_examples и обработайте ее, чтобы вставить вызовы os. (Тогда вам нужно будет встроить его во что-то, чтобы вы могли протестировать его с помощью run_docstring_examples.) doctest не волнует, является ли ввод допустимым python, поэтому вы можете сделать следующее:

>>> print doctest.script_from_examples("""
Here is a commandline example I want converted:
>>> add -n 3 4
7
""")
# Here is a commandline example I want converted:
add -n 3 4
# Expected:
## 7

Это по-прежнему будет отображать подсказку python >>> в справке. Если вас это беспокоит, возможно, вам просто придется обрабатывать строку в обоих направлениях.

Вы также можете самостоятельно загрузить строку документации и выполнить команду, например in а>.

import sys

module = sys.modules[__name__]
docstring = module.__doc__
# search in docstring for certain regex, and check that the following line(s) matches a pattern.