toil.wdl.wdl_types

Module Contents

Classes

WDLType	Represents a primitive or compound WDL type:
WDLCompoundType	Represents a WDL compound type.
WDLStringType	Represents a WDL String primitive type.
WDLIntType	Represents a WDL Int primitive type.
WDLFloatType	Represents a WDL Float primitive type.
WDLBooleanType	Represents a WDL Boolean primitive type.
WDLFileType	Represents a WDL File primitive type.
WDLArrayType	Represents a WDL Array compound type.
WDLPairType	Represents a WDL Pair compound type.
WDLMapType	Represents a WDL Map compound type.
WDLFile	Represents a WDL File.
WDLPair	Represents a WDL Pair literal defined at

exception toil.wdl.wdl_types.WDLRuntimeError

Bases: RuntimeError

digraph inheritance6034d4d4ed { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLRuntimeError" [URL="#toil.wdl.wdl_types.WDLRuntimeError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; }

Unspecified run-time error.

class toil.wdl.wdl_types.WDLType(optional=False)

Represents a primitive or compound WDL type:

https://github.com/openwdl/wdl/blob/main/versions/development/SPEC.md#types

Parameters

optional (bool) –

abstract property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

property default_value: Optional[str]

Default value if optional.

Return type

Optional[str]

create(value, output=False)

Calls at runtime. Returns an instance of the current type. An error may be raised if the value is not in the correct format.

Parameters

• value (Any) – a Python object

• output (bool) –

Return type

Any

__eq__(other)

Return self==value.

Parameters

other (Any) –

Return type

bool

__str__()

Return str(self).

Return type

str

__repr__()

Return repr(self).

Return type

str

class toil.wdl.wdl_types.WDLCompoundType(optional=False)

Bases: WDLType, abc.ABC

digraph inheritancea3c6cd3045 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "WDLCompoundType" [URL="#toil.wdl.wdl_types.WDLCompoundType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL compound type."]; "WDLType" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL compound type.

Parameters

optional (bool) –

class toil.wdl.wdl_types.WDLStringType(optional=False)

Bases: WDLType

digraph inheritance0c70a18f73 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLStringType" [URL="#toil.wdl.wdl_types.WDLStringType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL String primitive type."]; "WDLType" -> "WDLStringType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL String primitive type.

Parameters

optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

property default_value: str

Default value if optional.

Return type

str

class toil.wdl.wdl_types.WDLIntType(optional=False)

Bases: WDLType

digraph inheritancec26f4d213e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLIntType" [URL="#toil.wdl.wdl_types.WDLIntType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Int primitive type."]; "WDLType" -> "WDLIntType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Int primitive type.

Parameters

optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLFloatType(optional=False)

Bases: WDLType

digraph inheritance80eb3a4ff2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLFloatType" [URL="#toil.wdl.wdl_types.WDLFloatType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Float primitive type."]; "WDLType" -> "WDLFloatType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Float primitive type.

Parameters

optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLBooleanType(optional=False)

Bases: WDLType

digraph inheritance0e33297d3d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLBooleanType" [URL="#toil.wdl.wdl_types.WDLBooleanType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Boolean primitive type."]; "WDLType" -> "WDLBooleanType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Boolean primitive type.

Parameters

optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLFileType(optional=False)

Bases: WDLType

digraph inheritance7a0c5ad6f1 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "WDLFileType" [URL="#toil.wdl.wdl_types.WDLFileType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL File primitive type."]; "WDLType" -> "WDLFileType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL File primitive type.

Parameters

optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

property default_value: str

Default value if optional.

Return type

str

class toil.wdl.wdl_types.WDLArrayType(element, optional=False)

Bases: WDLCompoundType

digraph inheritance72df9be7c3 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "WDLArrayType" [URL="#toil.wdl.wdl_types.WDLArrayType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Array compound type."]; "WDLCompoundType" -> "WDLArrayType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLCompoundType" [URL="#toil.wdl.wdl_types.WDLCompoundType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL compound type."]; "WDLType" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Array compound type.

Parameters

• element (WDLType) –

• optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLPairType(left, right, optional=False)

Bases: WDLCompoundType

digraph inheritance6b46a0427c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "WDLCompoundType" [URL="#toil.wdl.wdl_types.WDLCompoundType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL compound type."]; "WDLType" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLPairType" [URL="#toil.wdl.wdl_types.WDLPairType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Pair compound type."]; "WDLCompoundType" -> "WDLPairType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Pair compound type.

Parameters

• left (WDLType) –

• right (WDLType) –

• optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLMapType(key, value, optional=False)

Bases: WDLCompoundType

digraph inheritance622ec3662b { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "WDLCompoundType" [URL="#toil.wdl.wdl_types.WDLCompoundType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL compound type."]; "WDLType" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "WDLCompoundType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLMapType" [URL="#toil.wdl.wdl_types.WDLMapType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a WDL Map compound type."]; "WDLCompoundType" -> "WDLMapType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WDLType" [URL="#toil.wdl.wdl_types.WDLType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a primitive or compound WDL type:"]; }

Represents a WDL Map compound type.

Parameters

• key (WDLType) –

• value (WDLType) –

• optional (bool) –

property name: str

Type name as string. Used in display messages / ‘mappings.out’ if dev mode is enabled.

Return type

str

class toil.wdl.wdl_types.WDLFile(file_path, file_name=None, imported=False)

Represents a WDL File.

Parameters

• file_path (str) –

• file_name (Optional[str]) –

• imported (bool) –

class toil.wdl.wdl_types.WDLPair(left, right)

Represents a WDL Pair literal defined at https://github.com/openwdl/wdl/blob/main/versions/development/SPEC.md#pair-literals

Parameters

• left (Any) –

• right (Any) –

to_dict()

Return type

Dict[str, Any]

__eq__(other)

Return self==value.

Parameters

other (Any) –

Return type

Any

__repr__()

Return repr(self).

Return type

str