objconfig package

Subpackages

• objconfig.exception package
  • Submodules
  • objconfig.exception.exceptioninterface module
  • objconfig.exception.indexexception module
  • objconfig.exception.invalidargumentexception module
  • objconfig.exception.runtimeexception module
  • Module contents
• objconfig.processor package
  • Submodules
  • objconfig.processor.processorinterface module
  • objconfig.processor.token module
  • Module contents
• objconfig.reader package
  • Submodules
  • objconfig.reader.ini module
  • objconfig.reader.json module
  • objconfig.reader.readerinterface module
  • objconfig.reader.xml module
  • objconfig.reader.yaml module
  • Module contents
• objconfig.util package
  • Submodules
  • objconfig.util.arrayaccess module
  • objconfig.util.arraymergerecursive module
  • objconfig.util.countable module
  • objconfig.util.iterator module
  • Module contents
• objconfig.writer package
  • Submodules
  • objconfig.writer.abstractwriter module
  • objconfig.writer.ini module
  • objconfig.writer.json module
  • objconfig.writer.writerinterface module
  • objconfig.writer.xml module
  • objconfig.writer.yaml module
  • Module contents

Submodules

objconfig.config module

This is a port of zend-config to Python

Some idioms of PHP are still employed, but where possible I have Pythonized it

Following is the header as given in zend-config:

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the
 *            canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc.
 *            (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

class objconfig.config.Config(array, allowModifications=False)

Bases: objconfig.util.countable.Countable, objconfig.util.iterator.Iterator, objconfig.util.arrayaccess.ArrayAccess

Following is the class documentation as given in zend-config:

/**
 * Provides a property based interface to an array.
 * The data are read-only unless $allowModifications is set to true
 * on construction.
 *
 * Implements Countable, Iterator and ArrayAccess
 * to facilitate easy access to the data.
 */

copy()

get(name, default=None)

Following is the header as given in zend-config:

/**
 * Retrieve a value and return $default if there is no element set.
 *
 * @param  string $name
 * @param  mixed  $default
 * @return mixed
 */

isReadOnly()

Following is the header as given in zend-config:

/**
 * Returns whether this Config object is read only or not.
 *
 * @return bool
 */

merge(merge)

Notes:

Checks for existence of merge and toArray method

Following is the header as given in zend-config:

/**
 * Merge another Config with this one.
 *
 * For duplicate keys, the following will be performed:
 * - Nested Configs will be recursively merged.
 * - Items in $merge with INTEGER keys will be appended.
 * - Items in $merge with STRING keys will overwrite current values.
 *
 * @param  Config $merge
 * @return Config
 */

setReadOnly()

Note:

Tests for setReadOnly method

Following is the header as given in zend-config:

/**
 * Prevent any more modifications being made to this instance.
 *
 * Useful after merge() has been used to merge multiple Config objects
 * into one object which should then not be modified again.
 *
 * @return void
 */

toArray()

Notes:

Returns a copy of the data dictionar(ies)

Following is the header as given in zend-config:

/**
 * Return an associative array of the stored data.
 *
 * @return array
 */

Module contents

objconfig.main()

Entry point for the objconfig