Source Code for Module suds.options

  1  # This program is free software; you can redistribute it and/or modify 
  2  # it under the terms of the (LGPL) GNU Lesser General Public License as 
  3  # published by the Free Software Foundation; either version 3 of the  
  4  # License, or (at your option) any later version. 
  5  # 
  6  # This program is distributed in the hope that it will be useful, 
  7  # but WITHOUT ANY WARRANTY; without even the implied warranty of 
  8  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
  9  # GNU Library Lesser General Public License for more details at 
 10  # ( http://www.gnu.org/licenses/lgpl.html ). 
 11  # 
 12  # You should have received a copy of the GNU Lesser General Public License 
 13  # along with this program; if not, write to the Free Software 
 14  # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 
 15  # written by: Jeff Ortel ( jortel@redhat.com ) 
 16   
 17  """ 
 18  Suds basic options classes. 
 19  """ 
 20   
 21  from suds.properties import * 
 22  from suds.wsse import Security 
 23  from suds.xsd.doctor import Doctor 
 24  from suds.transport import Transport 
 25  from suds.cache import Cache, NoCache 
 26   
 27   
 28 -class TpLinker(AutoLinker): 
 29      """ 
 30      Transport (auto) linker used to manage linkage between 
 31      transport objects Properties and those Properties that contain them. 
 32      """ 
 33       
 34 -    def updated(self, properties, prev, next): 
 35          if isinstance(prev, Transport): 
 36              tp = Unskin(prev.options) 
 37              properties.unlink(tp) 
 38          if isinstance(next, Transport): 
 39              tp = Unskin(next.options) 
 40              properties.link(tp) 
 41   
 42   
 43 -class Options(Skin): 
 44      """ 
 45      Options: 
 46          - B{cache} - The XML document cache.  May be set (None) for no caching. 
 47                  - type: L{Cache} 
 48                  - default: L{NoCache} 
 49          - B{faults} - Raise faults raised by server, 
 50              else return tuple from service method invocation as (httpcode, object). 
 51                  - type: I{bool} 
 52                  - default: True 
 53          - B{service} - The default service name. 
 54                  - type: I{str} 
 55                  - default: None 
 56          - B{port} - The default service port name, not tcp port. 
 57                  - type: I{str} 
 58                  - default: None 
 59          - B{location} - This overrides the service port address I{URL} defined  
 60              in the WSDL. 
 61                  - type: I{str} 
 62                  - default: None 
 63          - B{transport} - The message transport. 
 64                  - type: L{Transport} 
 65                  - default: None 
 66          - B{soapheaders} - The soap headers to be included in the soap message. 
 67                  - type: I{any} 
 68                  - default: None 
 69          - B{wsse} - The web services I{security} provider object. 
 70                  - type: L{Security} 
 71                  - default: None 
 72          - B{doctor} - A schema I{doctor} object. 
 73                  - type: L{Doctor} 
 74                  - default: None 
 75          - B{xstq} - The B{x}ml B{s}chema B{t}ype B{q}ualified flag indicates 
 76              that the I{xsi:type} attribute values should be qualified by namespace. 
 77                  - type: I{bool} 
 78                  - default: True 
 79          - B{prefixes} - Elements of the soap message should be qualified (when needed) 
 80              using XML prefixes as opposed to xmlns="" syntax. 
 81                  - type: I{bool} 
 82                  - default: True 
 83          - B{retxml} - Flag that causes the I{raw} soap envelope to be returned instead 
 84              of the python object graph. 
 85                  - type: I{bool} 
 86                  - default: False 
 87          - B{prettyxml} - Flag that causes I{pretty} xml to be rendered when generating 
 88              the outbound soap envelope. 
 89                  - type: I{bool} 
 90                  - default: False 
 91          - B{autoblend} - Flag that ensures that the schema(s) defined within the 
 92              WSDL import each other. 
 93                  - type: I{bool} 
 94                  - default: False 
 95          - B{cachingpolicy} - The caching policy. 
 96                  - type: I{int} 
 97                    - 0 = Cache XML documents. 
 98                    - 1 = Cache WSDL (pickled) object. 
 99                  - default: 0 
100          - B{plugins} - A plugin container. 
101                  - type: I{list} 
102          - B{nosend} - Create the soap envelope but don't send. 
103              When specified, method invocation returns a I{RequestContext} 
104              instead of sending it. 
105                  - type: I{bool} 
106                  - default: False 
107      """     
108 -    def __init__(self, **kwargs): 
109          domain = __name__ 
110          definitions = [ 
111              Definition('cache', Cache, NoCache()), 
112              Definition('faults', bool, True), 
113              Definition('transport', Transport, None, TpLinker()), 
114              Definition('service', (int, basestring), None), 
115              Definition('port', (int, basestring), None), 
116              Definition('location', basestring, None), 
117              Definition('soapheaders', (), ()), 
118              Definition('wsse', Security, None), 
119              Definition('doctor', Doctor, None), 
120              Definition('xstq', bool, True), 
121              Definition('prefixes', bool, True), 
122              Definition('retxml', bool, False), 
123              Definition('prettyxml', bool, False), 
124              Definition('autoblend', bool, False), 
125              Definition('cachingpolicy', int, 0), 
126              Definition('plugins', (list, tuple), []), 
127              Definition('nosend', bool, False), 
128          ] 
129          Skin.__init__(self, domain, definitions, kwargs) 
130