.happydoc.packagetree.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.packagetree.py
(S'104b200f381e8379a44a206b771344cc'
p1
(ihappydoclib.parseinfo.moduleinfo
ModuleInfo
p2
(dp3
S'_namespaces'
p4
((dp5
S'FunctionTree'
p6
(ihappydoclib.parseinfo.classinfo
ClassInfo
p7
(dp8
g4
((dp9
(dp10
S'_getCodeInfo'
p11
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p12
(dp13
g4
((dp14
(dp15
tp16
sS'_exception_info'
p17
(dp18
sS'_parameter_names'
p19
(S'self'
p20
tp21
sS'_parameter_info'
p22
(dp23
g20
(NNNtp24
ssS'_filename'
p25
S'../HappyDoc3-r3_1/happydoclib/packagetree.py'
p26
sS'_docstring'
p27
S''
sS'_name'
p28
g11
sS'_parent'
p29
g7
sS'_comment_info'
p30
(dp31
sS'_configuration_values'
p32
(dp33
sS'_class_info'
p34
g14
sS'_function_info'
p35
g15
sS'_comments'
p36
S''
sbstp37
sg25
g26
sg27
S'Represents a function in the package tree.\n    '
p38
sS'_class_member_info'
p39
(lp40
S'MIMETYPE'
p41
asg28
g6
sg29
g2
sg30
g31
sS'_base_class_info'
p42
(lp43
S'CodeObjectTree'
p44
asg32
(dp45
sg34
g9
sg35
g10
sg36
S''
sbsS'ClassTree'
p46
(ihappydoclib.parseinfo.classinfo
ClassInfo
p47
(dp48
g4
((dp49
(dp50
S'getRelativeFilename'
p51
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p52
(dp53
g4
((dp54
(dp55
tp56
sg17
(dp57
sg19
(S'self'
p58
tp59
sg22
(dp60
g58
(NNNtp61
ssg25
g26
sg27
S'Classes are written to their own file.\n        '
p62
sg28
g51
sg29
g47
sg30
g31
sg32
(dp63
sg34
g54
sg35
g55
sg36
S''
sbsS'_getCodeInfo'
p64
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p65
(dp66
g4
((dp67
(dp68
tp69
sg17
(dp70
sg19
(S'self'
p71
tp72
sg22
(dp73
g71
(NNNtp74
ssg25
g26
sg27
S''
sg28
g64
sg29
g47
sg30
g31
sg32
(dp75
sg34
g67
sg35
g68
sg36
S''
sbsS'__init__'
p76
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p77
(dp78
g4
((dp79
(dp80
tp81
sg17
(dp82
sg19
(S'self'
p83
S'parent'
p84
S'name'
p85
tp86
sg22
(dp87
g83
(NNNtp88
sg85
(NNNtp89
sg84
(NNNtp90
ssg25
g26
sg27
S''
sg28
g76
sg29
g47
sg30
g31
sg32
(dp91
sg34
g79
sg35
g80
sg36
S''
sbstp92
sg25
g26
sg27
S'Represent a class in the package tree.\n    '
p93
sg39
(lp94
S'MIMETYPE'
p95
asg28
g46
sg29
g2
sg30
g31
sg42
(lp96
S'CodeObjectTree'
p97
asg32
(dp98
sg34
g49
sg35
g50
sg36
S''
sbsS'PackageTree'
p99
(ihappydoclib.parseinfo.classinfo
ClassInfo
p100
(dp101
g4
((dp102
(dp103
S'getSummaryAndFormat'
p104
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p105
(dp106
g4
((dp107
(dp108
tp109
sg17
(dp110
S"NotImplementedError( 'getSummaryAndFormat' )"
p111
Nssg19
(S'self'
p112
tp113
sg22
(dp114
g112
(NNNtp115
ssg25
g26
sg27
S'Returns a tuple containing a one line summary of the\n        documentation for the node and the format of that\n        string as understood by the docstring converter plugins.\n        '
p116
sg28
g104
sg29
g100
sg30
g31
sg32
(dp117
sg34
g107
sg35
g108
sg36
S''
sbsS'getSubNodes'
p118
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p119
(dp120
g4
((dp121
(dp122
tp123
sg17
(dp124
sg19
(S'self'
p125
S'mimetypes'
p126
tp127
sg22
(dp128
g125
(NNNtp129
sg126
(I1
S'[]'
Ntp130
ssg25
g26
sg27
S'Returns the children of this node.\n\n        If mimetype is not none, returns only the children with that\n        mimetype.\n        '
p131
sg28
g118
sg29
g100
sg30
g31
sg32
(dp132
sg34
g121
sg35
g122
sg36
S''
sbsS'getImportData'
p133
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p134
(dp135
g4
((dp136
(dp137
tp138
sg17
(dp139
sg19
(S'self'
p140
tp141
sg22
(dp142
g140
(NNNtp143
ssg25
g26
sg27
S'Returns a list of the symbols which are imported.'
p144
sg28
g133
sg29
g100
sg30
g31
sg32
(dp145
sg34
g136
sg35
g137
sg36
S''
sbsS'getInputFilename'
p146
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p147
(dp148
g4
((dp149
(dp150
tp151
sg17
(dp152
sg19
(S'self'
p153
tp154
sg22
(dp155
g153
(NNNtp156
ssg25
g26
sg27
S'Returns the original input filename that created the node.\n        '
p157
sg28
g146
sg29
g100
sg30
g31
sg32
(dp158
sg34
g149
sg35
g150
sg36
S''
sbsS'getRelativeFilename'
p159
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p160
(dp161
g4
((dp162
(dp163
tp164
sg17
(dp165
sg19
(S'self'
p166
tp167
sg22
(dp168
g166
(NNNtp169
ssg25
g26
sg27
S'Returns the filename relative to the root of the input area.\n        '
p170
sg28
g159
sg29
g100
sg30
g31
sg32
(dp171
sg34
g162
sg35
g163
sg36
S''
sbsS'getName'
p172
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p173
(dp174
g4
((dp175
(dp176
tp177
sg17
(dp178
sg19
(S'self'
p179
tp180
sg22
(dp181
g179
(NNNtp182
ssg25
g26
sg27
S'Returns the name of this tree node.\n        '
p183
sg28
g172
sg29
g100
sg30
g31
sg32
(dp184
sg34
g175
sg35
g176
sg36
S''
sbsS'getPathToNode'
p185
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p186
(dp187
g4
((dp188
(dp189
tp190
sg17
(dp191
sg19
(S'self'
p192
S'otherNode'
p193
tp194
sg22
(dp195
g192
(NNNtp196
sg193
(NNNtp197
ssg25
g26
sg27
S"Returns a sequence of nodes to be traversed to reach the otherNode.\n\n        The sequence assumes that traversal begins at the current node.\n        A '..' indicates moving up to the parent one level.\n        "
p198
sg28
g185
sg29
g100
sg30
g31
sg32
(dp199
sg34
g188
sg35
g189
sg36
S''
sbsS'findNodeFromDottedName'
p200
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p201
(dp202
g4
((dp203
(dp204
tp205
sg17
(dp206
sg19
(S'self'
p207
S'dottedNodeName'
p208
S'tryParent'
p209
S'tryModuleExtensions'
p210
tp211
sg22
(dp212
g207
(NNNtp213
sg208
(NNNtp214
sg209
(I1
S'1'
Ntp215
sg210
(I1
S'1'
Ntp216
ssg25
g26
sg27
S"Find the node referenced by the dotted name given.\n\n        The dottedNodeName 'happydoclib.scanner' retuns the node for\n        this module.  If the named node cannot be found, the return\n        value is None.\n        "
p217
sg28
g200
sg29
g100
sg30
g31
sg32
(dp218
sg34
g203
sg35
g204
sg36
S''
sbsS'getPath'
p219
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p220
(dp221
g4
((dp222
(dp223
tp224
sg17
(dp225
sg19
(S'self'
p226
S'useCanonicalName'
p227
tp228
sg22
(dp229
g227
(I1
S'0'
Ntp230
sg226
(NNNtp231
ssg25
g26
sg27
S'Return the path from the root to this node.\n\n        Returns a tuple of node names, beginning with the root node\n        and ending with this node.\n        '
p232
sg28
g219
sg29
g100
sg30
g31
sg32
(dp233
sg34
g222
sg35
g223
sg36
S''
sbsS'__cmp__'
p234
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p235
(dp236
g4
((dp237
(dp238
tp239
sg17
(dp240
sg19
(S'self'
p241
S'other'
p242
tp243
sg22
(dp244
g241
(NNNtp245
sg242
(NNNtp246
ssg25
g26
sg27
S'Comparison by name for sorting.\n        The name check is case insensitive.\n        '
p247
sg28
g234
sg29
g100
sg30
g31
sg32
(dp248
sg34
g237
sg35
g238
sg36
S''
sbsS'getDocStringAndFormat'
p249
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p250
(dp251
g4
((dp252
(dp253
tp254
sg17
(dp255
S"NotImplementedError( 'getDocStringAndFormat' )"
p256
Nssg19
(S'self'
p257
tp258
sg22
(dp259
g257
(NNNtp260
ssg25
g26
sg27
S'Returns a tuple containing the actual documentation string\n        and the format of that docstring as understood by the\n        docstring converters plugins.\n        '
p261
sg28
g249
sg29
g100
sg30
g31
sg32
(dp262
sg34
g252
sg35
g253
sg36
S''
sbsS'getOneLiner'
p263
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p264
(dp265
g4
((dp266
(dp267
tp268
sg17
(dp269
sg19
(S'self'
p270
tp271
sg22
(dp272
g270
(NNNtp273
ssg25
g26
sg27
S''
sg28
g263
sg29
g100
sg30
g31
sg32
(dp274
sg34
g266
sg35
g267
sg36
S''
sbsS'__repr__'
p275
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p276
(dp277
g4
((dp278
(dp279
tp280
sg17
(dp281
sg19
(S'self'
p282
tp283
sg22
(dp284
g282
(NNNtp285
ssg25
g26
sg27
S''
sg28
g275
sg29
g100
sg30
g31
sg32
(dp286
sg34
g278
sg35
g279
sg36
S''
sbsS'__init__'
p287
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p288
(dp289
g4
((dp290
(dp291
tp292
sg17
(dp293
sg19
(S'self'
p294
S'parent'
p295
S'name'
p296
tp297
sg22
(dp298
g294
(NNNtp299
sg296
(NNNtp300
sg295
(NNNtp301
ssg25
g26
sg27
S''
sg28
g287
sg29
g100
sg30
g31
sg32
(dp302
sg34
g290
sg35
g291
sg36
S''
sbsS'getCanonicalName'
p303
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p304
(dp305
g4
((dp306
(dp307
tp308
sg17
(dp309
sg19
(S'self'
p310
tp311
sg22
(dp312
g310
(NNNtp313
ssg25
g26
sg27
S'Returns the canonical, full, name of the this tree node.\n        '
p314
sg28
g303
sg29
g100
sg30
g31
sg32
(dp315
sg34
g306
sg35
g307
sg36
S''
sbsS'getParent'
p316
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p317
(dp318
g4
((dp319
(dp320
tp321
sg17
(dp322
sg19
(S'self'
p323
tp324
sg22
(dp325
g323
(NNNtp326
ssg25
g26
sg27
S'Returns the parent node for this tree.\n\n        If there is no parent (root of the tree), returns None.\n        '
p327
sg28
g316
sg29
g100
sg30
g31
sg32
(dp328
sg34
g319
sg35
g320
sg36
S''
sbsS'walk'
p329
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p330
(dp331
g4
((dp332
(dp333
tp334
sg17
(dp335
sg19
(S'self'
p336
S'callback'
p337
tp338
sg22
(dp339
g337
(NNNtp340
sg336
(NNNtp341
ssg25
g26
sg27
S'Walk the PackageTree, calling the callback at each node.\n        '
p342
sg28
g329
sg29
g100
sg30
g31
sg32
(dp343
sg34
g332
sg35
g333
sg36
S''
sbsS'addSubNode'
p344
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p345
(dp346
g4
((dp347
(dp348
tp349
sg17
(dp350
sg19
(S'self'
p351
S'node'
p352
tp353
sg22
(dp354
g352
(NNNtp355
sg351
(NNNtp356
ssg25
g26
sg27
S'Insert a child node under this node.\n\n        Create a new PackageTree node, set its parent to be ourself,\n        and save it as one of our children.\n        '
p357
sg28
g344
sg29
g100
sg30
g31
sg32
(dp358
sg34
g347
sg35
g348
sg36
S''
sbsS'__len__'
p359
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p360
(dp361
g4
((dp362
(dp363
tp364
sg17
(dp365
sg19
(S'self'
p366
tp367
sg22
(dp368
g366
(NNNtp369
ssg25
g26
sg27
S"Define this to always return 1, so checks like 'if node' work properly.\n        "
p370
sg28
g359
sg29
g100
sg30
g31
sg32
(dp371
sg34
g362
sg35
g363
sg36
S''
sbsS'getMimeType'
p372
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p373
(dp374
g4
((dp375
(dp376
tp377
sg17
(dp378
sg19
(S'self'
p379
tp380
sg22
(dp381
g379
(NNNtp382
ssg25
g26
sg27
S'Returns the (mimetype, encoding) setting for this node.\n        '
p383
sg28
g372
sg29
g100
sg30
g31
sg32
(dp384
sg34
g375
sg35
g376
sg36
S''
sbstp385
sg25
g26
sg27
S'Tree of package information.\n\n    Access each child node using the standard mapping de-reference\n    syntax ([], .get(), etc.).\n    '
p386
sg39
(lp387
sg28
g99
sg29
g2
sg30
g31
sg42
(lp388
S'UserDict.UserDict'
p389
asg32
(dp390
sg34
g102
sg35
g103
sg36
S''
sbsS'CodeObjectTree'
p391
(ihappydoclib.parseinfo.classinfo
ClassInfo
p392
(dp393
g4
((dp394
(dp395
S'getInputFilename'
p396
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p397
(dp398
g4
((dp399
(dp400
tp401
sg17
(dp402
sg19
(S'self'
p403
tp404
sg22
(dp405
g403
(NNNtp406
ssg25
g26
sg27
S'Returns the input filename of the parent node.\n        '
p407
sg28
g396
sg29
g392
sg30
g31
sg32
(dp408
sg34
g399
sg35
g400
sg36
S''
sbsS'getRelativeFilename'
p409
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p410
(dp411
g4
((dp412
(dp413
tp414
sg17
(dp415
sg19
(S'self'
p416
tp417
sg22
(dp418
g416
(NNNtp419
ssg25
g26
sg27
S'Returns the filename of the parent node.\n        '
p420
sg28
g409
sg29
g392
sg30
g31
sg32
(dp421
sg34
g412
sg35
g413
sg36
S''
sbsS'getDocStringAndFormat'
p422
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p423
(dp424
g4
((dp425
(dp426
tp427
sg17
(dp428
sg19
(S'self'
p429
tp430
sg22
(dp431
g429
(NNNtp432
ssg25
g26
sg27
S'Returns the docstring of the code object, and the format of that data.\n        '
p433
sg28
g422
sg29
g392
sg30
g31
sg32
(dp434
sg34
g425
sg35
g426
sg36
S''
sbsS'getSummaryAndFormat'
p435
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p436
(dp437
g4
((dp438
(dp439
tp440
sg17
(dp441
sg19
(S'self'
p442
tp443
sg22
(dp444
g442
(NNNtp445
ssg25
g26
sg27
S'Returns a tuple containing a one line summary of the\n        documentation for the node and the format of that\n        string as understood by the docstring converter plugins.\n        '
p446
sg28
g435
sg29
g392
sg30
g31
sg32
(dp447
sg34
g438
sg35
g439
sg36
S''
sbsS'__init__'
p448
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p449
(dp450
g4
((dp451
(dp452
tp453
sg17
(dp454
sg19
(S'self'
p455
S'parent'
p456
S'name'
p457
tp458
sg22
(dp459
g455
(NNNtp460
sg457
(NNNtp461
sg456
(NNNtp462
ssg25
g26
sg27
S'Construct a CodeObjectTree.\n        '
p463
sg28
g448
sg29
g392
sg30
g31
sg32
(dp464
sg34
g451
sg35
g452
sg36
S''
sbsS'getMimeType'
p465
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p466
(dp467
g4
((dp468
(dp469
tp470
sg17
(dp471
sg19
(S'self'
p472
tp473
sg22
(dp474
g472
(NNNtp475
ssg25
g26
sg27
S''
sg28
g465
sg29
g392
sg30
g31
sg32
(dp476
sg34
g468
sg35
g469
sg36
S''
sbstp477
sg25
g26
sg27
S'Represents a code object to be documented.\n    '
p478
sg39
(lp479
S'MIMETYPE'
p480
asg28
g391
sg29
g2
sg30
g31
sg42
(lp481
S'PackageTree'
p482
asg32
(dp483
sg34
g394
sg35
g395
sg36
S''
sbsS'MethodTree'
p484
(ihappydoclib.parseinfo.classinfo
ClassInfo
p485
(dp486
g4
((dp487
(dp488
S'_getCodeInfo'
p489
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p490
(dp491
g4
((dp492
(dp493
tp494
sg17
(dp495
sg19
(S'self'
p496
tp497
sg22
(dp498
g496
(NNNtp499
ssg25
g26
sg27
S''
sg28
g489
sg29
g485
sg30
g31
sg32
(dp500
sg34
g492
sg35
g493
sg36
S''
sbstp501
sg25
g26
sg27
S'Represents a method in the package tree.\n    '
p502
sg39
(lp503
sg28
g484
sg29
g2
sg30
g31
sg42
(lp504
S'FunctionTree'
p505
asg32
(dp506
sg34
g487
sg35
g488
sg36
S''
sbs(dp507
tp508
sS'_import_info'
p509
(ihappydoclib.parseinfo.imports
ImportInfo
p510
(dp511
S'_named_imports'
p512
(dp513
sS'_straight_imports'
p514
(lp515
sbsg25
g26
sg27
S'"""Tree representing the input data.\n\n"""'
p516
sg28
S'packagetree'
p517
sg29
Nsg30
g31
sg32
(dp518
S'include_comments'
p519
I1
sS'cacheFilePrefix'
p520
S'.happydoc.'
p521
sS'useCache'
p522
I1
sS'docStringFormat'
p523
S'StructuredText'
p524
ssg34
g5
sg35
g507
sg36
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.