> 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/)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.macilib.org/docs/yaml/functions/maci.yamlloadstr.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.