File: class-sqlobject.manager.command.CommandRecord.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 (375 lines) | stat: -rw-r--r-- 18,684 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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

  <h1 class="pudge-member-page-heading">
    <tt>CommandRecord</tt>
  </h1>
  <p class="pudge-member-parent-link">
    <small>
    The CommandRecord class is accessible via the
    <a href="module-sqlobject.manager.command.html">
      <tt>sqlobject.manager.command</tt>
    </a> module.
    </small>
  </p>
  <div id="pudge-section-nav">
  <ul>
    <li>
      <a href="#attributes" class="pudge-section-link">
        Attributes (13)
      </a>
    </li><li>
      <a href="#methods" class="pudge-section-link">
        Methods (26)
      </a>
    </li>
    <li>
      <a href="sqlobject/manager/command.py.html?f=905&amp;l=1167#905" class="pudge-section-link">
        Source
      </a>
    </li>
  </ul>
  </div>
  <div style="clear: left"></div>
  <hr>
    <a name="attributes"></a>
    <h2>Attributes</h2>
    <div class="pudge-member name">
    <a name="min_args"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#min_args" class="pudge-obj-link">min_args</a></tt></h4>
    <div class="pudge-section rst">
      <pre>0</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="help"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#help" class="pudge-obj-link">help</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'Record state of table definitions.  The state of each table is written out to a separate file in a directory, and that directory forms a "version".  A table is also added to your database (sqlobject_db_version) that reflects the version the database is currently at.  Use the upgrade command to sync databases with code.'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="parser"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#parser" class="pudge-obj-link">parser</a></tt></h4>
    <div class="pudge-section rst">
      <pre>&lt;optparse.OptionParser instance at 0xb64e78ac></pre>
    </div>
  </div><div class="pudge-member name">
    <a name="aliases"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#aliases" class="pudge-obj-link">aliases</a></tt></h4>
    <div class="pudge-section rst">
      <pre>()</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="max_args"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#max_args" class="pudge-obj-link">max_args</a></tt></h4>
    <div class="pudge-section rst">
      <pre>0</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="max_args_error"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#max_args_error" class="pudge-obj-link">max_args_error</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'You must provide no more than %(max_args)s arguments'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="description"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#description" class="pudge-obj-link">description</a></tt></h4>
    <div class="pudge-section rst">
      <pre>None</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="prog_name"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#prog_name" class="pudge-obj-link">prog_name</a></tt></h4>
    <div class="pudge-section rst">
      <pre>&lt;property object at 0xb64c50f4></pre>
    </div>
  </div><div class="pudge-member name">
    <a name="name"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#name" class="pudge-obj-link">name</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'record'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="summary"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#summary" class="pudge-obj-link">summary</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'Record historical information about the database status'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="min_args_error"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#min_args_error" class="pudge-obj-link">min_args_error</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'You must provide at least %(min_args)s arguments'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="version_regex"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#version_regex" class="pudge-obj-link">version_regex</a></tt></h4>
    <div class="pudge-section rst">
      <pre>&lt;_sre.SRE_Pattern object at 0xb64e9120></pre>
    </div>
  </div><div class="pudge-member name">
    <a name="required_args"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#required_args" class="pudge-obj-link">required_args</a></tt></h4>
    <div class="pudge-section rst">
      <pre>[]</pre>
    </div>
  </div>
    <a name="methods"></a>
    <h2>Methods</h2>
    <div class="pudge-member routine alias">
    <a name="__sizeof__"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#__sizeof__" class="pudge-obj-link">__sizeof__</a>(...)</tt>
      <a href="__builtin__.py.html" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      __sizeof__() -> int
size of object in memory, in bytes
    </p>
    </div>
  </div><div class="pudge-member routine alias">
    <a name="__format__"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#__format__" class="pudge-obj-link">__format__</a>(...)</tt>
      <a href="__builtin__.py.html" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      default object formatter
    </p>
    </div>
  </div><div class="pudge-member routine alias">
    <a name="__subclasshook__"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#__subclasshook__" class="pudge-obj-link">__subclasshook__</a>(...)</tt>
      <a href="None.html" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      Abstract classes can override this to customize issubclass().
    </p>
    <p>This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented.  If it returns
NotImplemented, the normal algorithm is used.  Otherwise, it
overrides the normal algorithm (and the outcome is cached).</p>
    </div>
  </div><div class="pudge-member routine ">
    <a name="orderClassesByDependencyLevel"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#orderClassesByDependencyLevel" class="pudge-obj-link">orderClassesByDependencyLevel</a>(self, classes)</tt>
      <a href="sqlobject/manager/command.py.html?f=200&amp;l=275#200" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      Return classes ordered by their depth in the class dependency
tree (this is <em>not</em> the inheritance tree), from the
top level (independant) classes to the deepest level.
The dependency tree is defined by the foreign key relations.
    </p>
    </div>
  </div><div class="pudge-member routine ">
    <a name="__classinit__"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#__classinit__" class="pudge-obj-link">__classinit__</a>(cls, new_args)</tt>
      <a href="sqlobject/manager/command.py.html?f=276&amp;l=281#276" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="__init__"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#__init__" class="pudge-obj-link">__init__</a>(self, invoked_as, command_name, args, runner)</tt>
      <a href="sqlobject/manager/command.py.html?f=282&amp;l=287#282" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="run"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#run" class="pudge-obj-link">run</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=288&amp;l=324#288" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="classes"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#classes" class="pudge-obj-link">classes</a>(self, require_connection=True, require_some=False)</tt>
      <a href="sqlobject/manager/command.py.html?f=325&amp;l=383#325" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="classes_from_module"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#classes_from_module" class="pudge-obj-link">classes_from_module</a>(self, module)</tt>
      <a href="sqlobject/manager/command.py.html?f=384&amp;l=399#384" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="connection"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#connection" class="pudge-obj-link">connection</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=400&amp;l=411#400" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="config"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#config" class="pudge-obj-link">config</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=412&amp;l=424#412" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="ini_config"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#ini_config" class="pudge-obj-link">ini_config</a>(self, conf_fn)</tt>
      <a href="sqlobject/manager/command.py.html?f=425&amp;l=467#425" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="classes_from_package"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#classes_from_package" class="pudge-obj-link">classes_from_package</a>(self, package_name)</tt>
      <a href="sqlobject/manager/command.py.html?f=468&amp;l=501#468" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="classes_from_egg"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#classes_from_egg" class="pudge-obj-link">classes_from_egg</a>(self, egg_spec)</tt>
      <a href="sqlobject/manager/command.py.html?f=502&amp;l=514#502" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="load_options_from_egg"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#load_options_from_egg" class="pudge-obj-link">load_options_from_egg</a>(self, egg_spec)</tt>
      <a href="sqlobject/manager/command.py.html?f=515&amp;l=522#515" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="config_from_egg"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#config_from_egg" class="pudge-obj-link">config_from_egg</a>(self, egg_spec, warn_no_sqlobject=True)</tt>
      <a href="sqlobject/manager/command.py.html?f=523&amp;l=542#523" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="ask"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#ask" class="pudge-obj-link">ask</a>(self, prompt, safe=False, default=True)</tt>
      <a href="sqlobject/manager/command.py.html?f=550&amp;l=564#550" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="shorten_filename"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#shorten_filename" class="pudge-obj-link">shorten_filename</a>(self, fn)</tt>
      <a href="sqlobject/manager/command.py.html?f=565&amp;l=573#565" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      Shortens a filename to make it relative to the current
directory (if it can).  For display purposes.
    </p>
    </div>
  </div><div class="pudge-member routine ">
    <a name="open_editor"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#open_editor" class="pudge-obj-link">open_editor</a>(self, pretext, breaker=None, extension='.txt')</tt>
      <a href="sqlobject/manager/command.py.html?f=574&amp;l=595#574" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      Open an editor with the given text.  Return the new text,
or None if no edits were made.  If given, everything after
    <cite>breaker</cite>
   will be ignored.
    </p>
    </div>
  </div><div class="pudge-member routine ">
    <a name="command"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#command" class="pudge-obj-link">command</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=955&amp;l=1079#955" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="update_db"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#update_db" class="pudge-obj-link">update_db</a>(self, version, conn)</tt>
      <a href="sqlobject/manager/command.py.html?f=1080&amp;l=1096#1080" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="strip_comments"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#strip_comments" class="pudge-obj-link">strip_comments</a>(self, sql)</tt>
      <a href="sqlobject/manager/command.py.html?f=1097&amp;l=1101#1097" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="base_dir"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#base_dir" class="pudge-obj-link">base_dir</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=1102&amp;l=1116#1102" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="find_output_dir"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#find_output_dir" class="pudge-obj-link">find_output_dir</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=1117&amp;l=1136#1117" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="find_last_version"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#find_last_version" class="pudge-obj-link">find_last_version</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=1137&amp;l=1147#1137" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="command_force_db_version"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="class-sqlobject.manager.command.CommandRecord.html#command_force_db_version" class="pudge-obj-link">command_force_db_version</a>(self)</tt>
      <a href="sqlobject/manager/command.py.html?f=1148&amp;l=1167#1148" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div>
  <p>
    <small>
    See 
    <a href="sqlobject/manager/command.py.html?f=905&amp;l=1167#905" title="sqlobject/manager/command.py:905">the source</a>
    for more information.
    </small>
  </p>