Use static methods in WebKit where appropriate. Added exception info on the application level.

Author: Cito

.pylintrc

@@ -54,7 +54,7 @@ load-plugins=
 
 # Disable the message(s) with the given id(s).
 #disable-msg=
-disable-msg=R0201,W0122,W0142,W0201,W0212,W0223,W0403,W0603,W0613,W0614,W0621,W0622,W0703
+disable-msg=W0122,W0142,W0201,W0212,W0223,W0403,W0603,W0613,W0614,W0621,W0622,W0703
 
 
 [REPORTS]

DocSupport/PyFontify.py

@@ -39,8 +39,8 @@
 
 import re, keyword
 
-# Build up a regular expression which will match anything
-# interesting, including multi-line triple-quoted strings.
+# Build up a regular expression which will match anything interesting,
+# including multi-line triple-quoted strings.
 commentPat = "#.*"
 
 pat = "q[^\q\n]*(\\\\[\000-\377][^\q\n]*)*q"
@@ -68,21 +68,20 @@
 pat = ''.join(pat.split()) # get rid of whitespace
 tripleQuotePat = pat.replace("q", "'") + "|" + pat.replace('q', '"')
 
-# Build up a regular expression which matches all and only
-# Python keywords. This will let us skip the uninteresting
-# identifier references.
-# nonKeyPat identifies characters which may legally precede
-# a keyword pattern.
+# Build up a regular expression which matches all and only Python keywords.
+# This will let us skip the uninteresting identifier references.
+# nonKeyPat identifies characters which may legally precede a keyword pattern.
 nonKeyPat = "(^|[^a-zA-Z0-9_.\"'])"
 keywordsPat = '|'.join(keyword.kwlist)
 keyPat = nonKeyPat + "(" + keywordsPat + ")" + nonKeyPat
 
 matchPat = keyPat + "|" + commentPat + "|" + tripleQuotePat + "|" + quotePat
 matchRE = re.compile(matchPat)
 
-idKeyPat = "[ \t]*[A-Za-z_][A-Za-z_0-9.]*" # Ident w. leading whitespace.
+idKeyPat = "[ \t]*[A-Za-z_][A-Za-z_0-9.]*" # ident with leading whitespace
 idRE = re.compile(idKeyPat)
 
+
 def fontify(pytext, searchfrom=0, searchto=None):
     if searchto is None:
         searchto = len(pytext)
@@ -99,40 +98,40 @@ def fontify(pytext, searchfrom=0, searchto=None):
         matchObject = matchRE.search(pytext, end)
         if not matchObject:
             break
-        (start, end) = matchObject.span()
+        start, end = matchObject.span()
         match = matchObject.group(0)
         c = match[0]
         if c not in "#'\"":
             # Must have matched a keyword.
-            if start != searchfrom:
-                # there's still a redundant char before and after it, strip!
+            if start == searchfrom:
+                # this is the first keyword in the text
+                match = match[:-1] # only a space at the end
+            else:
+                # there's still a redundant char before and after it
                 match = match[1:-1]
                 start += 1
-            else:
-                # this is the first keyword in the text.
-                # Only a space at the end.
-                match = match[:-1]
             end -= 1
             tags.append((keywordTag, start, end, None))
-            # If this was a defining keyword, look ahead to the
-            # following identifier.
-            if match in ["def", "class"]:
+            # If this was a defining keyword,
+            # look ahead to the following identifier.
+            if match in ('def', 'class'):
                 idMatchObject = idRE.search(pytext, end)
                 if idMatchObject:
-                    (start, end) = idMatchObject.span()
+                    start, end = idMatchObject.span()
                     match = idMatchObject.group(0)
-                    tags.append(((match == 'def')
-                        and functionTag or classTag, start, end, None))
+                    tags.append((match == 'def' and functionTag or classTag,
+                        start, end, None))
         elif c == "#":
             tags.append((commentTag, start, end, None))
         else:
             tags.append((stringTag, start, end, None))
     return tags
 
+
 def test(path):
     f = open(path)
     text = f.read()
     f.close()
     tags = fontify(text)
     for tag, start, end, sublist in tags:
-        print tag, `text[start:end]`, start, end
+        print tag, repr(text[start:end]), start, end

WebKit/Application.py

@@ -360,8 +360,6 @@ def webwareVersionString(self):
 
     def webKitVersion(self):
         """Return the WebKit version as a tuple."""
-        # @@ 2003-03 ib: This is synced with Webware now, should be removed
-        # because redundant (and not that useful anyway)
         return self._webKitVersion
 
     def webKitVersionString(self):
@@ -498,9 +496,9 @@ def webKitPath(self):
         """The Path of the ``Webware/WebKit/`` directory."""
         return self._server.webKitPath()
 
-    def name(self):
+    @staticmethod
+    def name():
         """The name by which this was started. Usually `AppServer`."""
-        # @@ 2003-03 ib: unconfirmed
         return sys.argv[0]
 
 
@@ -584,7 +582,8 @@ def dispatchRawRequest(self, requestDict, strmOut):
             request.clearTransaction()
         return trans
 
-    def createRequestForDict(self, requestDict):
+    @staticmethod
+    def createRequestForDict(requestDict):
         """Create request object for a given dictionary.
 
         Create a request object (subclass of `Request`) given the raw
@@ -701,7 +700,8 @@ def runTransaction(self, trans):
                 self.handleExceptionInTransaction(
                     sys.exc_info(), trans)
 
-    def runTransactionViaServlet(self, servlet, trans):
+    @staticmethod
+    def runTransactionViaServlet(servlet, trans):
         """Execute the transaction using the servlet.
 
         This is the `awake`/`respond`/`sleep` sequence of calls, or if
@@ -806,7 +806,8 @@ def includeURL(self, trans, url):
         # restore current request
         trans.setServlet(request.pop())
 
-    def resolveInternalRelativePath(self, trans, url):
+    @staticmethod
+    def resolveInternalRelativePath(trans, url):
         """Return the absolute internal path.
 
         Given a URL, return the absolute internal URL.
@@ -830,7 +831,8 @@ def resolveInternalRelativePath(self, trans, url):
                 parts.append(part)
         return '/'.join(parts)
 
-    def returnServlet(self, servlet):
+    @staticmethod
+    def returnServlet(servlet):
         """Return the servlet to its pool."""
         servlet.close()
 
@@ -893,7 +895,8 @@ def addContext(self, name, path):
         """
         self._rootURLParser.addContext(name, path)
 
-    def addServletFactory(self, factory):
+    @staticmethod
+    def addServletFactory(factory):
         """Add a ServletFactory.
 
         Delegated to the `URLParser.ServletFactoryManager` singleton.
@@ -905,11 +908,20 @@ def contexts(self):
         """Return a dictionary of context-name: context-path."""
         return self._rootURLParser._contexts
 
+    _exceptionReportAttrNames = ['webwareVersion', 'webwarePath',
+        'serverSidePath', 'contexts']
+
     def writeExceptionReport(self, handler):
-        # @@ 2003-02 ib: does anyone care?
-        pass
+        """Write extra information to the exception report.
+
+        See `WebKit.ExceptionHandler` for more information.
+
+        """
+        handler.writeTitle(self.__class__.__name__)
+        handler.writeAttrs(self, self._exceptionReportAttrNames)
 
-    def removePathSession(self, trans):
+    @staticmethod
+    def removePathSession(trans):
         """Remove a possible session identifier from the path."""
         request = trans.request()
         # Try to get automatic path session:

WebKit/AutoReloadingAppServer.py

@@ -53,7 +53,8 @@ def getFAM(modules):
             class FAM(object):
                 """Simple File Alteration Monitor based on python-gamin"""
 
-                def name(self):
+                @staticmethod
+                def name():
                     return "python-gamin"
 
                 def __init__(self):
@@ -100,7 +101,8 @@ def callback(self, filepath, event):
             class FAM(object):
                 """Simple File Alteration Monitor based on python-fam"""
 
-                def name(self):
+                @staticmethod
+                def name():
                     return "python-fam"
 
                 def __init__(self):
@@ -269,7 +271,8 @@ def restartIfNecessary(self):
         if self._shouldRestart:
             self.restart()
 
-    def restart(self):
+    @staticmethod
+    def restart():
         """Do the actual restart.
 
         Call `shouldRestart` from outside the class.

WebKit/DebugAppServer.py

@@ -162,7 +162,8 @@ class DummyRequestQueue(object):
 
     ## Overridden methods ##
 
-    def put(self, handler):
+    @staticmethod
+    def put(handler):
         handler.handleRequest()
         handler.close()
 

WebKit/HTTPContent.py

@@ -270,15 +270,17 @@ def methodNameForAction(self, name):
         """
         return name
 
-    def urlEncode(self, s):
+    @staticmethod
+    def urlEncode(s):
         """Quotes special characters using the % substitutions.
 
         This method does the same as the `urllib.quote_plus()` function.
 
         """
         return Funcs.urlEncode(s) # we could also use urllib.quote
 
-    def urlDecode(self, s):
+    @staticmethod
+    def urlDecode(s):
         """Turn special % characters into actual characters.
 
         This method does the same as the `urllib.unquote_plus()` function.
@@ -309,7 +311,8 @@ def includeURL(self, url):
         """
         self.application().includeURL(self.transaction(), url)
 
-    def callMethodOfServlet(self, url, method, *args, **kwargs):
+    @staticmethod
+    def callMethodOfServlet(url, method, *args, **kwargs):
         """Call a method of another servlet.
 
         See `Application.callMethodOfServlet` for details.

WebKit/HTTPExceptions.py

@@ -217,12 +217,8 @@ def __init__(self, realm=None, *args):
     def headers(self):
         return {'WWW-Authenticate': 'Basic realm="%s"' % self._realm}
 
-# This is for wording mistakes. I'm unsure about their benefit.
+# This is for wording mistakes:
 HTTPAuthorizationRequired = HTTPAuthenticationRequired
-"""
-There is also an alias `HTTPAuthorizationRequired`, as it is hard
-to distinguish between these two names.
-"""
 
 
 class HTTPSessionExpired(HTTPException):

WebKit/HTTPRequest.py

@@ -143,6 +143,13 @@ def __init__(self, requestDict=None):
             print "Done setting up request, found keys %r" % fieldKeys
 
 
+    ## Protocol ##
+
+    def protocol(self):
+        """Return the name and version of the protocol."""
+        return self._environ.get('SERVER_PROTOCOL', 'HTTP/1.0')
+
+
     ## Security ##
 
     def isSecure(self):

WebKit/HTTPResponse.py

@@ -35,6 +35,13 @@ def __init__(self, transaction, strmOut, headers=None):
         self._cookies = {}
 
 
+    ## Protocol ##
+
+    def protocol(self):
+        """Return the name and version of the protocol."""
+        return self._transaction.request().protocol()
+
+
     ## Headers ##
 
     def header(self, name, default=NoDefault):

WebKit/HTTPServer.py

@@ -1,6 +1,6 @@
 """HTTP servlets"""
 
-import os, socket, time, errno
+import os, socket, errno
 import BaseHTTPServer
 
 from ThreadedAppServer import Handler
@@ -57,7 +57,8 @@ def handleRequest(self):
     do_MKCOL = do_COPY = do_MOVE = handleRequest
     do_PROPFIND = handleRequest
 
-    def headersToEnviron(self, headers, env):
+    @staticmethod
+    def headersToEnviron(headers, env):
         """Convert headers to environment variables.
 
         Use a simple heuristic to convert all the headers to

WebKit/HTTPServlet.py

@@ -64,10 +64,12 @@ def respond(self, trans):
             self._methodForRequestType[httpMethodName] = method
         method(trans)
 
-    def notImplemented(self, trans):
+    @staticmethod
+    def notImplemented(trans):
         trans.response().setStatus(501, 'Not Implemented')
 
-    def lastModified(self, trans):
+    @staticmethod
+    def lastModified(trans):
         """Get time of last modification.
 
         Return this object's Last-Modified time (as a float),

WebKit/ImportManager.py

@@ -53,7 +53,8 @@ def load_module(self, name, file, filename, info):
             raise
         return mod
 
-    def find_module(self, name, path=None):
+    @staticmethod
+    def find_module(name, path=None):
         """Replaces imp.find_module."""
         return imp.find_module(name, path)
 

WebKit/JSONRPCServlet.py

@@ -56,7 +56,9 @@ def actions(self):
         actions.append('jsonCall')
         return actions
 
-    def exposedMethods(self):
+    @staticmethod
+    def exposedMethods():
+        """Return a list or a set of all exposed RPC methods."""
         return []
 
     def writeError(self, msg):

WebKit/Message.py

@@ -34,26 +34,28 @@ def __init__(self):
 
     ## Content ##
 
-    def contentLength(self):
+    @staticmethod
+    def contentLength():
         """Return the length of the message body or -1 if not known."""
         return -1
 
-    def contentType(self):
+    @staticmethod
+    def contentType():
         """Return the MIME type of the message body or None if not known."""
         return None
 
 
     ## Protocol ##
 
-    def protocol(self):
-        """Return the protocol-
+    @staticmethod
+    def protocol():
+        """Return the protocol.
 
         Returns the name and version of the protocol the message uses
         in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
 
         """
-        # @@ 2000-04-09 ce: Move this down into HTTPSomething subclasses
-        return 'HTTP/1.0'
+        return None
 
 
     ## Arguments ##