Блог

У меня есть функция в Python. Я хотел бы задокументировать расположение одного или нескольких тестов для этой функции — может быть, в docstrings, может быть, в комментариях, может быть, где-нибудь в теле функции или над ним … на самом деле, подойдет любое место, близкое к телу функции.

Я хочу быстро найти, какие тесты были написаны для этой конкретной функции.

У меня есть соглашение об именовании тестов в моем проекте, но в некоторых случаях его быстро становится недостаточно.

Кроме того, поскольку я использую IDE для этого проекта, я хотел бы, чтобы он понимал эти ссылки на имена тестовых функций, чтобы я мог легко управлять щелчком мыши по местоположению тестовой функции.

Я просмотрел документацию Sphinx, но не нашел никаких тегов :test: , подобных или что-то в этом роде. Я мог бы задокументировать местоположение, используя :py:func: or :y:class: , но не похоже, что моя выбранная среда разработки (PyCharm) понимает эти перекрестные ссылки — если у меня есть строка like :param foo: , похоже, я могу ссылаться на классы, используя :py:class: .

Существуют ли какие-либо разумные, стандартизированные решения для этой моей маленькой проблемы? За исключением создания пользовательского тега для Sphinx, это точно — это сработает, но, скорее всего, PyCharm этого не поймет. У вас тоже была эта проблема? Что сработало для вас?

Редактировать: Я использую pytest , если это имеет значение.