-
Notifications
You must be signed in to change notification settings - Fork 0
/
models.html
341 lines (305 loc) · 19.1 KB
/
models.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module models</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>models</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/rachelchoi/Desktop/untitled%20folder/models.py">/Users/rachelchoi/Desktop/untitled folder/models.py</a></font></td></tr></table>
<p><tt>The module for all SQLAlchemy database models</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="re.html">re</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial">flask_sqlalchemy.Model(<a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="models.html#Author">Author</a>
</font></dt><dt><font face="helvetica, arial"><a href="models.html#Book">Book</a>
</font></dt><dt><font face="helvetica, arial"><a href="models.html#TeamMember">TeamMember</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Author">class <strong>Author</strong></a>(flask_sqlalchemy.Model)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An author of a book.<br>
<br>
Attributes:<br>
id primary key in the database<br>
first_name the first name of the author<br>
last_name the last name of the author<br>
bio bio of the author<br>
book_count # of books in the database by the author<br>
best_seller_date last date of best seller by author<br>
Books all books the author wrote<br>
link link to the author's image<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="models.html#Author">Author</a></dd>
<dd>flask_sqlalchemy.Model</dd>
<dd><a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Author-__init__"><strong>__init__</strong></a>(self, **kwargs)</dt><dd><tt>A simple constructor that allows initialization from kwargs.<br>
<br>
Sets attributes on the constructed instance using the names and<br>
values in ``kwargs``.<br>
<br>
Only keys that are present as<br>
attributes of the instance's class are allowed. These could be,<br>
for example, any mapped columns or relationships.</tt></dd></dl>
<dl><dt><a name="Author-get_html"><strong>get_html</strong></a>(self, search_term)</dt><dd><tt>Method to get html of authors relevant to the search term(s).</tt></dd></dl>
<dl><dt><a name="Author-get_link"><strong>get_link</strong></a>(self)</dt><dd><tt>Method to get link of the author page.</tt></dd></dl>
<dl><dt><a name="Author-to_dict"><strong>to_dict</strong></a>(self, query_instance=None)</dt><dd><tt>Method to convert sqlalchmey object to python dict<br>
Stolen from https://www.prahladyeri.com/blog/2015/07/sqlalchemy-hack-convert-dict.html</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>Books</strong></dt>
</dl>
<dl><dt><strong>best_seller_date</strong></dt>
</dl>
<dl><dt><strong>bio</strong></dt>
</dl>
<dl><dt><strong>book_count</strong></dt>
</dl>
<dl><dt><strong>first_name</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<dl><dt><strong>last_name</strong></dt>
</dl>
<dl><dt><strong>link</strong></dt>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__mapper__</strong> = <Mapper at 0x103e94198; Author></dl>
<dl><dt><strong>__searchable__</strong> = ['first_name', 'last_name', 'bio', 'link']</dl>
<dl><dt><strong>__table__</strong> = Table('author', MetaData(bind=None), Column('id'...String(length=256), table=<author>), schema=None)</dl>
<dl><dt><strong>__tablename__</strong> = 'author'</dl>
<hr>
Methods inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>query</strong></dt>
</dl>
<hr>
Data and other attributes inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>metadata</strong> = MetaData(bind=None)</dl>
<hr>
Data descriptors inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>query_class</strong> = <class 'flask_sqlalchemy.BaseQuery'><dd><tt>The default query object used for models, and exposed as<br>
:attr:`~SQLAlchemy.Query`. This can be subclassed and<br>
replaced for individual models by setting the :attr:`~Model.query_class`<br>
attribute. This is a subclass of a standard SQLAlchemy<br>
:class:`~sqlalchemy.orm.query.Query` class and has all the methods of a<br>
standard query as well.</tt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Book">class <strong>Book</strong></a>(flask_sqlalchemy.Model)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A <a href="#Book">Book</a> object to hold information.<br>
<br>
Attributes:<br>
id primary key for the book object<br>
isbn the isbn # for the book<br>
title title of the book<br>
summary summary of the book by new york times<br>
best_seller_date date it made best seller best_seller_list<br>
best_seller_list the lists or categorys it made the list for<br>
book_image url to the image for the book<br>
amazon_link url to the Amazon product page for the book<br>
author_id primary key to the books author for linking<br>
publisher publisher who published the book<br>
author author who wrote the book<br>
description the description of the book from Amazon<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="models.html#Book">Book</a></dd>
<dd>flask_sqlalchemy.Model</dd>
<dd><a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Book-__init__"><strong>__init__</strong></a>(self, **kwargs)</dt><dd><tt>A simple constructor that allows initialization from kwargs.<br>
<br>
Sets attributes on the constructed instance using the names and<br>
values in ``kwargs``.<br>
<br>
Only keys that are present as<br>
attributes of the instance's class are allowed. These could be,<br>
for example, any mapped columns or relationships.</tt></dd></dl>
<dl><dt><a name="Book-get_html"><strong>get_html</strong></a>(self, search_term)</dt><dd><tt>Method to get html of the books relevant to the search term(s).</tt></dd></dl>
<dl><dt><a name="Book-get_link"><strong>get_link</strong></a>(self)</dt><dd><tt>Method to get link of the book page.</tt></dd></dl>
<dl><dt><a name="Book-to_dict"><strong>to_dict</strong></a>(self, query_instance=None)</dt><dd><tt>Method to convert sqlalchmey object to python dict<br>
Stolen from https://www.prahladyeri.com/blog/2015/07/sqlalchemy-hack-convert-dict.html</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>amazon_link</strong></dt>
</dl>
<dl><dt><strong>author</strong></dt>
</dl>
<dl><dt><strong>author_id</strong></dt>
</dl>
<dl><dt><strong>best_seller_date</strong></dt>
</dl>
<dl><dt><strong>best_seller_list</strong></dt>
</dl>
<dl><dt><strong>book_image</strong></dt>
</dl>
<dl><dt><strong>description</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<dl><dt><strong>isbn</strong></dt>
</dl>
<dl><dt><strong>publisher</strong></dt>
</dl>
<dl><dt><strong>summary</strong></dt>
</dl>
<dl><dt><strong>title</strong></dt>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__mapper__</strong> = <Mapper at 0x103e94978; Book></dl>
<dl><dt><strong>__searchable__</strong> = ['isbn', 'title', 'summary', 'best_seller_list', 'book_image', 'amazon_link', 'publisher', 'description']</dl>
<dl><dt><strong>__table__</strong> = Table('book', MetaData(bind=None), Column('id', ...description', Text(), table=<book>), schema=None)</dl>
<dl><dt><strong>__tablename__</strong> = 'book'</dl>
<hr>
Methods inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>query</strong></dt>
</dl>
<hr>
Data and other attributes inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>metadata</strong> = MetaData(bind=None)</dl>
<hr>
Data descriptors inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>query_class</strong> = <class 'flask_sqlalchemy.BaseQuery'><dd><tt>The default query object used for models, and exposed as<br>
:attr:`~SQLAlchemy.Query`. This can be subclassed and<br>
replaced for individual models by setting the :attr:`~Model.query_class`<br>
attribute. This is a subclass of a standard SQLAlchemy<br>
:class:`~sqlalchemy.orm.query.Query` class and has all the methods of a<br>
standard query as well.</tt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="TeamMember">class <strong>TeamMember</strong></a>(flask_sqlalchemy.Model)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A <a href="#TeamMember">TeamMember</a> object for use latter to track changing statistics.<br>
<br>
Attributes:<br>
id primary key for <a href="#TeamMember">TeamMember</a><br>
image_url url of image for picture<br>
name name of user<br>
bio biography for user<br>
resp responsibilities<br>
issue # of issues created<br>
commits # of commits<br>
tests # of tests written<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="models.html#TeamMember">TeamMember</a></dd>
<dd>flask_sqlalchemy.Model</dd>
<dd><a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="TeamMember-__init__"><strong>__init__</strong></a>(self, **kwargs)</dt><dd><tt>A simple constructor that allows initialization from kwargs.<br>
<br>
Sets attributes on the constructed instance using the names and<br>
values in ``kwargs``.<br>
<br>
Only keys that are present as<br>
attributes of the instance's class are allowed. These could be,<br>
for example, any mapped columns or relationships.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>bio</strong></dt>
</dl>
<dl><dt><strong>commits</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<dl><dt><strong>image_url</strong></dt>
</dl>
<dl><dt><strong>issues</strong></dt>
</dl>
<dl><dt><strong>name</strong></dt>
</dl>
<dl><dt><strong>resp</strong></dt>
</dl>
<dl><dt><strong>tests</strong></dt>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__mapper__</strong> = <Mapper at 0x103e94f60; TeamMember></dl>
<dl><dt><strong>__table__</strong> = Table('team_member', MetaData(bind=None), Column...s', Integer(), table=<team_member>), schema=None)</dl>
<dl><dt><strong>__tablename__</strong> = 'team_member'</dl>
<hr>
Methods inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>query</strong></dt>
</dl>
<hr>
Data and other attributes inherited from flask_sqlalchemy.Model:<br>
<dl><dt><strong>metadata</strong> = MetaData(bind=None)</dl>
<hr>
Data descriptors inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="flask_sqlalchemy.html#Model">flask_sqlalchemy.Model</a>:<br>
<dl><dt><strong>query_class</strong> = <class 'flask_sqlalchemy.BaseQuery'><dd><tt>The default query object used for models, and exposed as<br>
:attr:`~SQLAlchemy.Query`. This can be subclassed and<br>
replaced for individual models by setting the :attr:`~Model.query_class`<br>
attribute. This is a subclass of a standard SQLAlchemy<br>
:class:`~sqlalchemy.orm.query.Query` class and has all the methods of a<br>
standard query as well.</tt></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>DB</strong> = <SQLAlchemy engine=None><br>
<strong>TAG_RE</strong> = re.compile('<[^>]+>')</td></tr></table>
</body></html>