https://github.com/hootnot/yachain

YAML access by chained attribute names
https://github.com/hootnot/yachain

configuration configuration-parser yaml yaml-configuration

Last synced: 9 days ago
JSON representation

YAML access by chained attribute names

• Host: GitHub
• URL: https://github.com/hootnot/yachain
• Owner: hootnot
• License: mit
• Created: 2017-06-03T07:38:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-14T15:06:06.000Z (over 5 years ago)
• Last Synced: 2024-11-07T15:06:06.015Z (about 2 months ago)
• Topics: configuration, configuration-parser, yaml, yaml-configuration
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
yachain

=======

.. image:: https://travis-ci.org/hootnot/yachain.svg?branch=master

    :target: https://travis-ci.org/hootnot/yachain

.. image:: https://img.shields.io/pypi/pyversions/yachain.svg

    :target: https://github.com/hootnot/yachain

.. image:: https://img.shields.io/pypi/v/yachain.svg

   :target: https://pypi.org/project/yachain

   :alt: PyPI

.. image:: https://coveralls.io/repos/github/hootnot/yachain/badge.svg?branch=master

    :target: https://coveralls.io/github/hootnot/yachain?branch=master

YAML access on chained attribute names.

Install

-------

.. code-block:: shell

   $ pip install yachain

Suppose we have:

.. code-block:: yaml

   ---

   # config

   network:

      name: developers

      gitserver:

         ip: 192.168.178.101

         netmask: 255.255.255.0

         gateway: 192.168.178.1

         packages:

         - yum

         - gcc

With *yachain* we can access this as:

.. code-block:: python

   >>> import yachain

   >>> c = yachain.Config().load("netw.cfg")

   >>> print(c["network::gitserver::gateway"])

   192.168.178.1

   >>> print(c["network::gitserver::packages"])

   ['yum', 'gcc']

References to files / paths independent from environment

--------------------------------------------------------

References to files and paths can be used relative and absolute.

In case an attribute ends on *path* or *file* then the path can be

prefixed automatically when operation from a virtual environment is detected.

The works by default upper and lower case and can be overriden.

Using the *prefix* makes it possible to use the same config in different

environments.

.. code-block:: python

   import yachain

   import yaml

   import sys

   import os

   # yaml config:

   yc = """

   ---

   app:

     logfile: var/log/app.log

     textrules: var/app.app.txt

     database_path: var/app/db

     database_file: /var/app/db/db.txt

     database_name: db.txt

   """

   PREFIX = "/" if not hasattr(sys, 'real_prefix') else sys.prefix

   # CONFIG_FILE = os.path.join(PREFIX, "etc/app/app.cfg")

   config = yachain.Config(prefix=PREFIX, configdata=yaml.load(yc))

   for A in ["logfile",

             "textrules",

             "database_path",

             "database_file",

             "database_name"]:

       k = "app::{}".format(A)

       print config[k]

When run from a virtual environment, this will give us:

.. code-block:: bash

   /home/user/venv/var/log/app.log

   var/app.app.txt

   /home/user/venv/var/app/db

   /var/app/db/db.txt

   db.txt

So, as expected, the *logfile* and *database_path* got the PREFIX.

When run from a non-virtual environment, this will give us:

.. code-block:: bash

   /var/log/app.log

   var/app.app.txt

   /var/app/db

   /var/app/db/db.txt

   db.txt

So, as expected, prefixed with "/".