Welcome to consumer’s documentation!¶
AbstractBaseWebService¶
-
class
consumer.
AbstractBaseWebService
(env=None)¶ Parameters: env – env name to use. -
get
(**params)¶ return a string or None representing response from calling the service URI
-
headers
()¶ optional headers that should be passed with the HTTP request
-
hosts
¶ Concrete Service should define a “hosts” property that should be a ServiceHostCollection with UAT and PROD values
-
isAthunticationRequired
()¶ Concrete Service should define a “hosts” property that should be a ServiceHostCollection with UAT and PROD values
-
mandatory_param_rules
¶ Service can optionally define a property “mandatory_params” which is a tuple of parameters combination, representing set of required query parameter for the service.
Parameters passed to get method will be checked to have all of these params else the web service call will not continue default [] empty list no parameters are mandatory
- Returns:
a tuple of pairs of parameters
>>>``((‘param1’,), (‘param2’,),)``
param1
orparam2
should be present(('param1','param2'), ('param3',),)
eitherparam1
andparam2
paramters should be present or justName
parameter should be present in the query parameters
-
protocol
¶ http or https
-
service_path
¶ Concrete Service must have a property “service_path” that should be a string representing a absolute path(except the protocol and hostname/port) Example: for a service http://supercomputer:8080/servicepath/some-end-point service_path will be ‘servicepath/some-end-point’
-
url
¶ Construct the complete service URI using proper protocol host, port and service_path
-
valid_params
¶ Service must have a property “valid_params” which is a list of valid query parameter for the service, any other parameter passed other than what is defined here will be dropped with a warn log
-
verify
()¶ optional verify parameter that should be passed with the HTTP request for verfication
-
AbstractWebAuth¶
AbstractBaseJsonWebService¶
-
class
consumer.
AbstractBaseJsonWebService
(env=None)¶ Use this abstract class when the service is providing JSON reponse and you want the result as a python dictionary
-
as_dict
()¶ return a dictionary or None representing response from calling the service URI
-
get
(**params)¶ deligate the call to super get method, also try parsing the response as json and store it in self.json
-
AbstractBaseXmlWebService¶
-
class
consumer.
AbstractBaseXmlWebService
(env=None)¶ Use this abstract class when the service is providing XML reponse and you want the result as a python dictionary
-
as_dict
(**params)¶ return a dictionary or None representing response from calling the service URI
-
get
(**params)¶ deligate the call to super get method, also try parsing the response as XML and store it in self.xml as a defusedxml.ElementTree
-