Configuration

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=1]; "abjad.system.AbjadConfiguration.AbjadConfiguration" [URL="../api/abjad/system/AbjadConfiguration.html#abjad.system.AbjadConfiguration.AbjadConfiguration", label="Abjad\nConfiguration", target=_top]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.Configuration.Configuration" [URL="../api/abjad/system/Configuration.html#abjad.system.Configuration.Configuration", color=black, fontcolor=white, label=Configuration, shape=oval, style="bold, filled", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.Configuration.Configuration"; "abjad.system.Configuration.Configuration" -> "abjad.system.AbjadConfiguration.AbjadConfiguration"; } subgraph cluster_builtins { graph [label=builtins]; node [color=2]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

abstract class abjad.system.Configuration.Configuration

Configuration.


Attributes Summary

__delitem__ Deletes item i from configuration.
__getitem__ Gets item or slice identified by argument.
__iter__ Iterates configuration settings.
__len__ Gets the number of settings in configuration.
__setitem__ Sets configuration item i to argument.
configuration_directory Gets configuration directory.
configuration_file_path Gets configuration file path.
get Gets a key.
home_directory Gets home directory.
temp_directory Gets temp directory.

Special methods

__delitem__(i)

Deletes item i from configuration.

Returns none.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

__getitem__(argument)

Gets item or slice identified by argument.

Returns item or slice.

__iter__()

Iterates configuration settings.

Returns generator.

__len__()

Gets the number of settings in configuration.

Returns nonnegative integer.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

__setitem__(i, argument)

Sets configuration item i to argument.

Returns none.


Methods

get(*arguments, **keywords)

Gets a key.


Read-only properties

configuration_directory

Gets configuration directory.

>>> configuration = abjad.AbjadConfiguration()
>>> configuration.configuration_directory
PosixPath('...')

Defaults to $HOME/{directory_name}.

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

Also caches the initial result to reduce filesystem interaction.

Returns path object.

configuration_file_path

Gets configuration file path.

>>> configuration = abjad.AbjadConfiguration()
>>> configuration.configuration_file_path
PosixPath('...')

Returns path object.

home_directory

Gets home directory.

>>> configuration = abjad.AbjadConfiguration()
>>> configuration.home_directory
PosixPath('...')

Returns path object.

temp_directory

Gets temp directory.

>>> configuration = abjad.AbjadConfiguration()
>>> configuration.temp_directory
PosixPath('...')

Returns path object.