Working with YAML format
Project description
vutils-yaml: Working with YAML Format
This package provides tools for loading data from and saving data to the YAML format. Features:
- It annotates data while loading them from the YAML format. Every object
returned by
vutils.yaml.load.load_yaml
has information about its origin. This is useful when reporting errors.
Limitations:
- Due to the annotating data, this packages is not suitable for loading YAML formatted data containing thousands and hundreds of thousands items. For such amounts of data use PyYAML or other YAML parser since it is supposed that large data sets are usually machine-generated and consistent so further verification is not required.
- When used for the first time,
vutils.yaml.utils.keyloc
function builds a mapping betweendict
keys and their locations. This can be a bottle-neck for large dictionaries.
Due to the limitations, this package is suitable for parsing human-written configurations in YAML format containing at most hundreds of items.
Installation
pip install vutils-yaml
How to Use
Topic covered in this short guide is:
- loading annotated YAML data
- API reference
Loading Annotated YAML Data
To load YAML data with annotations, use the load_yaml
function from
vutils.yaml.load
. Example:
from vutils.yaml.load import load_yaml
from vutils.yaml.utils import is_null, keyloc
stream = """
---
food:
fruit:
- apple
- banana
- orange
vegetable:
- potato
- tomato
- carrot
meat: null
"""
data = load_yaml(stream)
food = data["food"]
# `if food["meat"] is None` will not work, `null` is converted to `NullType`
# object to be annotated
if is_null(food["meat"]):
# `keyloc` retrieves the annotated key object from `food` and return its
# location
print(f"{keyloc(food, 'meat')}: At least one kind of meat is required.")
Observe the testing if the value is null
and the retrieving the meat
key
location to inform a user where the problem with his/her data is.
API Reference
Module vutils.yaml.load
provide these functions:
load_yaml(stream)
loads YAML data fromstream
and annotates them.stream
can bestr
,bytes
, or afile
-like object supportingread
.
Module vutils.yaml.utils
provide these functions:
getloc(obj)
retrieves the location ofobj
keyloc(obj, kobj)
retrieves the location ofkobj
, which is a key ofdict
-like objectobj
.is_null(obj)
tests whetherobj
isnull
.is_bool(obj)
tests whetherobj
is of the Boolean type.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vutils_yaml-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39cdf59bffbc0e636c88e834ad429144fe99c5b41ff2a714b4c36926fc78f331 |
|
MD5 | c52db17e5e76e55ec8d2dd26004da506 |
|
BLAKE2b-256 | fcd85a40ea31cb33f407f1dd9251ad5781c13f9b408328ab1049fb555d53c10f |