doc.py :  » Development » Leo » Leo-4.7.1-final » leo » plugins » trees » 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 » Leo 
Leo » Leo 4.7.1 final » leo » plugins » trees » doc.py
#@+leo-ver=4-thin
#@+node:ekr.20050329082101.165:@thin trees\doc.py
#@<< docstring >>
#@+node:ekr.20050329082101.166:<< docstring >>
"""A handler that documents a module

The parameter in the @auto-doc headline is the module to document.

"""
#@-node:ekr.20050329082101.166:<< docstring >>
#@nl

from autotrees import BaseTreeHandler,TreeNode
import inspect

import leo.core.leoGlobals as g

__version__ = "0.1"
__plugin_requires__ = ["autotrees"]
__plugin_group__ = "Coding"

#@<< version history >>
#@+node:ekr.20050329082101.167:<< version history >>
#@+at
# 
# Version history
# 
# 0.1 - Paul Paterson:
#       Initial version
#@-at
#@-node:ekr.20050329082101.167:<< version history >>
#@nl


class Doc(BaseTreeHandler):
    """Handler for documentation nodes"""

    def initFrom(self,c,parameter):
        """Initialize the tree"""
        self.c = c
        self.children = []
        self.done = set()
        try:
            module = __import__(parameter)
        except Exception as err:
            g.es("Failed: %s" % (err,), color="red")
        else:
            components = parameter.split('.')
            for comp in components[1:]:
                module = getattr(module, comp)
            self.children.extend(self.getDocsFor(module))

    def getDocsFor(self, object):
        """Return a list of child nodes documenting the object"""
        #g.pr(object)
        children = []
        for name in dir(object):
            item = getattr(object, name)
            if not name.startswith("_") and not id(item) in self.done:
                self.done.add(id(item))
                if inspect.isclass(item):
                    #g.pr("Class", item.__name__)
                    grandchildren = self.getDocsFor(item)
                else:
                    #g.pr("item", item)
                    grandchildren = []
                children.append(
                    TreeNode(
                        name,
                        getattr(item, "__doc__", "No documentation for %s" % name),
                        grandchildren
                    )
                )
        return children

#@-node:ekr.20050329082101.165:@thin trees\doc.py
#@-leo
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.