> For the complete documentation index, see [llms.txt](https://docs.macilib.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.macilib.org/docs/yaml/functions/maci.yamlloadstr.md).

# maci.yamlloadstr

### loading a string

Loads yaml string data, and returns the corresponding python data type.

{% hint style="info" %}
maci.yamlloadstr  ->  Any
{% endhint %}

*Basic Example of loading a yaml string using default positional parameter*

```python
data = maci.yamlloadstr('key1: value1 \nkey2: value2')
```

In this example, we simply load yaml data from a string using the yamlloadstr function and pass a string as an argument to the function to load the yaml data, and assign the returned data to a variable.

### parameters & arguments

Describes all parameter functionality and accepted data types

<details>

<summary>yaml_str_data:  str</summary>

First and only required positional argument. Accepts strings

Use this parameter to pass in your yaml formatted string data

</details>

*This function uses the PyYAML framework installed as a dependency from pypi for its underlying functionality. It is only using the "safe\_load" method to protect from untrusted input. For more information on PyYAML, visit:* [*https://pypi.org/project/PyYAML/*](https://pypi.org/project/PyYAML/)