Merge lp:~jelmer/pydoctor/add-module-inspect into lp:~mwhudson/pydoctor/dev

[Jelmer Vernooij]

Hi Michael,

This branch makes --add-module use the same function for loading modules as --add-package. This makes it possible to document top-level C modules with pydoctor.

[Michael Hudson-Doyle (mwhudson)]

Looks good, thanks.

I wonder if prependedpackage was ever useful to anyone at all...

[Jelmer Vernooij (jelmer)]

On Mon, 2010-12-13 at 11:47 +1300, Michael Hudson wrote:
> Looks good, thanks.
>
> I wonder if prependedpackage was ever useful to anyone at all...
I remember it being useful to document bzr plugins... I didn't
acidentally kill it, did I?

Cheers,

Jelmer

[Michael Hudson-Doyle (mwhudson)]

On Sun, 12 Dec 2010 23:58:13 +0100, Jelmer Vernooij <email address hidden> wrote:
> On Mon, 2010-12-13 at 11:47 +1300, Michael Hudson wrote:
> > Looks good, thanks.
> >
> > I wonder if prependedpackage was ever useful to anyone at all...
> I remember it being useful to document bzr plugins... I didn't
> acidentally kill it, did I?

I don't think so :-)

=== modified file 'pydoctor/driver.py'
--- pydoctor/driver.py	2010-12-06 04:04:29 +0000
+++ pydoctor/driver.py	2010-12-11 00:04:58 +0000
@@ -317,8 +317,8 @@
                     system.msg('addPackage', 'adding directory ' + path)
                     system.addPackage(path, prependedpackage)
                 else:
-                    system.msg('addModule', 'adding module ' + path)
-                    system.addModule(path, prependedpackage)
+                    system.msg('addModuleFromPath', 'adding module ' + path)
+                    system.addModuleFromPath(prependedpackage, path)
                 system.packages.append(path)
 
         # step 3: move the system to the desired state

=== modified file 'pydoctor/model.py'
--- pydoctor/model.py	2010-12-06 04:02:40 +0000
+++ pydoctor/model.py	2010-12-11 00:04:58 +0000
@@ -529,9 +529,7 @@
 
         mod.sourceHref = posixpath.join(mod.system.sourcebase, *trailing)
 
-    def addModule(self, modpath, parentPackage=None):
-        fname = os.path.basename(modpath)
-        modname = os.path.splitext(fname)[0]
+    def addModule(self, modpath, modname, parentPackage=None):
         mod = self.Module(self, modname, None, parentPackage)
         self.addObject(mod)
         self.progress(
@@ -582,7 +580,7 @@
                 self.addObject(c)
                 self._introspectThing(v, c, parentMod)
 
-    def introspectModule(self, module_full_name, py_mod):
+    def introspectModule(self, py_mod, module_full_name):
         module = self.ensureModule(module_full_name)
         module.docstring = py_mod.__doc__
         self._introspectThing(py_mod, module, module)
@@ -611,23 +609,27 @@
                 if os.path.exists(initname):
                     self.addPackage(fullname, package)
             elif not fname.startswith('.'):
-                self._addModuleFromPath(package, fullname)
+                self.addModuleFromPath(package, fullname)
 
-    def _addModuleFromPath(self, package, path):
+    def addModuleFromPath(self, package, path):
         for (suffix, mode, type) in imp.get_suffixes():
             if not path.endswith(suffix):
                 continue
+            module_name = os.path.basename(path[:-len(suffix)])
             if type == imp.C_EXTENSION:
                 if not self.options.introspect_c_modules:
                     continue
-                module_full_name = "%s.%s" % (
-                    package.fullName(), os.path.basename(path[:-len(suffix)]))
+                if package is not None:
+                    module_full_name = "%s.%s" % (
+                        package.fullName(), module_name)
+                else:
+                    module_full_name = module_name
                 py_mod = imp.load_module(
                     module_full_name, open(path, 'rb'), path,
                     (suffix, mode, type))
-                self.introspectModule(module_full_name, py_mod)
+                self.introspectModule(py_mod, module_full_name)
             elif type == imp.PY_SOURCE:
-                self.addModule(path, package)
+                self.addModule(path, module_name, package)
             break
 
     def handleDuplicate(self, obj):