File: module-sqlobject.events-index.html

package info (click to toggle)
sqlobject 3.1.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 9,280 kB
  • ctags: 17,912
  • sloc: python: 16,713; sh: 18; makefile: 13
file content (259 lines) | stat: -rw-r--r-- 10,233 bytes parent folder | download
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
  <head>
    <meta content="text/html; charset=utf-8" http-equiv="content-type">
<title>Index of sqlobject.events module</title>
    <link href="layout.css" type="text/css" rel="stylesheet">
  </head>
  <body>
    <div id="page">
      <h1 class="doc-title"><a></a></h1>
      <div id="navcontainer">
		    <ul id="navlist">
          <li class="pagenav">
            <ul>
              <li class="page_item">
                <a href="index.html" title="Project Home / Index">SQLObject</a>
              </li>
              <li class="page_item">
                <a href="module-index.html" title="sqlobject package and module reference">Modules</a>
              </li>
              <li>
                <a href="community.html" title="Mailing List">Discuss</a>
              </li>
	      <li>
	        <a href="SQLObject.html">Documentation</a>
	      </li>
            </ul>
          </li>
        </ul>
      </div>
      <hr>
      <div id="content">
  <h1>Index of the <tt>events</tt> module</h1>
  <ul class="pudge-module-index">
    <li class="module">
    <span class="prefix">m</span>
    <a href="module-sqlobject.events.html">
      <tt>sqlobject.events</tt>
    </a>
    <a href="sqlobject/events.py.html">...</a>
    <small></small>
    <ul>
      <li class="attribute">
    <span class="prefix">a</span>
    <a href="module-sqlobject.events.html#__package__">
      <tt>__package__</tt>
    </a>
    <a href="sqlobject/events.py.html">...</a>
    <small></small>
  </li>
      <li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowCreateSignal.html">
      <tt>RowCreateSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=79&amp;l=91#79">...</a>
    <small>
      - <span class="rst">Called before an instance is created, with the class as the
sender.  Called with the arguments <tt class="docutils literal">(instance, kwargs, post_funcs)</tt>.
There may be a <tt class="docutils literal">connection</tt> argument.  <tt class="docutils literal"><span class="pre">kwargs``may</span> be usefully
modified.  ``post_funcs</tt> is a list of callbacks, intended to have
functions appended to it, and are called with the arguments
<tt class="docutils literal">(new_instance)</tt>.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.CreateTableSignal.html">
      <tt>CreateTableSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=190&amp;l=202#190">...</a>
    <small>
      - <span class="rst">Called when a table is created.  If <tt class="docutils literal"><span class="pre">ifNotExists==True</span></tt> and the
table exists, this event is not called.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowDestroyedSignal.html">
      <tt>RowDestroyedSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=131&amp;l=141#131">...</a>
    <small>
      - <span class="rst">Called after an instance is deleted.  Sender is the instance's
class.  Arguments are <tt class="docutils literal">(instance)</tt>.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.AddColumnSignal.html">
      <tt>AddColumnSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=164&amp;l=173#164">...</a>
    <small>
      - <span class="rst">Called when a column is added to a class, with arguments <tt class="docutils literal">(cls,
connection, column_name, column_definition, changeSchema,
post_funcs)</tt>.  This is called <em>after</em> the column has been added,
and is called for each column after class creation.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.DeleteColumnSignal.html">
      <tt>DeleteColumnSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=175&amp;l=185#175">...</a>
    <small>
      - <span class="rst">Called when a column is removed from a class, with the arguments
<tt class="docutils literal">(cls, connection, column_name, so_column_obj, post_funcs)</tt>.
Like <tt class="docutils literal">AddColumnSignal</tt> this is called after the action has been
performed, and is called for subclassing (when a column is
implicitly removed by setting it to <tt class="docutils literal">None</tt>).</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.DropTableSignal.html">
      <tt>DropTableSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=204&amp;l=213#204">...</a>
    <small>
      - <span class="rst">Called when a table is dropped.  If <tt class="docutils literal"><span class="pre">ifExists==True</span></tt> and the
table doesn't exist, this event is not called.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowCreatedSignal.html">
      <tt>RowCreatedSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=93&amp;l=105#93">...</a>
    <small>
      - <span class="rst">Called after an instance is created, with the class as the
sender.  Called with the arguments <tt class="docutils literal">(instance, kwargs, post_funcs)</tt>.
There may be a <tt class="docutils literal">connection</tt> argument.  <tt class="docutils literal"><span class="pre">kwargs``may</span> be usefully
modified.  ``post_funcs</tt> is a list of callbacks, intended to have
functions appended to it, and are called with the arguments
<tt class="docutils literal">(new_instance)</tt>.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowDestroySignal.html">
      <tt>RowDestroySignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=109&amp;l=129#109">...</a>
    <small>
      - <span class="rst">Called before an instance is deleted.  Sender is the instance's
class.  Arguments are <tt class="docutils literal">(instance, post_funcs)</tt>.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.ClassCreateSignal.html">
      <tt>ClassCreateSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=38&amp;l=55#38">...</a>
    <small>
      - <span class="rst">Signal raised after class creation.  The sender is the superclass
(in case of multiple superclasses, the first superclass).  The
arguments are <tt class="docutils literal">(new_class_name, bases, new_attrs, post_funcs,
early_funcs)</tt>.  <tt class="docutils literal">new_attrs</tt> is a dictionary and may be modified
(but <tt class="docutils literal">new_class_name</tt> and <tt class="docutils literal">bases</tt> are immutable).
<tt class="docutils literal">post_funcs</tt> is an initially-empty list that can have callbacks
appended to it.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.Signal.html">
      <tt>Signal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=29&amp;l=36#29">...</a>
    <small>
      - <span class="rst">Base event for all SQLObject events.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowUpdateSignal.html">
      <tt>RowUpdateSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=143&amp;l=151#143">...</a>
    <small>
      - <span class="rst">Called when an instance is updated through a call to <tt class="docutils literal">.set()</tt>
(or a column attribute assignment).  The arguments are
<tt class="docutils literal">(instance, kwargs)</tt>.  <tt class="docutils literal">kwargs</tt> can be modified.  This is run
<em>before</em> the instance is updated; if you want to look at the
current values, simply look at <tt class="docutils literal">instance</tt>.</span>
  </small>
    <ul>
    </ul>
  </li><li class="class">
    <span class="prefix">C</span>
    <a href="class-sqlobject.events.RowUpdatedSignal.html">
      <tt>RowUpdatedSignal</tt>
    </a>
    <a href="sqlobject/events.py.html?f=153&amp;l=162#153">...</a>
    <small>
      - <span class="rst">Called when an instance is updated through a call to <tt class="docutils literal">.set()</tt>
(or a column attribute assignment).  The arguments are
<tt class="docutils literal">(instance, post_funcs)</tt>. <tt class="docutils literal">post_funcs</tt> is a list of callbacks,
intended to have functions appended to it, and are called with the
arguments <tt class="docutils literal">(new_instance)</tt>. This is run <em>after</em> the instance is
updated; Works better with lazyUpdate = True.</span>
  </small>
    <ul>
    </ul>
  </li>
      <li class="routine">
    <span class="prefix">f</span>
    <a href="module-sqlobject.events.html#listen">
      <tt>listen</tt>
    </a>
    <a href="sqlobject/events.py.html?f=12&amp;l=24#12">...</a>
    <small>
      - <span class="rst">Listen for the given <tt class="docutils literal">signal</tt> on the SQLObject subclass
<tt class="docutils literal">soClass</tt>, calling <tt class="docutils literal">receiver()</tt> when <tt class="docutils literal">send(soClass, signal,
<span class="pre">...)</span></tt> is called.</span>
  </small>
  </li>
    </ul>
  </li>
  </ul>
</div>
      <div id="footer">
        <p style="float: left;">
          built with 
          <a href="http://lesscode.org/projects/pudge/">pudge/0.1.3</a> |
		      original design by 
          <a href="http://blog.ratterobert.com/">ratter / robert</a>
	      </p>
        <div>
        <br> <!--
        <a name="search">
          <form method="get" id="searchform" 
                action="http://lesscode.org/blog/index.php">
            <div>
              <input type="text" value="" name="s" id="s" />
              <input type="submit" id="searchsubmit" value="Search" />
            </div>
          </form>
        </a> -->
        <br>
        </div>
      </div>
    </div>
  </body>
</html>