summaryrefslogtreecommitdiff
path: root/apidocs/testtools.matchers._basic.Contains.html
blob: 5708ad03d6e3d5d8cd40f6565de654adaef10d25 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?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.matchers._basic.Contains : 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="class"><code>testtools.matchers._basic.Contains(<a href="testtools.matchers._impl.Matcher.html" class="code">Matcher</a>)</code> <small>class documentation</small></h1>

        <span id="partOf">
          Part of <code><a href="testtools.html" class="code">testtools</a>.<a href="testtools.matchers.html" class="code">matchers</a>.<a href="testtools.matchers._basic.html" class="code">_basic</a></code>
          
          <a href="classIndex.html#testtools.matchers._basic.Contains">(View In Hierarchy)</a>
        </span>
      </div>

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

      <div class="moduleDocstring">
        <div>Checks whether something is contained in another thing.<table class="fieldTable"></table></div>
      </div>

      <div id="splitTables">
        <table class="children sortable" id="id75">
  
  <tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.matchers._basic.Contains.html#__init__" class="code">__init__</a></td>
    <td><span>Create a Contains Matcher.</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.matchers._basic.Contains.html#__str__" class="code">__str__</a></td>
    <td><span>Get a sensible human representation of the matcher.</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.matchers._basic.Contains.html#match" class="code">match</a></td>
    <td><span>Return None if this matcher matches something, a Mismatch otherwise.</span></td>
  </tr>
</table>
        

          
      </div>

      <div id="childList">

        <div class="function">
  <a name="testtools.matchers._basic.Contains.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, needle):
    
  </div>
  <div class="docstring functionBody">
    
    <div>Create a Contains Matcher.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">needle</td><td>the thing that needs to be contained by matchees.</td></tr></table></div>
  </div>
</div><div class="function">
  <a name="testtools.matchers._basic.Contains.__str__">
    
  </a>
  <a name="__str__">
    
  </a>
  <div class="functionHeader">
    
    def
    __str__(self):
    
  </div>
  <div class="docstring functionBody">
    <div class="interfaceinfo">overrides <a href="testtools.matchers._impl.Matcher.html#__str__" class="code">testtools.matchers._impl.Matcher.__str__</a></div>
    <div><p>Get a sensible human representation of the matcher.</p>
<p>This should include the parameters given to the matcher and any
state that would affect the matches operation.</p><table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="testtools.matchers._basic.Contains.match">
    
  </a>
  <a name="match">
    
  </a>
  <div class="functionHeader">
    
    def
    match(self, matchee):
    
  </div>
  <div class="docstring functionBody">
    <div class="interfaceinfo">overrides <a href="testtools.matchers._impl.Matcher.html#match" class="code">testtools.matchers._impl.Matcher.match</a></div>
    <div>Return None if this matcher matches something, a Mismatch otherwise.<table class="fieldTable"></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>