gmanka yml

some useful shortcuts for pyyaml

installation

pip install gmanka_yml

navigation

• to_str
• to_file
• from_str
• from_file
• default
• expected_type
• changelog

to_str^

converts any data to yml string and returns it

import gmanka_yml as yml

my_dict = {
    'element_1': 1,
    2: 'element_2',
    3: [
        'list_element_1',
        'list_element_2',
    ]
}

print(yml.to_str(my_dict))

output:

element_1: 1
2: element_2
3:
- list_element_1
- list_element_2

to_file^

same as to_str, but writes data to file instead of returning

yml.to_file(
    data = my_dict,
    path = 'file.yml',
)

from_str^

import gmanka_yml as yml

my_str = '''
element_1: 1
2: element_2
3:
- list_element_1
- list_element_2
'''

my_dict = yml.from_str(my_str)

print(my_dict)

print(type(my_dict))

output:

{'element_1': 1, 2: 'element_2', 3: ['list_element_1', 'list_element_2']}

<class 'dict'>

from_file^

same as from_str, but reads data from file

yml.from_file('file.yml')

default

yml.from_str(1) # raises TypeError

yml.from_str(1, default = None) # returns None

expected type

yml.from_str(
    data = '{}',
    expected_type = list,
) # raises TypeError

yml.from_str(
    data = '{}',
    default = None,
    expected_type = list,
) # returns None