Package pyamf :: Module alias :: Class ClassAlias

Class ClassAlias

Class alias. Provides class/instance meta data to the En/Decoder to allow fine grain control and some performance increases.

Instance Methods

[hide private]

__eq__(self, other)

source code

__hash__(self)
hash(x)

source code

__init__(self, klass, alias=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

__repr__(self)
repr(x)

source code

__str__(self)
str(x)

source code

_checkExternal(self)

source code

_compile_base_class(self, klass)

source code

_finalise_compile(self)

source code

applyAttributes(self, obj, attrs, codec=None)
Applies the collection of attributes attrs to aliased object obj. source code

checkClass(self, klass)
This function is used to check if the class being aliased fits certain criteria.

source code

compile(self)
This compiles the alias into a form that can be of most benefit to the en/decoder.

source code

createInstance(self, codec=None)
Creates an instance of the klass.

source code

getCustomProperties(self)
Overrride this to provide known static properties based on the aliased class.

source code

getDecodableAttributes(self, obj, attrs, codec=None)
Returns a dictionary of attributes for obj that has been filtered, based on the supplied attrs. source code

getEncodableAttributes(self, obj, codec=None)
Must return a dict of attributes to be encoded, even if its empty. source code

is_compiled(self)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

hash(self)
(Hashing function)

source code

hash(x)

Overrides: object.__hash__: (inherited documentation)

init(self, klass, alias=None, **kwargs)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

repr(self)
(Representation operator)

source code

repr(x)

Overrides: object.__repr__: (inherited documentation)

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

applyAttributes(self, obj, attrs, codec=None)

source code

Applies the collection of attributes attrs to aliased object obj. Called when decoding reading aliased objects from an AMF byte stream.

Override this to provide fine grain control of application of attributes to obj.

Parameters:

codec - An optional argument that will contain the en/decoder instance calling this function.

checkClass(self, klass)

source code

This function is used to check if the class being aliased fits certain criteria. The default is to check that __new__ is available or the __init__ constructor does not need additional arguments. If this is the case then TypeError will be raised.

Since: 0.4

createInstance(self, codec=None)

source code

Creates an instance of the klass.

Returns:: Instance of self.klass.

getCustomProperties(self)

source code

Overrride this to provide known static properties based on the aliased class.

Since: 0.5

getDecodableAttributes(self, obj, attrs, codec=None)

source code

Returns a dictionary of attributes for obj that has been filtered, based on the supplied attrs. This allows for fine grain control over what will finally end up on the object or not.

Parameters:

obj - The object that will recieve the attributes.
attrs - The attrs dictionary that has been decoded.
codec - An optional argument that will contain the decoder instance calling this function.

Returns:

A dictionary of attributes that can be applied to obj

Since: 0.5

getEncodableAttributes(self, obj, codec=None)

source code

Must return a dict of attributes to be encoded, even if its empty.

Parameters:

codec - An optional argument that will contain the encoder instance calling this function.

Since: 0.5

Class ClassAlias

__hash__(self) (Hashing function)

__init__(self, klass, alias=None, **kwargs) (Constructor)

__repr__(self) (Representation operator)

__str__(self) (Informal representation operator)

applyAttributes(self, obj, attrs, codec=None)

checkClass(self, klass)

createInstance(self, codec=None)

getCustomProperties(self)

getDecodableAttributes(self, obj, attrs, codec=None)

getEncodableAttributes(self, obj, codec=None)

hash(self)
(Hashing function)

init(self, klass, alias=None, **kwargs)
(Constructor)

repr(self)
(Representation operator)

str(self)
(Informal representation operator)