Skip to main content

An extensible config file format

Project description

yay ain't YAML
==============

yay is a configuration file format built on top of YAML based on our experience with the ConfigParser extensions buildout uses. It adds overlays (one config file including and extending another) and variables.

Consider a config file that looks something like this::

foo:
bar:
baz:
- 1
- 2
- 3
qux: wibble.wobble
quux: wobble

goo:
bar:
baz:
- 1
- 2
- 3
- 4
qux: wibble.cobble
quux: cobble

hoo:
bar:
baz:
- 1
- 3
qux: wibble.yobble
quux: yobble

With yay, this might look like this::

foo:
bar:
baz:
- 1
- 2
- 3
qux: wibble.{:quux}
quux: wobble

goo.copy: foo
goo:
bar:
baz.append:
- 4
quux: cobble

hoo.copy: foo
hoo:
bar:
baz.remove:
- 2
quux: yobble

Using yay
---------

To load yay config from a string you can use the 'load' function::

>>> from yay import load
>>> load("""
... foo:
... bar: 1
... """)
{"foo": {"bar": 1}}

If you want to load from a URI (file:// and http:// are supported) then use 'load_uri'::

>>> from yay import load_uri
>>> load_uri("/etc/someconfig.yay")
{"foo": {"bar": 1}}

The return value in both cases is a standard python dictionary.

Changelog for yay
=================

0.0.32 (2011-11-10)
-------------------

- Working package:// imports


0.0.31 (2011-11-10)
-------------------

- Better absolute path handling


0.0.30 (2011-11-10)
-------------------

- Any stream objects returned by the ``Openers()`` API now have a ``len`` property.

- The internal ``Openers()`` API can now load from any package on the Python path::

fp = Openers().open("package://some.egg/hello.txt")


0.0.29 (2011-11-10)
-------------------

- The internal ``Openers()`` API now has support for a search path::

fp = Openers(searchpath=['file:///home/john', 'http://google.com']).open("foo.txt")

- The ``Openers()`` API now supports https://


0.0.28 (2011-11-07)
-------------------

- Fully remove all Mapping default crud


0.0.27 (2011-11-03)
-------------------

- Fix ${django.SomeModel} to properly resolve


0.0.26 (2011-11-03)
-------------------

- Add support for a Django DataStore
- Allow objects exposed from Python, including simple method calls


0.0.25 (2011-10-28)
-------------------

- Fix regression in .append


0.0.24 (2011-10-22)
-------------------

- Can now foreach over a mapping
- Add ``.foreach x in y if x.z = a``
- Add '.with expression as foo:'
- Add chain and nochain mode to foreach. chain is the default.
- Major refactoring, context variable is no longer needed to resolve the graph
- The 'semi_resolve' API is now more correctly named 'expand'


0.0.23 (2011-07-26)
-------------------

- $$ escapes $ - so $${foo} is treated as a string, not a variable lookup


0.0.22 (2011-07-19)
-------------------

- Remove spurious debug messages
- Fix .import on a .foreach


0.0.21 (2011-07-19)
-------------------

- New .include directive that can use variables and appear anywhere in file


0.0.20 (2011-06-29)
-------------------

- Change ProtectedString to inherit from basestring


0.0.19 (2011-06-29)
-------------------

- Concept of a protected yay file, where any strings that end up containing
secrets will be obscured
- ProtectedString that handles concatenation of protected and unprocted strings
- GPG used to decrypt .yay.gpg files, any variables they spawn are protected

0.0.18 (2011-06-10)
-------------------

- Brown paper bag to remove stray debugging scaffold


0.0.17 (2011-06-10)
-------------------

- Fix appending to None
- Fix list access where list has already been partially resolved

0.0.16 (2011-06-10)
-------------------

- Add range tests, fixed range() as a ${} expansion
- Added sum() (but no syntax sugar)
- Allow index operations against filters
- Fix iterating over Flatten() nodes
- Fix iterating over ForEach() nodes
- Add test for empty documents that got away

0.0.15 (2011-05-18)
-------------------

- Raise an error if field access is invalid
- Add a LanguageError for displaying helpful messages when yay files
are wrong
- It is now a bug if we raise an error that doesn't descend from
yay.errors.Error


0.0.14 (2011-05-12)
-------------------

- Don't break on empty (e.g. {})


0.0.13 (2011-03-06)
-------------------

- Fix Append nodes


0.0.12 (2011-03-03)
-------------------

- Export that method ;)


0.0.11 (2011-03-03)
-------------------

- Don't be unicode unless needed
- Add a dump() method


0.0.10 (2011-02-22)
-------------------

- Don't chomp whitespace in bracketed_expression


0.0.9 (2011-02-22)
------------------

- Don't chomp whitespace in templated_string


0.0.8 (2011-02-18)
------------------

- Replace 'foreach bar as foo' with 'foreach foo in bar'


0.0.7 (2011-02-16)
------------------

- Numbers starting 0 are treated as base 8.


0.0.6 (2011-02-13)
------------------

- Avoid unicode mapping keys where possible - they break **kwargs in Py2.x


0.0.5 (2011-02-09)
------------------

- Add support for nested foreach

- At least for now, support a ruby style .flatten


0.0.4 (2011-02-04)
------------------

- {foo} can be interpreted as a map by YAML. For now, we will use ${foo} to avoid this

- Function calls to python are implemented - there is now range()

- There is now a foo.select key so switch statements can be used

0.0.3 (2011-01-24)
------------------

- Egg packaging fixes


0.0.2 (2011-01-24)
------------------

- Lots more unittests for expression evaluation and expression parsing

- Drop dependency on OrderedDict

0.0.1
-----

- This is still pre-release, no API or language stability guarantees

- Variable resolving is now done in expression tree without a seperate resolve stage

- Uses pyparsing to parse {foo[bar][@.baz > 5]} type syntax

0.0.0
-----

- This is a pre-alpha release to experiment with what we can and can't do.

- New PyYAML Loader subclass for getting ordered maps without ugly !!omap markup

- Resolves {} markup within YAML nodes

- Lazily evaluates .copy, .append and .remove instructions

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

yay-0.0.32.tar.gz (63.7 kB view hashes)

Uploaded source

Supported by

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