Python pydoc 模块，splitdoc() 实例源码

def test_splitdoc_with_description(self):
        example_string = "I Am A Doc\n\n\nHere is my description"
        self.assertEqual(pydoc.splitdoc(example_string),
                         ('I Am A Doc', '\nHere is my description'))

def test_splitdoc_with_description(self):
        example_string = "I Am A Doc\n\n\nHere is my description"
        self.assertEqual(pydoc.splitdoc(example_string),
                         ('I Am A Doc', '\nHere is my description'))

def moduleSection( self, object, packageContext ):
        """Create a module-links section for the given object (module)"""
        modules = inspect.getmembers(object, inspect.ismodule)
        packageContext.clean ( modules, object )
        packageContext.recurseScan( modules )

        if hasattr(object, '__path__'):
            modpkgs = []
            modnames = []
            for file in os.listdir(object.__path__[0]):
                path = os.path.join(object.__path__[0], file)
                modname = inspect.getmodulename(file)
                if modname and modname not in modnames:
                    modpkgs.append((modname, object.__name__, 0, 0))
                    modnames.append(modname)
                elif pydoc.ispackage(path):
                    modpkgs.append((file, object.__name__, 1, 0))
            modpkgs.sort()
            # do more recursion here...
            for (modname, name, ya,yo) in modpkgs:
                packageContext.addInteresting( join( (object.__name__, modname), '.'))
            items = []
            for (modname, name, ispackage,isshadowed) in modpkgs:
                try:
                    # get the actual module object...
##                  if modname == "events":
##                      import pdb
##                      pdb.set_trace()
                    module = pydoc.safeimport( "%s.%s"%(name,modname) )
                    description, documentation = pydoc.splitdoc( inspect.getdoc( module ))
                    if description:
                        items.append(
                            """%s -- %s"""% (
                                self.modpkglink( (modname, name, ispackage, isshadowed) ),
                                description,
                            )
                        )
                    else:
                        items.append(
                            self.modpkglink( (modname, name, ispackage, isshadowed) )
                        )
                except:
                    items.append(
                        self.modpkglink( (modname, name, ispackage, isshadowed) )
                    )
            contents = string.join( items, '<br>')
            result = self.bigsection(
                'Package Contents', '#ffffff', '#aa55cc', contents)
        elif modules:
            contents = self.multicolumn(
                modules, lambda (key, value), s=self: s.modulelink(value))
            result = self.bigsection(
                'Modules', '#fffff', '#aa55cc', contents)
        else:
            result = ""
        return result