pyamf (version 0.8.0)
index
/usr/local/lib/python2.7/dist-packages/pyamf/__init__.py

U{PyAMF<http://pyamf.org>} provides Action Message Format (U{AMF
<http://en.wikipedia.org/wiki/Action_Message_Format>}) support for Python that
is compatible with the Adobe U{Flash Player
<http://en.wikipedia.org/wiki/Flash_Player>}.
 
@since: October 2007
@status: Production/Stable

 
Package Contents
       
_version
adapters (package)
alias
amf0
amf3
codec
flex (package)
python
remoting (package)
sol
tests (package)
util (package)
versions
xml

 
Functions
       
decode(stream, *args, **kwargs)
A generator function to decode a datastream.
 
@param stream: AMF data to be decoded.
@type stream: byte data
@kwarg encoding: AMF encoding type. One of L{ENCODING_TYPES}.
@type encoding: C{int}
@return: A generator that will decode each element in the stream.
encode(*args, **kwargs)
A helper function to encode an element.
 
@param args: The Python data to be encoded.
@kwarg encoding: AMF encoding type. One of L{ENCODING_TYPES}.
@type encoding: C{int}
@return: A L{util.BufferedByteStream} object that contains the data.
get_adapter(mod)
Return the PyAMF adapter for the supplied module.
 
Usage::
    adapter = pyamf.get_adapter('django.contrib.auth.models')
register_class(klass, alias=None)
Registers a class to be used in the data streaming. This is the equivalent
of the C{[RemoteClass(alias="foobar")]} metatag in Adobe Flex, and the
C{flash.net.registerClassAlias} method in Actionscript 3.0.
 
@return: The registered L{ClassAlias} instance.
@see: L{unregister_class}
@see: U{flash.net.registerClassAlias on Adobe Help (external)
        <http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/net/package.html#registerClassAlias%28%29>}
register_class_loader(loader)
Registers a loader that is called to provide the C{class} for a specific
alias.
 
The C{loader} is provided with one argument, the class alias (as a string).
If the loader succeeds in finding a suitable class then it should return
that class, otherwise it should return C{None}.
 
An example::
 
    def lazy_load_from_my_module(alias):
        if not alias.startswith('foo.bar.'):
            return None
 
        from foo import bar
 
        if alias == 'foo.bar.Spam':
            return bar.Spam
        elif alias == 'foo.bar.Eggs':
            return bar.Eggs
 
    pyamf.register_class_loader(lazy_load_from_my_module)
 
@raise TypeError: C{loader} must be callable
@see: L{unregister_class_loader}

 
Data
        __all__ = ['register_class', 'register_class_loader', 'get_adapter', 'encode', 'decode', '__version__', 'version']
__version__ = (0, 8, 0)
version = (0, 8, 0)