> 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.yamlloadall.md).

# maci.yamlloadall

### loading a file

Loads multiple yaml documents from a file, and returns the corresponding python data types.

{% hint style="info" %}
maci.yamlloadall  ->  Iterator\[Any]
{% endhint %}

*Basic Example of loading a yaml file with multiple docs using default positional parameter*

```python
data = maci.yamlloadall('mydata.yml')
```

In this example, we simply load a file that contains multiple yaml documents using the yamlloadall function and pass a string of the filepath to the file as an argument to the function to load the yaml data, and assign the returned data to a variable.

The returned data will be an iterator with each item containing the individual yaml document data.\
\
Information on writing multiple YAML docs in a file:\
<https://yaml.org/spec/1.2.2/>\
<https://gettaurus.org/docs/YAMLTutorial/#YAML-Multi-Documents>

### parameters & arguments

Describes all parameter functionality and accepted data types

<details>

<summary>filename:  str | Path</summary>

First and only required positional argument. Accepts strings and [Path objects](https://docs.python.org/3/library/pathlib.html)

Use this parameter to point to your filepath

</details>

<details>

<summary>encoding:  str | None</summary>

Optional parameter. Accepts strings or None. Default = None

Use this parameter to load the data with the desired codec of the encoded data if needed. The default uses the default of python, so you don't have to use this, but you can if the data is using a specific codec.

</details>

*This function uses the PyYAML framework installed as a dependency from pypi for its underlying functionality. It is only using the "safe\_load\_all" 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.yamlloadall.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.