Changeset 48

Timestamp:

07/24/07 02:15:27 (1 year ago)

Author:

edsuom

Message:

Major work on the foss.tellectual.com example, for API docs

Files:

• projects/twisted-goodies/trunk/misc/var_www_foss.tellectual.com_index.py (modified) (5 diffs)

projects/twisted-goodies/trunk/misc/var_www_foss.tellectual.com_index.py

@@ -24 +24 @@
-"""
-
+import tempfile, shutil
-from textwrap import TextWrapper
-import os.path as ospath
-
+
+
-from twisted.python.log import msg as log
-
@@ -71 +73 @@
-    )
-
+
+def projectURL(projectName):
+    """
+    """
+    return "/trac/%s/wiki/Start_%s" % (projectName, projectName)
+
+
+class API(object):
+    """
+    """
+    def __init__(self, vhostPath, projectName, request):
+        self.packageName = projectName.lower().replace("-", "_")
+        path = "/api/%s/%s.html" % (projectName, self.packageName)
+        newURL = (request.scheme, request.host, path, '', '', '')
+        filePath = ospath.join(vhostPath, newURL[2].lstrip("/"))
+        if ospath.exists(filePath):
+            d = defer.succeed(None)
+        else:
+            tmpDir = tempfile.mkdtemp()
+            d = self.svn(tmpDir, projectName)
+            d.addCallback(
+                lambda _: self.pydoctor(tmpDir, vhostPath, projectName))
+            d.addCallback(lambda _: shutil.rmtree(tmpDir))
+        d.addCallback(lambda _: (resource.RedirectResource(*newURL), ()))
+        self.d = d
+
+    def executable(self, name):
+        """
+        """
+        result = procutils.which(name)[0]
+        if not result:
+            raise ImportError("Can't locate %s executable" % name)
+
+    def svn(self, tmpDir, vhostPath, projectName):
+        """
+        TODO
+        """
+        return defer.succeed(None)
+
+    def pydoctor(self, tmpDir, vhostPath, projectName):
+        """
+        TODO
+        """
+        return
+        # TODO: Nothing below does anything yet
+        args = [
+            "--add-package=%s" % self.packageName,
+            "--project-name=%s" % projectName,
+            "--make-html",
+            "--html-output=%s/api/%s" % (vhostPath, projectName),
+            "--project-url=%s" % projectURL(projectName)]
+        return util.getProcessValue(
+            self.executable('pydoctor'), args=args, path=tmpDir)
+    
-
-class Resource(StanResource):
@@ -105 +161 @@
-        self.tr = TracResource(TRAC_DIR, env)
-
-    def _reformat(self, name):
-        return name.replace("-", "_").lower()
-
-    def _possibleStatic(self, *pathParts):
+        """
+        """
-        staticPath = ospath.join(self.vhostPath, *pathParts)
-        if ospath.exists(staticPath):
@@ -121 +176 @@
-            projectDescription = " ".join(
-                [x.strip() for x in doc.strip().split("\n")])
-"/trac/%s/wiki/Start_%s" % (projectName, 
+projectURL(
-            projectDiv = [
-                T.a(id="project_link", href=href)[projectName]]
@@ -181 +236 @@
-        if not subSegments:
-            extendRequest('wiki')
+        root = subSegments[0]
-        if len(subSegments) == 1:
-
-
+
-                extendRequest("Start_%s" % projectName)
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-        return self.tr, subSegments
-
-    def apiResource(self, projectName, fileName):
-        """
-        Returns a L{static.File} child resource directed to an API document for
-        the specified project, dynamically generating the document with
-        pyDoctor as needed.
-
-        TODO: SVN export, pydoctor, static.File(...), temp file cleanup
-        """
-        projectDir = self._reformat(projectName)
-        return self._possibleStatic('api', projectDir, fileName)