Python for testers

Как параметризировать docstrings в Python?

Written by Михаил Поляруш on . Posted in Автоматизация, Работаю, Разработка

Зачастую автоматизаторы сталкиваются с проблемой вывода в логи нужной информации. Ко мне обратилась коллега с вопросом параметризации docstrings в python. Хочу просто подвести пунктиками, что можно, а что нельзя делать с docstrings.

  • Вы можете указывать docstrings для модуля, класса, функции, метода
  • Все описания docstrings идут сразу же после определения какой-то сущности, т.е. сразу после класса, функции и т.д.
  • docstrings не могут быть параметризированны
  • docstrings это только строка и не более того

Для того, чтобы вам продемонстрировать, как работает python docstrings посмотрите на этот код:

"""module docstring"""
import unittest

def function():
	"""function docstring"""
	pass

class LoginTestCase(unittest.TestCase):
	"""class docstring"""

	def testLogin(self):
		"""method docstring"""
		pass

if __name__ == "__main__":
	print __doc__
	print function.__doc__
	print LoginTestCase.testLogin.__doc__
	print LoginTestCase.__doc__

Но все же, если вам например, нужно в docstrings что-то заменить, то вы наверное захотите сделать это так.

"""module docstring %s """ % myvariable

К сожалению, так работать код у вас не будет и когда вы будете обращаться к docstrings, то объект будет с типом None. И все же как туда вставить нужные данные для того, чтобы использовать docstrings в своих нуждах? Просто надо работать с строкой docstrings и все. Пример, вам нужно использовать docstrings метода для вывода чего-то там в лог. Как вы это можете сделать?

"""module docstring"""
variable = "some string"
import unittest

def function():
	"""function docstring"""
	pass

class LoginTestCase(unittest.TestCase):
	"""class docstring"""
	def testLogin(self):
		"""method docstring %%replace%%"""
		print LoginTestCase.testLogin.__doc__.replace(r"%%replace%%", variable)
		pass

if __name__ == "__main__":
    import unittest
    unittest.main()

Т.е. вы указываете какую-то любую строку в docstrings, а потом ее заменяете на то что вам нужно в момент выполнения программы. Это конечно неидеальное решение потому как есть ряд побочных эффектов, но если вам действительно это необходимо, то можете пользоваться :)

Удачи и хорошего python программирования!

Tags: , ,

Trackback from your site.

  • http://twitter.com/KatyaJetnet Romanchuk Katya

    Очень полезная информация, спасибо.

  • Timur Nurlygayanov

    не проще ли тогда

    self.__doc__.replace(r”%%replace%%”, variable)

    (например, если мы используем nosetests + DDT) и имена тестов у нас динамические.

  • http://poliarush.com/ Mykhailo Poliarush

    ну можно по разному сделать, в зависимости от потребности
    python либеральный язык программирования и позволяет делать многое
    пример вообще был для doctest, но такая параметризация редко когда бывает
    и в случае с nosetests вообще может быть и не надо

  • Timur Nurlygayanov

    Да.
    С nosetest так не работает, приходится декораторами…

  • http://poliarush.com/ Mykhailo Poliarush

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

Twitter лента

autotestinfo

Как продолжить тест при случайном появлении попапа? http://t.co/tGqX8PjPzD

mpoliarush

http://t.co/9879JVgl21 automates tests written with QUnit, Jasmine, Mocha with Expect.js assertions, Dojo Objective Harness, or YUI Test.

Меня комментируют

Igor Vlasuyk

|

“Продолжительность 16 часов (2 дня)”
Это то есть 2 рабочих дня надо полностью быть на тренинге?
И на каком языке программирования будет практика?

Nataliia Koval

|

Большое спасибо! С расписанием вроде разобралась.

Chmel Viktor

|

Доброго дня

Nataliia Koval

|

Подскажите пожалуйста, после регистрации на сайте pearsonvue.com, как оплатить и выбрать дату и место сдачи? Там есть адреса центров сдачи экзамена. Звонить в эти центры?

Mykhailo Poliarush

|

так и есть, ошибочка, уже поправил

Что вас интересует на этом сайте?

View Results

Loading ... Loading ...