FunctionCodec
digraph inheritanceeeaf8628ef {
bgcolor=transparent;
rankdir=UD;
ratio=compress;
size="8.0, 12.0";
"Codec" [URL="taurus.core.util.codecs-Codec.html#taurus.core.util.codecs.Codec",color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,target="_top",tooltip="The base class for all codecs"];
"Logger" -> "Codec" [arrowsize=0.5,style="setlinewidth(0.5)"];
"FunctionCodec" [URL="#taurus.core.util.codecs.FunctionCodec",color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,target="_top",tooltip="A generic function codec"];
"Codec" -> "FunctionCodec" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Logger" [URL="taurus-Logger.html#taurus.Logger",color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,target="_top",tooltip="The taurus logger class. All taurus pertinent classes should inherit"];
}
- class FunctionCodec(func_name)[source]
A generic function codec
Import from
taurus.core.util.codecs
as:from taurus.core.util.codecs import FunctionCodec
- decode(data, *args, **kwargs)[source]
decodes the given data. This method is abstract an therefore must be implemented in the subclass.
- Parameters:
data (sequence[str, obj]) – a sequence of two elements where the first item is the encoding format of the second item object
- Returns:
a sequence of two elements where the first item is the encoding format of the second item object
- Return type:
sequence[str, obj]
- Raises:
NotImplementedError
- encode(data, *args, **kwargs)[source]
encodes the given data. This method is abstract an therefore must be implemented in the subclass.
- Parameters:
data (sequence[str, obj]) – a sequence of two elements where the first item is the encoding format of the second item object
- Returns:
a sequence of two elements where the first item is the encoding format of the second item object
- Return type:
sequence[str, obj]
- Raises:
NotImplementedError