`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[source]¶

Bases: RuntimeError

Inheritance diagram of toil.wdl.wdl_types.WDLRuntimeError

Unspecified run-time error.

class toil.wdl.wdl_types.WDLType(optional=False)[source]¶

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)[source]¶

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)[source]¶

Return self==value.

Parameters: other (Any) –
Return type: bool

__str__()[source]¶

Return str(self).

Return type: str

__repr__()[source]¶

Return repr(self).

Return type: str

class toil.wdl.wdl_types.WDLCompoundType(optional=False)[source]¶

Bases: WDLType, abc.ABC

Inheritance diagram of toil.wdl.wdl_types.WDLCompoundType

Represents a WDL compound type.

Parameters: optional (bool) –

class toil.wdl.wdl_types.WDLStringType(optional=False)[source]¶

Bases: WDLType

Inheritance diagram of toil.wdl.wdl_types.WDLStringType

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)[source]¶

Bases: WDLType

Inheritance diagram of toil.wdl.wdl_types.WDLIntType

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)[source]¶

Bases: WDLType

Inheritance diagram of toil.wdl.wdl_types.WDLFloatType

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)[source]¶

Bases: WDLType

Inheritance diagram of toil.wdl.wdl_types.WDLBooleanType

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)[source]¶

Bases: WDLType

Inheritance diagram of toil.wdl.wdl_types.WDLFileType

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)[source]¶

Bases: WDLCompoundType

Inheritance diagram of toil.wdl.wdl_types.WDLArrayType

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)[source]¶

Bases: WDLCompoundType

Inheritance diagram of toil.wdl.wdl_types.WDLPairType

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)[source]¶

Bases: WDLCompoundType

Inheritance diagram of toil.wdl.wdl_types.WDLMapType

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)[source]¶

Represents a WDL File.

Parameters

file_path (str) –
file_name (Optional[str]) –
imported (bool) –

class toil.wdl.wdl_types.WDLPair(left, right)[source]¶

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()[source]¶

Return type: Dict[str, Any]

__eq__(other)[source]¶

Return self==value.

Parameters: other (Any) –
Return type: Any

__repr__()[source]¶

Return repr(self).

Return type: str

Fork me on GitHub