khard/helpers.py
def convert_to_yaml(
        name, value, indentation, indexOfColon, show_multi_line_character):
    """converts a value list into yaml syntax
    :param name: name of object (example: phone)
    :type name: str
    :param value: object contents
    :type value: str, list(str), list(list(str))
    :param indentation: indent all by number of spaces
    :type indentation: int
    :param indexOfColon: use to position : at the name string (-1 for no space)
    :type indexOfColon: int
    :param show_multi_line_character: option to hide "|"
    :type show_multi_line_character: boolean
    :returns: yaml formatted string array of name, value pair
    :rtype: list(str)
    """
    strings = []
    if isinstance(value, list):
        # special case for single item lists:
        if len(value) == 1 \
                and isinstance(value[0], str):
            # value = ["string"] should not be converted to
            # name:
            #   - string
            # but to "name: string" instead
            value = value[0]
        elif len(value) == 1 \
                and isinstance(value[0], list) \
                and len(value[0]) == 1 \
                and isinstance(value[0][0], str):
            # same applies to value = [["string"]]
            value = value[0][0]
    if isinstance(value, str):
        strings.append("%s%s%s: %s" % (
            ' ' * indentation, name, ' ' * (indexOfColon-len(name)),
            indent_multiline_string(value, indentation+4,
                                    show_multi_line_character)))
    elif isinstance(value, list):
        strings.append("%s%s%s: " % (
            ' ' * indentation, name, ' ' * (indexOfColon-len(name))))
        for outer in value:
            # special case for single item sublists
            if isinstance(outer, list) \
                    and len(outer) == 1 \
                    and isinstance(outer[0], str):
                # outer = ["string"] should not be converted to
                # -
                #   - string
                # but to "- string" instead
                outer = outer[0]
            if isinstance(outer, str):
                strings.append("%s- %s" % (
                    ' ' * (indentation+4), indent_multiline_string(
                        outer, indentation+8, show_multi_line_character)))
            elif isinstance(outer, list):
                strings.append("%s- " % (' ' * (indentation+4)))
                for inner in outer:
                    if isinstance(inner, str):
                        strings.append("%s- %s" % (
                            ' ' * (indentation+8), indent_multiline_string(
                                inner, indentation+12,
                                show_multi_line_character)))
    return strings
def convert_to_yaml(
        name, value, indentation, indexOfColon, show_multi_line_character):
    """converts a value list into yaml syntax
    :param name: name of object (example: phone)
    :type name: str
    :param value: object contents
    :type value: str, list(str), list(list(str))
    :param indentation: indent all by number of spaces
    :type indentation: int
    :param indexOfColon: use to position : at the name string (-1 for no space)
    :type indexOfColon: int
    :param show_multi_line_character: option to hide "|"
    :type show_multi_line_character: boolean
    :returns: yaml formatted string array of name, value pair
    :rtype: list(str)
    """
    strings = []
    if isinstance(value, list):
        # special case for single item lists:
        if len(value) == 1 \
                and isinstance(value[0], str):
            # value = ["string"] should not be converted to
            # name:
            #   - string
            # but to "name: string" instead
            value = value[0]
        elif len(value) == 1 \
                and isinstance(value[0], list) \
                and len(value[0]) == 1 \
                and isinstance(value[0][0], str):
            # same applies to value = [["string"]]
            value = value[0][0]
    if isinstance(value, str):
        strings.append("%s%s%s: %s" % (
            ' ' * indentation, name, ' ' * (indexOfColon-len(name)),
            indent_multiline_string(value, indentation+4,
                                    show_multi_line_character)))
    elif isinstance(value, list):
        strings.append("%s%s%s: " % (
            ' ' * indentation, name, ' ' * (indexOfColon-len(name))))
        for outer in value:
            # special case for single item sublists
            if isinstance(outer, list) \
                    and len(outer) == 1 \
                    and isinstance(outer[0], str):
                # outer = ["string"] should not be converted to
                # -
                #   - string
                # but to "- string" instead
                outer = outer[0]
            if isinstance(outer, str):
                strings.append("%s- %s" % (
                    ' ' * (indentation+4), indent_multiline_string(
                        outer, indentation+8, show_multi_line_character)))
            elif isinstance(outer, list):
                strings.append("%s- " % (' ' * (indentation+4)))
                for inner in outer:
                    if isinstance(inner, str):
                        strings.append("%s- %s" % (
                            ' ' * (indentation+8), indent_multiline_string(
                                inner, indentation+12,
                                show_multi_line_character)))
    return strings
def convert_to_yaml ( name , value , indentation , indexOfColon , show_multi_line_character ) : strings = [ ] if isinstance ( value , list ) : # special case for single item lists: if len ( value ) == 1 and isinstance ( value [ 0 ] , str ) : # value = ["string"] should not be converted to # name: #   - string # but to "name: string" instead value = value [ 0 ] elif len ( value ) == 1 and isinstance ( value [ 0 ] , list ) and len ( value [ 0 ] ) == 1 and isinstance ( value [ 0 ] [ 0 ] , str ) : # same applies to value = [["string"]] value = value [ 0 ] [ 0 ] if isinstance ( value , str ) : strings . append ( "%s%s%s: %s" % ( ' ' * indentation , name , ' ' * ( indexOfColon - len ( name ) ) , indent_multiline_string ( value , indentation + 4 , show_multi_line_character ) ) ) elif isinstance ( value , list ) : strings . append ( "%s%s%s: " % ( ' ' * indentation , name , ' ' * ( indexOfColon - len ( name ) ) ) ) for outer in value : # special case for single item sublists if isinstance ( outer , list ) and len ( outer ) == 1 and isinstance ( outer [ 0 ] , str ) : # outer = ["string"] should not be converted to # - #   - string # but to "- string" instead outer = outer [ 0 ] if isinstance ( outer , str ) : strings . append ( "%s- %s" % ( ' ' * ( indentation + 4 ) , indent_multiline_string ( outer , indentation + 8 , show_multi_line_character ) ) ) elif isinstance ( outer , list ) : strings . append ( "%s- " % ( ' ' * ( indentation + 4 ) ) ) for inner in outer : if isinstance ( inner , str ) : strings . append ( "%s- %s" % ( ' ' * ( indentation + 8 ) , indent_multiline_string ( inner , indentation + 12 , show_multi_line_character ) ) ) return strings
converts a value list into yaml syntax
    :param name: name of object (example: phone)
    :type name: str
    :param value: object contents
    :type value: str, list(str), list(list(str))
    :param indentation: indent all by number of spaces
    :type indentation: int
    :param indexOfColon: use to position : at the name string (-1 for no space)
    :type indexOfColon: int
    :param show_multi_line_character: option to hide "|"
    :type show_multi_line_character: boolean
    :returns: yaml formatted string array of name, value pair
    :rtype: list(str)
converts a value list into yaml syntax : param name : name of object ( example : phone ) : type name : str : param value : object contents : type value : str list ( str ) list ( list ( str )) : param indentation : indent all by number of spaces : type indentation : int : param indexOfColon : use to position : at the name string ( - 1 for no space ) : type indexOfColon : int : param show_multi_line_character : option to hide | : type show_multi_line_character : boolean : returns : yaml formatted string array of name value pair : rtype : list ( str )