YORM 0.2.1

Automatic object YAML mapping for Python.

YORM

YORM provides functions and decorators to enable automatic, bidirectional, and human-friendly mappings of Python object attributes to YAML files.

Uses beyond typical object serialization and object mapping include:

• automatic bidirectional conversion of attributes types

• attribute creation and type inference for new attributes

• storage of content in text files optimized for version control

• custom converters to map complex classes to JSON-compatible types

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:

from yorm import store_instances, map_attr
from yorm.standard import String, Integer, Float

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

Modifications to an 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 the mapped file:

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

are automatically reflected in the objects:

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

For Contributors

Requirements

• GNU Make:

  • Windows: http://cygwin.com/install.html

  • Mac: https://developer.apple.com/xcode

  • Linux: http://www.gnu.org/software/make (likely already installed)

• virtualenv: https://pypi.python.org/pypi/virtualenv#installation

• Pandoc: http://johnmacfarlane.net/pandoc/installing.html

• Graphviz: http://www.graphviz.org/Download.php

Installation

Create a virtualenv:

$ make env

Run the tests:

$ make test
$ make tests  # includes integration tests

Build the documentation:

$ make doc

Run static analysis:

$ make pep8
$ make pep257
$ make pylint
$ make check  # includes all checks

Prepare a release:

$ make dist  # dry run
$ make upload

Changelog

0.2.1 (2015-2-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.