.happydoc.happydocstring.py :  » Development » HappyDoc » HappyDoc3-r3_1 » happydoclib » Python Open Source

Home
Python Open Source
1.3.1.2 Python
2.Ajax
3.Aspect Oriented
4.Blog
5.Build
6.Business Application
7.Chart Report
8.Content Management Systems
9.Cryptographic
10.Database
11.Development
12.Editor
13.Email
14.ERP
15.Game 2D 3D
16.GIS
17.GUI
18.IDE
19.Installer
20.IRC
21.Issue Tracker
22.Language Interface
23.Log
24.Math
25.Media Sound Audio
26.Mobile
27.Network
28.Parser
29.PDF
30.Project Management
31.RSS
32.Search
33.Security
34.Template Engines
35.Test
36.UML
37.USB Serial
38.Web Frameworks
39.Web Server
40.Web Services
41.Web Unit
42.Wiki
43.Windows
44.XML
Python Open Source » Development » HappyDoc 
HappyDoc » HappyDoc3 r3_1 » happydoclib » .happydoc.happydocstring.py
(S'ff4c9c90250b4f753824ca374b86094d'
p1
(ihappydoclib.parseinfo.moduleinfo
ModuleInfo
p2
(dp3
S'_namespaces'
p4
((dp5
S'HappyDocStringConverterBase'
p6
(ihappydoclib.parseinfo.classinfo
ClassInfo
p7
(dp8
g4
((dp9
(dp10
S'quote'
p11
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p12
(dp13
g4
((dp14
(dp15
tp16
sS'_exception_info'
p17
(dp18
S"ValueError( '%s does not implement quote' % self.__class__.__name__ )"
p19
NssS'_parameter_names'
p20
(S'self'
p21
S'inputText'
p22
S'outputFormat'
p23
S'*args'
p24
S'*namedArgs'
p25
tp26
sS'_parameter_info'
p27
(dp28
g22
(NNNtp29
sg24
(NNNtp30
sg21
(NNNtp31
sg25
(NNNtp32
sg23
(NNNtp33
ssS'_filename'
p34
S'../HappyDoc3-r3_1/happydoclib/happydocstring.py'
p35
sS'_docstring'
p36
S"Returns the 'inputText' quoted in a way that special characters are escaped.\n\n        Parameters:\n\n          'inputText' -- String or other sequence of characters to be\n          converted.  This string should be in the format advertised\n          by the docstring converter.\n\n          'outputFormat' -- String defined by the docstring converter\n          class to represent a supported output scheme.  This value is\n          converter-specific, and not all converters will support the\n          same output formats.\n\n          '*args' -- Additional, converter-specific, positional arguments.\n\n          '**namedArgs' -- Additional, converter-specific, named arguments.\n          \n        "
p37
sS'_name'
p38
g11
sS'_parent'
p39
g7
sS'_comment_info'
p40
(dp41
sS'_configuration_values'
p42
(dp43
sS'_class_info'
p44
g14
sS'_function_info'
p45
g15
sS'_comments'
p46
S''
sbsS'convert'
p47
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p48
(dp49
g4
((dp50
(dp51
tp52
sg17
(dp53
S"ValueError( '%s does not implement convert' % self.__class__.__name__ )"
p54
Nssg20
(S'self'
p55
S'inputText'
p56
S'outputFormat'
p57
S'*args'
p58
S'*namedArgs'
p59
tp60
sg27
(dp61
g56
(NNNtp62
sg58
(NNNtp63
sg55
(NNNtp64
sg59
(NNNtp65
sg57
(NNNtp66
ssg34
g35
sg36
S"Returns the 'inputText' data translated into the 'outputFormat'.\n\n        Parameters:\n\n          'inputText' -- String or other sequence of characters to be\n          converted.  This string should be in the format advertised\n          by the docstring converter.\n\n          'outputFormat' -- String defined by the docstring converter\n          class to represent a supported output scheme.  This value is\n          converter-specific, and not all converters will support the\n          same output formats.\n\n          '*args' -- Additional, converter-specific, positional arguments.\n\n          '**namedArgs' -- Additional, converter-specific, named arguments.\n        "
p67
sg38
g47
sg39
g7
sg40
g41
sg42
(dp68
sg44
g50
sg45
g51
sg46
S''
sbsS'__init__'
p69
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p70
(dp71
g4
((dp72
(dp73
tp74
sg17
(dp75
sg20
(S'self'
p76
S'**extraNamedParameters'
p77
tp78
sg27
(dp79
g76
(NNNtp80
sg77
(NNNtp81
ssg34
g35
sg36
S"Initialize the docstring converter.\n\n        Parameters:\n\n          'extraNamedParameters' -- Parameters specified by name which\n          were not interpreted by a subclass initialization.\n\n        "
p82
sg38
g69
sg39
g7
sg40
g41
sg42
(dp83
sg44
g72
sg45
g73
sg46
S''
sbsS'getExternalDocumentationFile'
p84
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p85
(dp86
g4
((dp87
(dp88
tp89
sg17
(dp90
sg20
(S'self'
p91
S'filename'
p92
S'*args'
p93
S'*namedArgs'
p94
tp95
sg27
(dp96
g93
(NNNtp97
sg94
(NNNtp98
sg91
(NNNtp99
sg92
(NNNtp100
ssg34
g35
sg36
S"Returns the 'inputText' quoted in a way that special characters are escaped.\n\n        Parameters:\n\n          'filename' -- Name of the file to retrieve.\n          \n          '*args' -- Additional, converter-specific, positional arguments.\n\n          '**namedArgs' -- Additional, converter-specific, named arguments.\n        "
p101
sg38
g84
sg39
g7
sg40
g41
sg42
(dp102
sg44
g87
sg45
g88
sg46
S''
sbstp103
sg34
g35
sg36
S'Base class for docstring converters.'
p104
sS'_class_member_info'
p105
(lp106
S'externalDocumentFactory'
p107
asg38
g6
sg39
g2
sg40
g41
sS'_base_class_info'
p108
(lp109
sg42
(dp110
sg44
g9
sg45
g10
sg46
S''
sbsS'ExternalDocumentationFileBase'
p111
(ihappydoclib.parseinfo.classinfo
ClassInfo
p112
(dp113
g4
((dp114
(dp115
S'getInputType'
p116
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p117
(dp118
g4
((dp119
(dp120
tp121
sg17
(dp122
sg20
(S'self'
p123
tp124
sg27
(dp125
g123
(NNNtp126
ssg34
g35
sg36
S'Input type of file contents.'
p127
sg38
g116
sg39
g112
sg40
g41
sg42
(dp128
sg44
g119
sg45
g120
sg46
S''
sbsS'__str__'
p129
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p130
(dp131
g4
((dp132
(dp133
tp134
sg17
(dp135
sg20
(S'self'
p136
tp137
sg27
(dp138
g136
(NNNtp139
ssg34
g35
sg36
S'String representation of file.'
p140
sg38
g129
sg39
g112
sg40
g41
sg42
(dp141
sg44
g132
sg45
g133
sg46
S''
sbsS'oneLiner'
p142
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p143
(dp144
g4
((dp145
(dp146
tp147
sg17
(dp148
sg20
(S'self'
p149
tp150
sg27
(dp151
g149
(NNNtp152
ssg34
g35
sg36
S'Returns the one line description from the file.'
p153
sg38
g142
sg39
g112
sg40
g41
sg42
(dp154
sg44
g145
sg45
g146
sg46
S''
sbsS'__init__'
p155
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p156
(dp157
g4
((dp158
(dp159
tp160
sg17
(dp161
sg20
(S'self'
p162
S'filename'
p163
S'body'
p164
tp165
sg27
(dp166
g164
(I1
S'None'
Ntp167
sg162
(NNNtp168
sg163
(NNNtp169
ssg34
g35
sg36
S''
sg38
g155
sg39
g112
sg40
g41
sg42
(dp170
sg44
g158
sg45
g159
sg46
S''
sbstp171
sg34
g35
sg36
S'Formatted documentation in an outside file.'
p172
sg105
(lp173
S'_input_type'
p174
asg38
g111
sg39
g2
sg40
g41
sg108
(lp175
sg42
(dp176
sg44
g114
sg45
g115
sg46
S''
sbsS'DocStringConverterTest'
p177
(ihappydoclib.parseinfo.classinfo
ClassInfo
p178
(dp179
g4
((dp180
(dp181
S'_testConversion'
p182
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p183
(dp184
g4
((dp185
(dp186
tp187
sg17
(dp188
sg20
(S'self'
p189
S'inputText'
p190
S'inputFormat'
p191
S'outputFormat'
p192
S'expectedText'
p193
S'errorMessage'
p194
S'debug'
p195
tp196
sg27
(dp197
g192
(NNNtp198
sg191
(NNNtp199
sg195
(I1
S'0'
Ntp200
sg189
(NNNtp201
sg194
(NNNtp202
sg193
(NNNtp203
sg190
(NNNtp204
ssg34
g35
sg36
S''
sg38
g182
sg39
g178
sg40
g41
sg42
(dp205
sg44
g185
sg45
g186
sg46
S''
sbsS'setUp'
p206
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p207
(dp208
g4
((dp209
(dp210
tp211
sg17
(dp212
sg20
(S'self'
p213
tp214
sg27
(dp215
g213
(NNNtp216
ssg34
g35
sg36
S''
sg38
g206
sg39
g178
sg40
g41
sg42
(dp217
sg44
g209
sg45
g210
sg46
S''
sbsS'_compareText'
p218
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p219
(dp220
g4
((dp221
(dp222
tp223
sg17
(dp224
sg20
(S'self'
p225
S'expected'
p226
S'actual'
p227
tp228
sg27
(dp229
g226
(NNNtp230
sg225
(NNNtp231
sg227
(NNNtp232
ssg34
g35
sg36
S''
sg38
g218
sg39
g178
sg40
g41
sg42
(dp233
sg44
g221
sg45
g222
sg46
S''
sbsS'_testQuote'
p234
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p235
(dp236
g4
((dp237
(dp238
tp239
sg17
(dp240
sg20
(S'self'
p241
S'inputText'
p242
S'inputFormat'
p243
S'outputFormat'
p244
S'expectedText'
p245
S'errorMessage'
p246
tp247
sg27
(dp248
g244
(NNNtp249
sg243
(NNNtp250
sg241
(NNNtp251
sg246
(NNNtp252
sg245
(NNNtp253
sg242
(NNNtp254
ssg34
g35
sg36
S''
sg38
g234
sg39
g178
sg40
g41
sg42
(dp255
sg44
g237
sg45
g238
sg46
S''
sbstp256
sg34
g35
sg36
S''
sg105
(lp257
sg38
g177
sg39
g2
sg40
g41
sg108
(lp258
S'unittest.TestCase'
p259
asg42
(dp260
sg44
g180
sg45
g181
sg46
S''
sbs(dp261
tp262
sS'_import_info'
p263
(ihappydoclib.parseinfo.imports
ImportInfo
p264
(dp265
S'_named_imports'
p266
(dp267
sS'_straight_imports'
p268
(lp269
sbsg34
g35
sg36
S'"""Base class for docstring converters.\n\n    A docstring converter is responsible for translating the docstring\n    markup syntax to the output formatter syntax.  Docstring\n    converters should be as generic as possible, but by their nature\n    will have a close relationship with a happyformatter type.\n\n"""'
p270
sg38
S'happydocstring'
p271
sg39
Nsg40
g41
sg42
(dp272
S'include_comments'
p273
I1
sS'cacheFilePrefix'
p274
S'.happydoc.'
p275
sS'useCache'
p276
I1
sS'docStringFormat'
p277
S'StructuredText'
p278
ssg44
g5
sg45
g261
sg46
S''
sbt.
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.