summaryrefslogtreecommitdiff
path: root/apidocs/testtools.assertions.html
blob: e74a33c219ce4b9d7b985c53f509a09ef81290bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
          "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>testtools.assertions : API documentation</title>

    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="bootstrap.min.css" type="text/css" rel="stylesheet" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
  </head>
  <body>

    <nav class="navbar navbar-default">
      <div class="container">
        <div class="navbar-header">
          <a href="index.html" class="navbar-brand">
            <a href="https://github.com/testing-cabal/testtools">testtools</a> API Documentation
          </a>
        </div>
      </div>
    </nav>

    <div class="container">

      <div class="page-header">
        <h1 class="module"><code>testtools.assertions</code> <small>module documentation</small></h1>

        <span id="partOf">
          Part of <code><a href="testtools.html" class="code">testtools</a></code>
          
          
        </span>
      </div>

      <div class="extrasDocstring">
        
      </div>

      <div class="moduleDocstring">
        <div class="undocumented">No module docstring</div>
      </div>

      <div id="splitTables">
        <table class="children sortable" id="id728">
  
  <tr class="function">
    
    <td>Function</td>
    <td><a href="testtools.assertions.html#assert_that" class="code">assert_that</a></td>
    <td><span>Assert that matchee is matched by matcher.</span></td>
  </tr>
</table>
        

          
      </div>

      <div id="childList">

        <div class="function">
  <a name="testtools.assertions.assert_that">
    
  </a>
  <a name="assert_that">
    
  </a>
  <div class="functionHeader">
    
    def
    assert_that(matchee, matcher, message='', verbose=False):
    
  </div>
  <div class="docstring functionBody">
    
    <div><p>Assert that matchee is matched by matcher.</p>
<p>This should only be used when you need to use a function based
matcher, assertThat in Testtools.Testcase is prefered and has more
features</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">matchee</td><td>An object to match with matcher.</td></tr><tr><td></td><td class="fieldArg">matcher</td><td>An object meeting the testtools.Matcher protocol.</td></tr><tr class="fieldStart"><td class="fieldName">Raises</td><td class="fieldArg">MismatchError</td><td>When matcher does not match thing.</td></tr></table></div>
  </div>
</div>

      </div>
      <address>
        <a href="index.html">API Documentation</a> for <a href="https://github.com/testing-cabal/testtools">testtools</a>, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-07-01 16:11:28.
      </address>

    </div>
  </body>
</html>