Public API

Types

class tgwebservices.runtime.unsigned
Represents an unsigned integer to the outside world. Within Python, it just creates an int.
class tgwebservices.runtime.binary(value=None)
Represents base64-encoded binary datas to the outside world.
class tgwebservices.runtime.typedproperty(type, *args, **kw)
Wraps the standard Python property function allowing you to specify what return type will be coming from your property’s getter method.

Decorators

tgwebservices.controllers.wsexpose(return_type=<type 'basestring'>)

Exposes a method for access via web services. Only one value can be returned because many languages only support a single return value from methods.

Parameter:return_type – the class that will be returned. This is used to help statically typed clients.
tgwebservices.controllers.wsvalidate(*args, **kw)
Validates and converts incoming parameters. Also registers the parameters used by the method for use by statically typed languages. Method parameters can be specified via positional or keyword arguments. You should pass in the class used for each parameter.

Controllers

class tgwebservices.controllers.WebServicesController
A controller that implements a piece of a web services API.
class tgwebservices.controllers.WebServicesRoot(baseURL, tns=None, typenamespace=None)

The root of a multi-protocol web service.

Parameters:
  • baseURL – Sets the URL path for this controller (trailing ‘/’ included). Some protocols need to know this.
  • tns – The SOAP target namespace (defaults to baseURL+soap/)
  • typenamespace – the namespace for the SOAP types (defaults to baseURL+soap/types)

Table Of Contents

Previous topic

A step-by-step tutorial

Next topic

ChangeLog

This Page