SPPAS 4.20

Module sppas.src.structs

Class sppasBaseOption

Description

Class to deal with one option.

  • author: Brigitte Bigi
  • organization: Laboratoire Parole et Langage, Aix-en-Provence, France
  • contact: contact@sppas.org
  • license: GPL, v3
  • copyright: Copyright (C) 2011-2019 Brigitte Bigi

In many situations, we have to store an un-typed data and its type

separately, plus eventually other information like a description.

Such data is called "option".

An option is a set of data with a main value and its type, plus 3 other

variables to store any kind of information. By default, the type of an

option is "str", the value is an empty string and the name, text and

description are all empty strings.

Example
>>> o = sppasBaseOption("integer", "3")
>>> v = o.get_value()
>>> type(v)
>>> <type 'int'>
>>> v = o.get_untypedvalue()
>>> type(v)
>>> <type 'str'>

Constructor

Create a sppasBaseOption instance.

The type of an option is one of the key of type_mapping (i.e. 'int',

'bool', 'float', ...). Notice that the type will be normalized. For

example, 'int, 'integer', 'long or 'short' will be all stored into

'int' type.

Parameters
  • option_type: (str) Type of the option.
  • option_value: (str) Value of the option.
View Source 
def __init__(self, option_type, option_value=''):
    """Create a sppasBaseOption instance.

    The type of an option is one of the key of type_mapping (i.e. 'int',
    'bool', 'float', ...). Notice that the type will be normalized. For
    example, 'int, 'integer', 'long or 'short' will be all stored into
    'int' type.

    :param option_type: (str) Type of the option.
    :param option_value: (str) Value of the option.

    """
    self._type = ''
    self.set_type(option_type)
    self._value = option_value
    self._text = ''
    self._name = ''
    self._description = ''

Public functions

get_type

Return the type of the option.

Returns
  • normalized value of the type
View Source 
def get_type(self):
    """Return the type of the option.

        :returns: normalized value of the type

        """
    return self._type
get_untypedvalue

Return the value as it was given.

i.e. without taking the given type into account.

View Source 
def get_untypedvalue(self):
    """Return the value as it was given.

        i.e. without taking the given type into account.

        """
    return self._value
get_value

Return the typed-value or None if the type is unknown.

View Source 
def get_value(self):
    """Return the typed-value or None if the type is unknown."""
    if self._type == 'bool':
        if isinstance(self._value, bool):
            return self._value
        if self._value.lower() == 'true':
            return True
        return False
    elif self._type == 'int':
        return int(self._value)
    elif self._type == 'float':
        return float(self._value)
    elif self._type == 'str' or self._type.startswith('file'):
        if isinstance(self._value, (text_type, binary_type)) is False:
            v = str(self._value)
        else:
            v = self._value
        return u(v)
    return None
get_name

Return the name of to this option.

View Source 
def get_name(self):
    """Return the name of to this option."""
    return self._name
get_text

Return the brief text which describes the option.

View Source 
def get_text(self):
    """Return the brief text which describes the option."""
    return self._text
get_description

Return the long text which describes the option.

View Source 
def get_description(self):
    """Return the long text which describes the option."""
    return self._description
set

Set self from another instance.

Parameters
  • other: (sppasBaseOption) The option from which to get info.
View Source 
def set(self, other):
    """Set self from another instance.

        :param other: (sppasBaseOption) The option from which to get info.

        """
    self._type = other.get_type()
    self._value = other.get_untypedvalue()
    self._text = other.get_text()
    self._name = other.get_name()
    self._description = other.get_description()
set_type

Set a new type.

Possible types are: 'int', 'bool', 'float', 'str'.

If the given type is not valid, it will be set to 'str'.

Parameters
  • option_type: (str) Type of the option
Returns
  • True if option_type is valid and set.
View Source 
def set_type(self, option_type):
    """Set a new type.

        Possible types are: 'int', 'bool', 'float', 'str'.
        If the given type is not valid, it will be set to 'str'.

        :param option_type: (str) Type of the option
        :returns: True if option_type is valid and set.

        """
    option_type = str(option_type)
    option_type = option_type.lower()
    if option_type.startswith('bool'):
        self._type = 'bool'
        return True
    elif option_type.startswith('int') or option_type == 'long' or option_type == 'short':
        self._type = 'int'
        return True
    elif option_type == 'float' or option_type == 'double':
        self._type = 'float'
        return True
    elif 'file' in option_type:
        if 'name' in option_type:
            self._type = 'filename'
            return True
        elif 'path' in option_type:
            self._type = 'filepath'
            return True
    self._type = 'str'
    return False
set_value

Set a new value.

Parameters
  • value: (any type) Un-typed value of the option.
View Source 
def set_value(self, value):
    """Set a new value.

        :param value: (any type) Un-typed value of the option.

        """
    self._value = value
set_name

Set a name to describe the option.

Parameters
  • name: (str) Option description.
View Source 
def set_name(self, name):
    """Set a name to describe the option.

        :param name: (str) Option description.

        """
    self._name = name
set_text

Set a brief text to describe the option.

Parameters
  • text: (str) Option description.
View Source 
def set_text(self, text):
    """Set a brief text to describe the option.

        :param text: (str) Option description.

        """
    self._text = text
set_description

Set a long text to describe the option.

Parameters
  • description: (str) Option description.
View Source 
def set_description(self, description):
    """Set a long text to describe the option.

        :param description: (str) Option description.

        """
    self._description = description