blob: 4ee3f87351ec5a2fb313045e8b7ec3f8244bbfbb (
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
134
135
136
137
|
# Some comments first
# More comments
'A module docstring'
doctest = u"""# Python 3 gets all of these right ...
>>> __doc__
'A module docstring'
>>> f.__doc__
'\\n This is a function docstring.\\n '
>>> C.__doc__
'\\n This is a class docstring.\\n '
>>> C.docstring_copy_C
'\\n This is a class docstring.\\n '
>>> CS.docstring_copy_C
'\\n This is a class docstring.\\n '
>>> CS.__doc__
'\\n This is a subclass docstring.\\n '
>>> CS.docstring_copy_CS
'\\n This is a subclass docstring.\\n '
>>> CSS.docstring_copy_CS
'\\n This is a subclass docstring.\\n '
>>> print(CSS.__doc__)
None
>>> CSS.docstring_copy_CSS
'A module docstring'
>>> T.__doc__
'\\n This is an extension type docstring.\\n '
>>> TS.__doc__
'\\n This is an extension subtype docstring.\\n '
>>> TSS.__doc__
Compare with standard Python:
>>> def Pyf():
... '''
... This is a function docstring.
... '''
>>> Pyf.__doc__
'\\n This is a function docstring.\\n '
>>> class PyC(object):
... '''
... This is a class docstring.
... '''
... docstring_copy_C = __doc__
>>> class PyCS(PyC):
... '''
... This is a subclass docstring.
... '''
... docstring_copy_CS = __doc__
>>> class PyCSS(PyCS):
... docstring_copy_CSS = __doc__
>>> PyC.__doc__
'\\n This is a class docstring.\\n '
>>> PyC.docstring_copy_C
'\\n This is a class docstring.\\n '
>>> PyCS.docstring_copy_C
'\\n This is a class docstring.\\n '
>>> PyCSS.docstring_copy_C
'\\n This is a class docstring.\\n '
>>> PyCS.__doc__
'\\n This is a subclass docstring.\\n '
>>> PyCS.docstring_copy_CS
'\\n This is a subclass docstring.\\n '
>>> PyCSS.docstring_copy_CS
'\\n This is a subclass docstring.\\n '
>>> PyCSS.__doc__
>>> PyCSS.docstring_copy_CSS
'A module docstring'
"""
__test__ = {"test_docstrings" : doctest}
def f():
"""
This is a function docstring.
"""
class C(object):
"""
This is a class docstring.
"""
docstring_copy_C = __doc__
class CS(C):
"""
This is a subclass docstring.
"""
docstring_copy_CS = __doc__
class CSS(CS):
docstring_copy_CSS = __doc__
cdef class T:
"""
This is an extension type docstring.
"""
cdef class TS(T):
"""
This is an extension subtype docstring.
"""
cdef class TSS(TS):
pass
def n():
"This is not a docstring".lower()
class PyN(object):
u"This is not a docstring".lower()
cdef class CN(object):
b"This is not a docstring".lower()
def test_non_docstrings():
"""
>>> n.__doc__
>>> PyN.__doc__
>>> CN.__doc__
"""
|
