using python module: doctest

using python module: doctest

• 1.
  doctest Testing throughdocumentation Honggang Wang @ Aragon Nov 2010
• 2.
  Getting Started #foo.py
• 3.
  def multiply(a, b):
• 4.
  “””
• 5.
  This is ademo function.
• 6.
  >>> multiply(3, 4)
• 7.
  12
• 8.
  >>> multiply('a', 5)
• 9.
  'aaaaa'
• 10.
  “””
• 11.
  return a *b $ python foo.py
• 12.
  $ python -vfoo.py
• 13.
  $ python -mdoctest -v foo.py
• 14.
  Trying:
• 15.
  multiply(3, 4)
• 16.
  Expecting:
• 17.
  12
• 18.
  ok
• 19.
  ...
• 20.
  2 passed and0 failed.
• 21.
  Test passed. Runtest
• 22.
  Handling Unpredictable OutputSometimes the exact output may not be predictable. e.g. Local date and time values
• 23.
  Object ids
• 24.
  Precision of floatvalues
• 25.
  Exceptions
• 26.
  And more...
• 27.
  Handling Unpredictable Output# unpredictable.py
• 28.
  class A(object):
• 29.
  pass
• 30.
  def gene_list(obj):
• 31.
  “””
• 32.
  Put obj intoa list.
• 33.
  >>> gene_list(A())
• 34.
  [<unpredictable.A object at0x9c2214c>]
• 35.
  “””
• 36.
  return [obj]
• 37.
  Handling Unpredictable Output# unpredictable2.py
• 38.
  class A(object):
• 39.
  pass
• 40.
  def gene_list(obj):
• 41.
  “””
• 42.
  Put obj intoa list.
• 43.
  >>> gene_list(A()) #doctest: +ELLIPSIS
• 44.
  [<unpredictable2.A object at0x...>]
• 45.
  “””
• 46.
  return [obj]
• 47.
  Working Around Whitespace# double_space.py
• 48.
  def double_space(lines):
• 49.
  &quot;&quot;&quot;Prints a listof lines double-spaced.
• 50.
  >>> double_space(['Line one.','Line two.'])
• 51.
  Line one.
• 52.
  Line two.
• 53.
  &quot;&quot;&quot;
• 54.
  for l inlines:
• 55.
  print l
• 56.
  print
• 57.
  return
• 58.
  Working Around Whitespace# double_space2.py
• 59.
  def double_space(lines):
• 60.
  &quot;&quot;&quot;Prints a listof lines double-spaced.
• 61.
  >>> double_space(['Line one.','Line two.'])
• 62.
  Line one.
• 63.
  <BLANKLINE>
• 64.
  Line two.
• 65.
  <BLANKLINE>
• 66.
  &quot;&quot;&quot;
• 67.
  for l inlines:
• 68.
  print l
• 69.
  print
• 70.
  return
• 71.
  Test Locations #test_location.py
• 72.
  “””
• 73.
  >>> A ==B
• 74.
  False
• 75.
  “””
• 76.
  class A(object): pass
• 77.
  class B(object): pass
• 78.
  Test Locations #test_location2.py
• 79.
  from b_cls importB
• 80.
  __test__ = {
• 81.
  'test001': “””
• 82.
  >>> A.__class__
• 83.
  <type 'type'>
• 84.
  “”” ,
• 85.
  'external': B,
• 86.
  }
• 87.
  class A(object):
• 88.
  pass # b_cls.py
• 89.
  “””
• 90.
  >>> 1 +1
• 91.
  3
• 92.
  “””
• 93.
  class B(object):
• 94.
  “”” Theclass B.
• 95.
  >>> B.__name__
• 96.
  B
• 97.
  “””
• 98.
  pass
• 99.
  External Documentation #foo2.py
• 100.
  def multiply(a, b):
• 101.
  return a *b ===============
• 102.
  How to usefoo2.py
• 103.
  ===============
• 104.
  For numbers:
• 105.
  >>> from foo2import multiply
• 106.
  >>> multiply(3, 7)
• 107.
  21
• 108.
  It also workswith strings:
• 109.
  >>> multiply('s', 7)
• 110.
  sssssss foo2.rst
• 111.
  External Documentation $python -m doctest -v foo2.rst Run test using foo2.rst
• 112.
  Running Tests #utils.py
• 113.
  def add(a, b):
• 114.
  return a +b
• 115.
  if __name__ ==“__main__”:
• 116.
  import doctest
• 117.
  doctest.testmod() By module# other_script.py
• 118.
  import utils
• 119.
  if __name__ ==“__main__”:
• 120.
  import doctest
• 121.
  doctest.testmod(utils)
• 122.
  Running Tests #other_script.py
• 123.
  import doctest
• 124.
  if __name__ ==“__main__”:
• 125.
  doctest.testfile(' foo2.rst ')By file
• 126.
  Unittest Suite #doctest_unittest.py
• 127.
  import doctest
• 128.
  import unittest
• 129.
  import doctest_simple
• 130.
  suite = unittest.TestSuite()
• 131.
  suite.addTest(doctest.DocTestSuite(doctest_simple))
• 132.
  suite.addTest(doctest.DocFileSuite('doctest_in_help.rst'))
• 133.
  runner = unittest.TextTestRunner(verbosity=2)
• 134.
  runner.run(suite)
• 135.
  Unittest Suite $python doctest_unittest.py
• 136.
  my_function (doctest_simple)
• 137.
  Doctest: doctest_simple.my_function ...ok
• 138.
  doctest_in_help.rst
• 139.
  Doctest: doctest_in_help.rst ...ok
• 140.
  ----------------------------------------------------------------------
• 141.
  Ran 2 testsin 0.006s
• 142.
  OK
• 143.
  Test Context classTestGlobals(object):
• 144.
  def one(self):
• 145.
  &quot;&quot;&quot;
• 146.
  >>> var ='value'
• 147.
  >>> 'var' inglobals()
• 148.
  True
• 149.
  &quot;&quot;&quot;
• 150.
  def two(self):
• 151.
  &quot;&quot;&quot;
• 152.
  >>> 'var' inglobals()
• 153.
  False
• 154.
  &quot;&quot;&quot; Each testsource (function, class, module) has its own set of global values.
• 155.
  Test Context $python -m doctest -v doctest_test_globals.py
• 156.
  Trying:
• 157.
  var = 'value'
• 158.
  Expecting nothing
• 159.
  ok
• 160.
  ...
• 161.
  2 items passedall tests:
• 162.
  2 tests indoctest_test_globals.TestGlobals.one
• 163.
  1 tests indoctest_test_globals.TestGlobals.two
• 164.
  3 tests in4 items.
• 165.
  3 passed and0 failed.
• 166.
  Test passed.
• 167.
  Test Context _module_data= {}
• 168.
  class TestGlobals(object):
• 169.
  def one(self):
• 170.
  &quot;&quot;&quot;
• 171.
  >>> TestGlobals().one()
• 172.
  >>> 'var' in_module_data
• 173.
  True
• 174.
  &quot;&quot;&quot;
• 175.
  _module_data['var'] = 'value'
• 176.
  def two(self):
• 177.
  &quot;&quot;&quot;
• 178.
  >>> 'var' in_module_data
• 179.
  False
• 180.
  &quot;&quot;&quot;
• 181.
  Test Context $python -m doctest -v doctest_mutable_globals.py
• 182.
  ...
• 183.
  Failed example:
• 184.
  'var' in _module_data
• 185.
  Expected:
• 186.
  False
• 187.
  Got:
• 188.
  True
• 189.
  ...
• 190.
  3 tests in4 items.
• 191.
  2 passed and1 failed.
• 192.
  ***Test Failed*** 1failures.
• 193.
  Thanks!