2025 Python Packaging Survey is now live!  Take the survey now

Automatic object YAML mapping for Python.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jacebrowning from gravatar.com jacebrowning

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

Project description

YORM

Enables automatic, bidirectional, human-friendly mappings of object attributes to YAML files.

Build Status
Coverage Status
Scrutinizer Code Quality
PyPI Version
PyPI Downloads

Uses beyond typical object serialization and relational mapping include:

  • bidirectional conversion between basic YAML and Python types

  • attribute creation and type inference for new attributes

  • storage of content in text files optimized for version control

  • extensible converters to customize formatting on complex classes

Getting Started

Requirements

  • Python 3.3+

Installation

YORM can be installed with pip:

$ pip install YORM

or directly from the source code:

$ git clone https://github.com/jacebrowning/yorm.git
$ cd yorm
$ python setup.py install

Basic Usage

Simply take an existing class:

class Student:
    def __init__(self, name, school, number, year=2009):
        self.name = name
        self.school = school
        self.number = number
        self.year = year
        self.gpa = 0.0

and define an attribute mapping:

import yorm
from yorm.converters import String, Integer, Float

@yorm.attr(name=String, year=Integer, gpa=Float)
@yorm.sync("students/{self.school}/{self.number}.yml")
class Student:
    ...

Modifications to each object’s mapped attributes:

>>> s1 = Student("John Doe", "GVSU", 123)
>>> s2 = Student("Jane Doe", "GVSU", 456, year=2014)
>>> s1.gpa = 3

are automatically reflected on the filesytem:

$ cat students/GVSU/123.yml
name: John Doe
gpa: 3.0
school: GVSU
year: 2009

Modifications and new content in each mapped file:

$ echo "name: John Doe
> gpa: 1.8
> year: 2010
> expelled: true
" > students/GVSU/123.yml

are automatically reflected in their corresponding object:

>>> s1.gpa
1.8
>>> s1.expelled
True

Changelog

0.4 (2015-05-16)

  • Moved all converters into the yorm.converters package.

  • Renamed container to containers.

  • Renamed Converter to Convertible for mutable types

  • Added a new Converter class for immutable types

  • Removed the context manager in mapped objects.

  • Fixed automatic mapping of nested attributes.

0.3.2 (2015-04-07)

  • Fixed object overwrite when calling utilities.update.

0.3.1 (2015-04-06)

  • Fixed infinite recursion with properties that rely on other mapped attributes.

0.3 (2015-03-10)

  • Updated mapped objects to only read from the filesystem if there are changes.

  • Renamed store to sync_object.

  • Renamed store_instances to sync_instances.

  • Renamed map_attr to attr.

  • Added sync to call sync_object or sync_instances as needed.

  • Added update_object and update_file to force syncrhonization.

  • Added update to call update_object and/or update_file as needed.

0.2.1 (2015-02-12)

  • Container types now extend their builtin type.

  • Added None<Type> extended types with None as a default.

  • Added AttributeDictionary with keys available as attributes.

  • Added SortedList that sorts when dumped.

0.2 (2014-11-30)

  • Allowing map_attr and store to be used together.

  • Allowing Dictionary containers to be used as attributes.

  • Fixed method resolution order for modified classes.

  • Added a yorm.settings.fake option to bypass the filesystem.

0.1.1 (2014-10-20)

  • Fixed typos in examples.

0.1 (2014-09-29)

  • Initial release.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page