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
376
377
378
379
380
381
382
383
|
import pytest
@pytest.mark.sphinx("html", testroot="docstrings")
def test_simple_model(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.SimpleModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: SimpleModel(id, file, childA, dummy_field)",
" :module: dummy_django_app.models",
"",
" :param id: Primary key: ID",
" :type id: ~django.db.models.AutoField",
" :param dummy_field: Very verbose name of dummy field. This should help you",
"",
" Docstring of char field",
"",
" .. warning::",
"",
" Inline directives should be preserved.",
"",
" :type dummy_field: ~django.db.models.CharField",
"",
" Relationship fields:",
"",
(
" :param file: File (related name:"
" :attr:`~dummy_django_app.models.FileModel.simple_models`)"
),
"",
" Docstring of foreign key",
"",
(
" :type file: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.FileModel`"
),
(
" :param childA: ChildA (related name:"
" :attr:`~dummy_django_app.models.ChildModelA.simple_model`)"
),
"",
" Docstring of one to one field",
"",
(
" :type childA: :class:`~django.db.models.OneToOneField` to"
" :class:`~dummy_django_app.models.ChildModelA`"
),
(
" :param childrenB: ChildrenB (related name:"
" :attr:`~dummy_django_app.models.ChildModelB.simple_models`)"
),
"",
" Docstring of many to many field",
"",
" .. note::",
"",
" This syntax is also supported.",
"",
(
" :type childrenB: :class:`~django.db.models.ManyToManyField` to"
" :class:`~dummy_django_app.models.ChildModelB`"
),
"",
" Reverse relationships:",
"",
(
" :param childmodela: All child model as of this simple model (related"
" name of :attr:`~dummy_django_app.models.ChildModelA.simple_model`)"
),
(
" :type childmodela: Reverse :class:`~django.db.models.ForeignKey` from"
" :class:`~dummy_django_app.models.ChildModelA`"
),
(
" :param childmodelb: All child model bs of this simple model (related"
" name of :attr:`~dummy_django_app.models.ChildModelB.simple_model`)"
),
(
" :type childmodelb: Reverse :class:`~django.db.models.ForeignKey` from"
" :class:`~dummy_django_app.models.ChildModelB`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.SimpleModel",
"",
]
@pytest.mark.sphinx(
"html", testroot="docstrings", confoverrides={"django_show_db_tables": True}
)
def test_database_table(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.SimpleModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: SimpleModel(id, file, childA, dummy_field)",
" :module: dummy_django_app.models",
"",
" **Database table:** ``dummy_django_app_simplemodel``",
"",
" :param id: Primary key: ID",
" :type id: ~django.db.models.AutoField",
" :param dummy_field: Very verbose name of dummy field. This should help you",
"",
" Docstring of char field",
"",
" .. warning::",
"",
" Inline directives should be preserved.",
"",
" :type dummy_field: ~django.db.models.CharField",
"",
" Relationship fields:",
"",
(
" :param file: File (related name:"
" :attr:`~dummy_django_app.models.FileModel.simple_models`)"
),
"",
" Docstring of foreign key",
"",
(
" :type file: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.FileModel`"
),
(
" :param childA: ChildA (related name:"
" :attr:`~dummy_django_app.models.ChildModelA.simple_model`)"
),
"",
" Docstring of one to one field",
"",
(
" :type childA: :class:`~django.db.models.OneToOneField` to"
" :class:`~dummy_django_app.models.ChildModelA`"
),
(
" :param childrenB: ChildrenB (related name:"
" :attr:`~dummy_django_app.models.ChildModelB.simple_models`)"
),
"",
" Docstring of many to many field",
"",
" .. note::",
"",
" This syntax is also supported.",
"",
(
" :type childrenB: :class:`~django.db.models.ManyToManyField` to"
" :class:`~dummy_django_app.models.ChildModelB`"
),
"",
" Reverse relationships:",
"",
(
" :param childmodela: All child model as of this simple model (related"
" name of :attr:`~dummy_django_app.models.ChildModelA.simple_model`)"
),
(
" :type childmodela: Reverse :class:`~django.db.models.ForeignKey` from"
" :class:`~dummy_django_app.models.ChildModelA`"
),
(
" :param childmodelb: All child model bs of this simple model (related"
" name of :attr:`~dummy_django_app.models.ChildModelB.simple_model`)"
),
(
" :type childmodelb: Reverse :class:`~django.db.models.ForeignKey` from"
" :class:`~dummy_django_app.models.ChildModelB`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.SimpleModel",
"",
]
@pytest.mark.sphinx("html", testroot="docstrings")
def test_abstract_model(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.AbstractModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: AbstractModel(*args, **kwargs)",
" :module: dummy_django_app.models",
"",
"",
" Relationship fields:",
"",
" :param simple_model: Simple model",
(
" :type simple_model: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.SimpleModel`"
),
" :param user: User",
(
" :type user: :class:`~django.db.models.ForeignKey` to"
" :class:`~django.contrib.auth.models.User`"
),
" :param foreignkey_self: Foreignkey self",
(
" :type foreignkey_self: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.AbstractModel`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
"",
]
@pytest.mark.sphinx(
"html", testroot="docstrings", confoverrides={"django_show_db_tables": True}
)
def test_abstract_model_with_tables_names_and_ignore_abstract(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.AbstractModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: AbstractModel(*args, **kwargs)",
" :module: dummy_django_app.models",
"",
"",
" Relationship fields:",
"",
" :param simple_model: Simple model",
(
" :type simple_model: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.SimpleModel`"
),
" :param user: User",
(
" :type user: :class:`~django.db.models.ForeignKey` to"
" :class:`~django.contrib.auth.models.User`"
),
" :param foreignkey_self: Foreignkey self",
(
" :type foreignkey_self: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.AbstractModel`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
"",
]
@pytest.mark.sphinx(
"html",
testroot="docstrings",
confoverrides={
"django_show_db_tables": True,
"django_show_db_tables_abstract": True,
},
)
def test_abstract_model_with_tables_names_and_abstract_show(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.AbstractModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: AbstractModel(*args, **kwargs)",
" :module: dummy_django_app.models",
"",
" **Database table:** ``None``",
"",
"",
" Relationship fields:",
"",
" :param simple_model: Simple model",
(
" :type simple_model: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.SimpleModel`"
),
" :param user: User",
(
" :type user: :class:`~django.db.models.ForeignKey` to"
" :class:`~django.contrib.auth.models.User`"
),
" :param foreignkey_self: Foreignkey self",
(
" :type foreignkey_self: :class:`~django.db.models.ForeignKey` to"
" :class:`~dummy_django_app.models.AbstractModel`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.AbstractModel",
"",
]
@pytest.mark.sphinx("html", testroot="docstrings")
def test_file_model(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.FileModel")
print(actual)
assert list(actual) == [
"",
".. py:class:: FileModel(id, upload)",
" :module: dummy_django_app.models",
"",
" :param id: Primary key: ID",
" :type id: ~django.db.models.AutoField",
" :param upload: Upload",
" :type upload: ~django.db.models.FileField",
"",
" Reverse relationships:",
"",
(
" :param simple_models: All simple models of this file model (related"
" name of :attr:`~dummy_django_app.models.SimpleModel.file`)"
),
(
" :type simple_models: Reverse :class:`~django.db.models.ForeignKey` from"
" :class:`~dummy_django_app.models.SimpleModel`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.FileModel",
"",
]
@pytest.mark.sphinx("html", testroot="docstrings")
def test_tagged_item(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.models.TaggedItem")
print(actual)
assert list(actual) == [
"",
".. py:class:: TaggedItem(id, tag, content_type, object_id)",
" :module: dummy_django_app.models",
"",
" :param id: Primary key: ID",
" :type id: ~django.db.models.AutoField",
" :param tag: Tag",
" :type tag: ~django.db.models.SlugField",
" :param object_id: Object id",
" :type object_id: ~django.db.models.PositiveIntegerField",
(
" :param content_object: Generic foreign key to the"
" :class:`~django.contrib.contenttypes.models.ContentType` specified in"
" :attr:`~dummy_django_app.models.TaggedItem.content_type`"
),
(
" :type content_object:"
" ~django.contrib.contenttypes.fields.GenericForeignKey"
),
"",
" Relationship fields:",
"",
(
" :param content_type: Content type (related name:"
" :attr:`~django.contrib.contenttypes.models.ContentType.taggeditem`)"
),
(
" :type content_type: :class:`~django.db.models.ForeignKey` to"
" :class:`~django.contrib.contenttypes.models.ContentType`"
),
"",
" .. inheritance-diagram:: dummy_django_app.models.TaggedItem",
"",
]
@pytest.mark.sphinx("html", testroot="docstrings")
def test_form(app, do_autodoc):
actual = do_autodoc(app, "class", "dummy_django_app.forms.SimpleForm")
print(actual)
assert list(actual) == [
"",
".. py:class:: SimpleForm(*args, **kwargs)",
" :module: dummy_django_app.forms",
"",
" **Form fields:**",
"",
" * ``file``: File (:class:`~django.forms.ModelChoiceField`)",
" * ``childA``: ChildA (:class:`~django.forms.ModelChoiceField`)",
(
" * ``childrenB``: ChildrenB"
" (:class:`~django.forms.ModelMultipleChoiceField`)"
),
(
" * ``dummy_field``: Very verbose name of dummy field"
" (:class:`~django.forms.CharField`)"
),
" * ``test1``: Test1 (:class:`~django.forms.CharField`)",
" * ``test2``: Test2 (:class:`~django.forms.CharField`)",
"",
]
|
