pbcommand Task Option Types

Supported Task Option Data models

class pbcommand.models.BasePacBioOption(option_id, name, default, description)[source]

Bases: object

Core constructor for the PacBio Task Option.

Parameters:
  • option_id (str) – PacBio Task Option type id. Must adhere to the A-z0-9_
  • name (str) – Display name of the Task Option
  • default – Default value
  • description (str) – Description of the Task Option
OPTION_TYPE_ID = 'UNKNOWN'
default

Returns the default value for the option

to_dict()[source]
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
validate_option(value)[source]

Core method used externally (e.g., resolvers) to validate option

The default implementation will only validate that the “core” type is consistent with definition.

Subclasses should override this to leverage internal state (e.g, self.choices)

class pbcommand.models.PacBioIntOption(option_id, name, default, description)[source]

Bases: pbcommand.models.common.BasePacBioOption

Core constructor for the PacBio Task Option.

Parameters:
  • option_id (str) – PacBio Task Option type id. Must adhere to the A-z0-9_
  • name (str) – Display name of the Task Option
  • default – Default value
  • description (str) – Description of the Task Option
OPTION_TYPE_ID = 'integer'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
class pbcommand.models.PacBioBooleanOption(option_id, name, default, description)[source]

Bases: pbcommand.models.common.BasePacBioOption

Core constructor for the PacBio Task Option.

Parameters:
  • option_id (str) – PacBio Task Option type id. Must adhere to the A-z0-9_
  • name (str) – Display name of the Task Option
  • default – Default value
  • description (str) – Description of the Task Option
OPTION_TYPE_ID = 'boolean'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
class pbcommand.models.PacBioStringOption(option_id, name, default, description)[source]

Bases: pbcommand.models.common.BasePacBioOption

Core constructor for the PacBio Task Option.

Parameters:
  • option_id (str) – PacBio Task Option type id. Must adhere to the A-z0-9_
  • name (str) – Display name of the Task Option
  • default – Default value
  • description (str) – Description of the Task Option
OPTION_TYPE_ID = 'string'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
class pbcommand.models.PacBioFloatOption(option_id, name, default, description)[source]

Bases: pbcommand.models.common.BasePacBioOption

Core constructor for the PacBio Task Option.

Parameters:
  • option_id (str) – PacBio Task Option type id. Must adhere to the A-z0-9_
  • name (str) – Display name of the Task Option
  • default – Default value
  • description (str) – Description of the Task Option
OPTION_TYPE_ID = 'float'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
class pbcommand.models.PacBioIntChoiceOption(option_id, name, default, description, choices)[source]

Bases: pbcommand.models.common.BaseChoiceType

OPTION_TYPE_ID = 'choice_integer'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
classmethod validate_core_type_with_choices(value, choices)[source]
class pbcommand.models.PacBioFloatChoiceOption(option_id, name, default, description, choices)[source]

Bases: pbcommand.models.common.BaseChoiceType

OPTION_TYPE_ID = 'choice_float'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
classmethod validate_core_type_with_choices(value, choices)[source]
class pbcommand.models.PacBioStringChoiceOption(option_id, name, default, description, choices)[source]

Bases: pbcommand.models.common.BaseChoiceType

OPTION_TYPE_ID = 'choice_string'
classmethod validate_core_type(value)[source]

Every Option has a “core” type that needs to validated in the constructor. The function should return the value

Subclasses should implement

Parameters:value – Option value
Returns:validated value
classmethod validate_core_type_with_choices(value, choices)[source]