Configuration

abstract class systemtools.Configuration

A configuration object.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_systemtools { graph [label=systemtools]; "abjad.tools.systemtools.AbjadConfiguration.AbjadConfiguration" [color=4, group=3, label=AbjadConfiguration, shape=box]; "abjad.tools.systemtools.Configuration.Configuration" [color=black, fontcolor=white, group=3, label=<<B>Configuration</B>>, shape=oval, style="filled, rounded"]; "abjad.tools.systemtools.Configuration.Configuration" -> "abjad.tools.systemtools.AbjadConfiguration.AbjadConfiguration"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } subgraph cluster_idetools { graph [label=idetools]; "ide.tools.idetools.AbjadIDEConfiguration.AbjadIDEConfiguration" [color=3, group=2, label=AbjadIDEConfiguration, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.systemtools.Configuration.Configuration"; "abjad.tools.systemtools.Configuration.Configuration" -> "ide.tools.idetools.AbjadIDEConfiguration.AbjadIDEConfiguration"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

configuration_directory_name Gets configuration directory name.
configuration_directory_path Gets configuration directory path.
configuration_file_name Gets configuration file name.
configuration_file_path Gets configuration file path.
get(\*args, \*\*kwargs) Get a key.
home_directory Gets home directory.
temp_directory Gets system temp directory.
__delitem__(i) Deletes item i from configuration.
__eq__(expr) Is true when ID of expr equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__getitem__(i) Gets item i from configuration.
__hash__() Hashes Abjad object.
__iter__() Iterates configuration settings.
__len__() Gets the number of settings in configuration.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.
__setitem__(i, arg) Sets configuration item i to arg.

Read-only properties

abstract Configuration.configuration_directory_name

Gets configuration directory name.

Returns string.

Configuration.configuration_directory_path

Gets configuration directory path.

Defaults to $HOME/{configuration_directory_name}.

If $HOME is read-only or $HOME/{configuration_directory_name} is read-only, returns $TEMP/{configuration_directory_name}.

Also caches the initial result to reduce filesystem interaction.

Returns string.

abstract Configuration.configuration_file_name

Gets configuration file name.

Returns string.

Configuration.configuration_file_path

Gets configuration file path.

Returns string.

Configuration.home_directory

Gets home directory.

Returns string.

Configuration.temp_directory

Gets system temp directory.

Returns string.

Methods

Configuration.get(*args, **kwargs)

Get a key.

Special methods

Configuration.__delitem__(i)

Deletes item i from configuration.

Returns none.

(AbjadObject).__eq__(expr)

Is true when ID of expr equals ID of Abjad object. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

Configuration.__getitem__(i)

Gets item i from configuration.

Returns none.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

Configuration.__iter__()

Iterates configuration settings.

Returns generator.

Configuration.__len__()

Gets the number of settings in configuration.

Returns nonnegative integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

Configuration.__setitem__(i, arg)

Sets configuration item i to arg.

Returns none.