summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjortel <devnull@localhost>2010-01-13 18:22:05 +0000
committerjortel <devnull@localhost>2010-01-13 18:22:05 +0000
commit3224e14928cc00bc481ddcd98a569b74679e61a9 (patch)
tree48c647303d7db6a56079c0fbbb97f9bbbd04730c
parente1f87183cd08a0e3d76129ff5429e2452585bdb2 (diff)
downloadsuds-3224e14928cc00bc481ddcd98a569b74679e61a9.tar.gz
Update epydocs.
-rw-r--r--suds/cache.py3
-rw-r--r--suds/options.py3
-rw-r--r--suds/reader.py19
3 files changed, 20 insertions, 5 deletions
diff --git a/suds/cache.py b/suds/cache.py
index 02f7e55..80764dc 100644
--- a/suds/cache.py
+++ b/suds/cache.py
@@ -70,8 +70,7 @@ class ByteCache:
def clear(self):
"""
- @param id: A file ID.
- @type id: str
+ Clear the cache.
"""
raise Exception('not-implemented')
diff --git a/suds/options.py b/suds/options.py
index d7a711e..7e5c069 100644
--- a/suds/options.py
+++ b/suds/options.py
@@ -88,9 +88,6 @@ class Options(Skin):
WSDL import each other. B{**Experimental**}.
- type: I{bool}
- default: False
- - B{store} - The SAX document store.
- - type: L{DocumentStore}
- - default: None
"""
def __init__(self, **kwargs):
domain = __name__
diff --git a/suds/reader.py b/suds/reader.py
index 0925012..16eff1f 100644
--- a/suds/reader.py
+++ b/suds/reader.py
@@ -23,11 +23,30 @@ from suds.sax.parser import Parser
from suds.transport import Request
class DocumentReader:
+ """
+ The XML document reader provides an integration
+ between the SAX L{Parser} and the document cache.
+ """
def __init__(self, options):
+ """
+ @param options: An options object.
+ @type options: I{Options}
+ """
self.options = options
def open(self, url):
+ """
+ Open an XML document at the specified I{url}.
+ First, the document attempted to be retrieved from
+ the I{document cache}. If not found, it is downloaded and
+ parsed using the SAX parser. The result is added to the
+ document store for the next open().
+ @param url: A document url.
+ @type url: str.
+ @return: The specified XML document.
+ @rtype: I{Document}
+ """
d = self.options.cache.get(url)
if d is None:
fp = self.options.transport.open(Request(url))