aridity 96

DRY config and template system, easily extensible with Python

aridity

DRY config and template system, easily extensible with Python.

This README is auto-generated, see project wiki for details.

Commands

arid-config

Print given config (with optional path in config) as shell snippet.

aridity

Interactive REPL.

processtemplate

Process the given template to stdout using config from stdin.

API

aridity.config

ConfigCtrl Objects

class ConfigCtrl(Forkable)

High level scope API.

r

@property
def r()

Get config object for reading, i.e. missing scopes will error.

w

@property
def w()

Get config object for writing, i.e. missing scopes will be created.

loadappconfig

def loadappconfig(mainfunction,
                  moduleresource,
                  encoding='ascii',
                  settingsoptional=False)

Using app name as prefix load config from the given resource, apply user settings, and return config object for app. Context module for loading resource and the app name are deduced from mainfunction, or these can be provided as a tuple. Set settingsoptional to suppress the usual error if ~/.settings.arid does not exist.

load

def load(pathorstream)

Execute config from the given path or stream.

execute

def execute(text)

Execute given config text.

__iter__

def __iter__()

Yield keys and values.

processtemplate

def processtemplate(frompathorstream, topathorstream)

Evaluate expression from path/stream and write result to path/stream.

RConfig Objects

class RConfig(Parabject)

__iter__

def __iter__()

Yield values only. Iterate over -self for keys and values.

aridity.directives

colon

def colon(prefix, suffix, scope)

Ignore rest of logical line.

source

@prime
def source(prefix, suffix, scope)

Include path or resource at prefix.

sourceifexists

@prime
def sourceifexists(prefix, suffix, scope)

Like . but allow the resource to be absent.

equals

@prime
def equals(prefix, suffix, scope)

Assign expression to path.

colonequals

@prime
def colonequals(prefix, suffix, scope)

Evaluate expression and assign result to path.

plusequals

@prime
def plusequals(prefix, suffix, scope)

Assign expression to prefix plus an opaque key, i.e. add to list.

commaequals

@prime
def commaequals(prefix, suffix, scope)

Split expression on whitespace and make a list out of the parts.

aridity.functions

screenstr

def screenstr(scope, resolvable)

GNU Screen string literal.

scstr

def scstr(scope, resolvable)

SuperCollider string literal.

hclstr

def hclstr(scope, resolvable)

HashiCorp configuration language string literal.

groovystr

def groovystr(scope, resolvable)

Groovy string literal.

pystr

def pystr(scope, resolvable)

Python literal.

shstr

def shstr(scope, resolvable)

Shell string literal.

jsonquote

def jsonquote(scope, resolvable)

JSON literal, also suitable for YAML.

xmlattr

def xmlattr(scope, resolvable)

XML attribute literal (including quotes).

xmltext

def xmltext(scope, resolvable)

XML content, suggest assigning this to & with xmlattr assigned to " as is convention.

tomlquote

def tomlquote(scope, resolvable)

TOML string literal.

urlquote

def urlquote(scope, resolvable)

Percent-encode all reserved characters.

map_

def map_(scope, objsresolvable, *args)

If given 1 arg, evaluate it against every scope in objsresolvable and return that list. If given 2 args, the first is a variable name to which each scope is temporarily assigned. If given 3 args, the first two are variable names for scope key and scope respectively.

join

def join(scope, partsresolvable, sepresolvable=None)

Concatenate the given list, using optional separator. Frequently used with map.

str_

def str_(scope, resolvable)

Coerce to string.

list_

def list_(scope, *resolvables)

Create a list.

try_

def try_(scope, *resolvables)

Attempt to evaluate each resolvable, returning the first that succeeds.

hereslash

def hereslash(scope, *resolvables)

Join the given path components with the directory of the current resource.

readfile

def readfile(scope, resolvable)

Include the content of the given path.

processtemplate

def processtemplate(scope, resolvable)

Evaluate the content of the given path as an expression.

pyref

def pyref(scope, moduleresolvable, qualnameresolvable)

Python object in given module with given qualified name. Module may be relative to current resource, in which case assignment with := is normally necessary. Typically used to import functions.

pyres

def pyres(scope, packageresolvable, nameresolvable, encoding=Text('ascii'))

Python resource for inclusion with . directive.

aridity.grammar

aridity.keyring

gpg

def gpg(scope, resolvable)

Use gpg to decrypt the given base64-encoded blob.

aridity.model

Resolvable Objects

class Resolvable(Struct)

resolve

def resolve(scope)

Evaluate this expression against the given scope.

wrap

def wrap(value)

Attempt to wrap the given value in a model object of the most specific type.

aridity.scope

Scope Objects

class Scope(Resolvable)

resolved

def resolved(*path)

Follow the given path to get an expression, evaluate it (resolving any paths it requires, recursively), and return the resulting model object.

Slash Objects

class Slash(Text, Function)

As text, the platform slash. As function, join args using that slash, starting with the last absolute path (or using all args if all relative).

aridity.util

openresource

def openresource(package_or_name, resource_name, encoding='ascii')

Like pkg_resources.resource_stream but text mode.

parabject

register

def register(obj, paracls)

Instantiate paracls, set obj to be the regular object associated with the new parabject, and return the parabject.

dereference

def dereference(parabject)

Get the regular object associated with parabject or raise UnknownParabjectException.

Parabject Objects

class Parabject()

Subclasses typically implement __getattr__ for dynamic behaviour on attribute access.

__neg__

def __neg__()

Dereference this parabject.