# maci.yamlload

### loading a file

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

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

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

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

In this example, we simply load yaml data from a file using the yamlload 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.\
\
**Note:** This function loads a single yaml document in the file. If looking to load multiple yaml documents from a file, use the [yamlloadall](https://docs.macilib.org/docs/yaml/functions/maci.yamlloadall) function.

### 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" method to protect from untrusted input. For more information on PyYAML, visit:* [*https://pypi.org/project/PyYAML/*](https://pypi.org/project/PyYAML/)


---

# Agent Instructions: 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:

```
GET https://docs.macilib.org/docs/yaml/functions/maci.yamlload.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.