configoose package

Subpackages

• configoose.cli package
  • Subpackages
    • configoose.cli.subcommand package
      • Submodules
      • configoose.cli.subcommand.conf module
      • configoose.cli.subcommand.find module
      • configoose.cli.subcommand.moor module
      • configoose.cli.subcommand.unmoor module
      • Module contents
  • Submodules
  • configoose.cli.util module
    • edit_file()
    • format_desc()
    • random_address()
  • Module contents
    • gather_command()
    • main
      • main.print_help()
      • main.run()
      • main.subcommand
    • marina_list_()
    • random_address_()
    • template_()
    • version_()
• configoose.database package
  • Module contents
    • Db
      • Db.clear
      • Db.get()
      • Db.pop
      • Db.popitem
    • FileInOsMediator
      • FileInOsMediator.read_bytes()
      • FileInOsMediator.read_text()
      • FileInOsMediator.schema_type()
      • FileInOsMediator.system_path()
    • FileInOsSchema
      • FileInOsSchema.opts
      • FileInOsSchema.postload()
    • Marina
      • Marina.is_valid_key()
    • MarinaDict
    • MarinaDirInOs
      • MarinaDirInOs.is_valid_key()
      • MarinaDirInOs.keys()
    • Mediator
      • Mediator.read_bytes()
      • Mediator.read_text()
      • Mediator.schema_type()
      • Mediator.system_path()
    • MediatorSchema
      • MediatorSchema.opts
      • MediatorSchema.postload()
      • MediatorSchema.predump()
    • ilen()
    • mediator_dumps()
    • mediator_loads()
• configoose.protocol package
  • Submodules
  • configoose.protocol.abc module
    • Protocol
      • Protocol.run()
      • Protocol.template_text()
  • configoose.protocol.configparser module
    • Protocol
      • Protocol.run()
      • Protocol.template_text()
  • configoose.protocol.iterative module
    • Protocol
      • Protocol.run()
      • Protocol.template_text()
  • configoose.protocol.methodic module
    • Error
    • Protocol
      • Protocol.run()
      • Protocol.template_text()
  • configoose.protocol.raw module
    • Protocol
      • Protocol.run()
  • Module contents
• configoose.util package
  • Submodules
  • configoose.util.algorithm module
    • algorithm
      • algorithm.run()
    • algorithm_meta
      • algorithm_meta.__call__()
      • algorithm_meta.property()
    • property()
  • configoose.util.digattr module
    • dig()
    • digattr()
  • configoose.util.dispatcher module
    • PolymorphicDispatcher
      • PolymorphicDispatcher.table()
    • Table
      • Table.__call__()
      • Table.setitem()
  • configoose.util.split_preamble module
    • InvalidPreamble
    • Preamble
    • split_preamble()
  • Module contents

Submodules

configoose.configurator module

class configoose.configurator.AbstractConfigurator(address)

Bases: ABC

Provide an interface for client programs that use configoose to configurate themselves

Parameters:

address (str) – the abstract address used to find configuration files

add_protocol(protopath, *args, **kwargs)

Declare a configuration protocol honored by the client program

Parameters:

• protopath (str) – full dotted path of a Protocol class in Python’s module system

• args – additional arguments stored in the resulting object

• kwargs – additional keyword arguments stored in the resulting object

Returns:

an AddedProtocol instance that has been registered in this configurator instance

Return type:

AddedProtocol

abstract property database

The configoose database used by this configurator

run(missing_ok=False)

Concretely executes the configuration action

Parameters:

missing_ok (bool) – indicates that an absence of configuration file must be silently ignored. Defaults to False

By a lookup in the database, the configurator tries to find a configuration file corresponding to the address given to the constructor. If this succeeds, it reads the preamble of the configuration file to extract the protocol. If this protocol has been added to the configurator, it instanciates the protocol class and calls the protocol’s run() method, passing it the AddedProtocol instance, the preamble and the remaining text of the configuration file.

class configoose.configurator.AddedProtocol(args, kwargs)

Bases: object

Object returned by configurators add_protocol() and passed to Protocol.run() methods.

Parameters:

• args – additional tuple of arguments

• kwargs – additional dict of arguments

__call__(func)

Use self as a decorator to register a handler function

Parameters:

func (Callable) – callable

Returns:

the function passed as argument unchanged

The effect of the call is to add a pair (‘handler’, func) to the kwarg dict stored in the instance. This enables protocols run() method to call the handler method because this instance is passed to these methods.

exception configoose.configurator.Error

Bases: Exception

Module contents

A module enabling Python programs and libraries to use configuration files while leaving users free to store these configuration files to the location that suits them in their file system and other locations.

configoose.root_db

The global database used by configoose

class configoose.Configurator(address)

Bases: AbstractConfigurator

Concrete configurator class using the global database

property database

The configoose database used by this configurator

configoose.init_root_db()

Initialize the root_db database

This function is executed when configoose is first imported. It processes the modules configooseconf and userconfigooseconf, if they exist, to populate the global database by adding marinas. It is not considered an error if these modules don’t exist.