Renamed openSource to openStream might be more appropriate

lantis63 · lantis63 · commit 59c85128e1a4 · 2006-12-07T22:54:42.000Z
--HG--
extra : convert_revision : svn%3Aacbfec75-9323-0410-a652-858a13e371e0/trunk%4086
diff --git a/inputstream.py b/inputstream.py
@@ -1,6 +1,6 @@
 import codecs
 
-from utils.utils import openSource
+from utils.utils import openStream
 
 class HTMLInputStream(object):
     """For reading data from an input stream
@@ -11,10 +11,10 @@ class HTMLInputStream(object):
     automatically, as you consume and unconsume characters.
     """
 
-    def __init__(self, source, encoding = None):
+    def __init__(self, stream, encoding = None):
         """ Initialise the HTMLInputReader.
 
-        The file parameter must be a File object.
+        The stream can either be a file-object, filename, url or string
 
         The optional encoding parameter must be a string that indicates
         the encoding.  If specified, that encoding will be used,
@@ -29,7 +29,7 @@ def __init__(self, source, encoding = None):
         # Keep a reference to the unencoded file object so that a new
         # EncodedFile can be created later if the encoding is declared
         # in a meta element
-        self.file = openSource(source)
+        self.file = openStream(stream)
 
         skipBOM = False
         self.charEncoding = self.detectBOM(self.file)
diff --git a/utils/utils.py b/utils/utils.py
@@ -34,26 +34,26 @@ def __getitem__(self, key):
             else:
                 raise
 
-def openSource(source):
-    """ Opens source first trying to open a local file, if that fails 
-    try to open as a URL and finally treating source as a string.
+def openStream(stream):
+    """ Opens stream first trying the native open functino, if that 
+    fails try to open as a URL and finally treating stream as a string.
 
     Returns a file-like object.
     """
     # Already a file-like object?
-    if hasattr(source, 'tell'):
-        return source
+    if hasattr(stream, 'tell'):
+        return stream
 
-    # Try opening source normally
+    # Try opening stream normally
     try:
-        return open(source)
+        return open(stream)
     except: pass
 
-    # Try opening source as a URL and storing the bytes returned so
+    # Try opening stream as a URL and storing the bytes returned so
     # they can be turned into a file-like object below
     try:
         import urllib
-        source = urllib.urlopen(source).read(-1)
+        stream = urllib.urlopen(stream).read(-1)
     except: pass
 
     # Treat source as a string and make it into a file-like object
