.. _moduleEnvironment:

music21.environment
===================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.environment

Functions
---------

.. autofunction:: music21.environment.get

.. autofunction:: music21.environment.keys

.. autofunction:: music21.environment.set

UserSettings
------------

.. autoclass:: music21.environment.UserSettings

.. rubric:: :class:`~music21.environment.UserSettings` methods

.. automethod:: music21.environment.UserSettings.create

.. automethod:: music21.environment.UserSettings.delete

.. automethod:: music21.environment.UserSettings.getSettingsPath

.. automethod:: music21.environment.UserSettings.keys

.. automethod:: music21.environment.UserSettings.restoreDefaults

Environment
-----------

.. autoclass:: music21.environment.Environment

.. rubric:: :class:`~music21.environment.Environment` methods

.. automethod:: music21.environment.Environment.formatToApp

.. automethod:: music21.environment.Environment.formatToKey

.. automethod:: music21.environment.Environment.getDefaultRootTempDir

.. automethod:: music21.environment.Environment.getKeysToPaths

.. automethod:: music21.environment.Environment.getRefKeys

.. automethod:: music21.environment.Environment.getRootTempDir

.. automethod:: music21.environment.Environment.getSettingsPath

.. automethod:: music21.environment.Environment.getTempFile

.. automethod:: music21.environment.Environment.keys

.. automethod:: music21.environment.Environment.launch

.. automethod:: music21.environment.Environment.printDebug

.. automethod:: music21.environment.Environment.read

.. automethod:: music21.environment.Environment.restoreDefaults

.. automethod:: music21.environment.Environment.warn

.. automethod:: music21.environment.Environment.write

.. rubric:: :class:`~music21.environment.Environment` instance variables

.. attribute:: Environment.modNameParent

	
	A string representation of the module that contains this
	Environment instance.
	

Preference
----------

.. autoclass:: music21.environment.Preference

.. rubric:: :class:`~music21.environment.Preference` bases

- :class:`~music21.xmlnode.XMLNode`

.. rubric:: :class:`~music21.environment.Preference` read/write properties

Read/write properties inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :attr:`~music21.xmlnode.XMLNode.tag`

.. rubric:: :class:`~music21.environment.Preference` methods

Methods inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNode.get`
   - :meth:`~music21.xmlnode.XMLNode.getNewDoc`
   - :meth:`~music21.xmlnode.XMLNode.hasAttrs`
   - :meth:`~music21.xmlnode.XMLNode.loadAttrs`
   - :meth:`~music21.xmlnode.XMLNode.merge`
   - :meth:`~music21.xmlnode.XMLNode.set`
   - :meth:`~music21.xmlnode.XMLNode.setDefaults`
   - :meth:`~music21.xmlnode.XMLNode.toxml`
   - :meth:`~music21.xmlnode.XMLNode.xmlStr`

LocalCorporaSettings
--------------------

.. autoclass:: music21.environment.LocalCorporaSettings

.. rubric:: :class:`~music21.environment.LocalCorporaSettings` bases

- :class:`~music21.xmlnode.XMLNodeList`
- :class:`~music21.xmlnode.XMLNode`

.. rubric:: :class:`~music21.environment.LocalCorporaSettings` read/write properties

Read/write properties inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :attr:`~music21.xmlnode.XMLNode.tag`

.. rubric:: :class:`~music21.environment.LocalCorporaSettings` methods

Methods inherited from :class:`~music21.xmlnode.XMLNodeList`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNodeList.append`

Methods inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNode.get`
   - :meth:`~music21.xmlnode.XMLNode.getNewDoc`
   - :meth:`~music21.xmlnode.XMLNode.hasAttrs`
   - :meth:`~music21.xmlnode.XMLNode.loadAttrs`
   - :meth:`~music21.xmlnode.XMLNode.merge`
   - :meth:`~music21.xmlnode.XMLNode.set`
   - :meth:`~music21.xmlnode.XMLNode.setDefaults`
   - :meth:`~music21.xmlnode.XMLNode.toxml`
   - :meth:`~music21.xmlnode.XMLNode.xmlStr`

LocalCorpusPath
---------------

.. autoclass:: music21.environment.LocalCorpusPath

.. rubric:: :class:`~music21.environment.LocalCorpusPath` bases

- :class:`~music21.xmlnode.XMLNode`

.. rubric:: :class:`~music21.environment.LocalCorpusPath` read/write properties

Read/write properties inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :attr:`~music21.xmlnode.XMLNode.tag`

.. rubric:: :class:`~music21.environment.LocalCorpusPath` methods

Methods inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNode.get`
   - :meth:`~music21.xmlnode.XMLNode.getNewDoc`
   - :meth:`~music21.xmlnode.XMLNode.hasAttrs`
   - :meth:`~music21.xmlnode.XMLNode.loadAttrs`
   - :meth:`~music21.xmlnode.XMLNode.merge`
   - :meth:`~music21.xmlnode.XMLNode.set`
   - :meth:`~music21.xmlnode.XMLNode.setDefaults`
   - :meth:`~music21.xmlnode.XMLNode.toxml`
   - :meth:`~music21.xmlnode.XMLNode.xmlStr`

LocalCorpusSettings
-------------------

.. autoclass:: music21.environment.LocalCorpusSettings

.. rubric:: :class:`~music21.environment.LocalCorpusSettings` bases

- :class:`~music21.xmlnode.XMLNodeList`
- :class:`~music21.xmlnode.XMLNode`

.. rubric:: :class:`~music21.environment.LocalCorpusSettings` read/write properties

Read/write properties inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :attr:`~music21.xmlnode.XMLNode.tag`

.. rubric:: :class:`~music21.environment.LocalCorpusSettings` methods

Methods inherited from :class:`~music21.xmlnode.XMLNodeList`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNodeList.append`

Methods inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNode.get`
   - :meth:`~music21.xmlnode.XMLNode.getNewDoc`
   - :meth:`~music21.xmlnode.XMLNode.hasAttrs`
   - :meth:`~music21.xmlnode.XMLNode.loadAttrs`
   - :meth:`~music21.xmlnode.XMLNode.merge`
   - :meth:`~music21.xmlnode.XMLNode.set`
   - :meth:`~music21.xmlnode.XMLNode.setDefaults`
   - :meth:`~music21.xmlnode.XMLNode.toxml`
   - :meth:`~music21.xmlnode.XMLNode.xmlStr`

Settings
--------

.. autoclass:: music21.environment.Settings

.. rubric:: :class:`~music21.environment.Settings` bases

- :class:`~music21.xmlnode.XMLNodeList`
- :class:`~music21.xmlnode.XMLNode`

.. rubric:: :class:`~music21.environment.Settings` read/write properties

Read/write properties inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :attr:`~music21.xmlnode.XMLNode.tag`

.. rubric:: :class:`~music21.environment.Settings` methods

Methods inherited from :class:`~music21.xmlnode.XMLNodeList`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNodeList.append`

Methods inherited from :class:`~music21.xmlnode.XMLNode`:

.. hlist::
   :columns: 3

   - :meth:`~music21.xmlnode.XMLNode.get`
   - :meth:`~music21.xmlnode.XMLNode.getNewDoc`
   - :meth:`~music21.xmlnode.XMLNode.hasAttrs`
   - :meth:`~music21.xmlnode.XMLNode.loadAttrs`
   - :meth:`~music21.xmlnode.XMLNode.merge`
   - :meth:`~music21.xmlnode.XMLNode.set`
   - :meth:`~music21.xmlnode.XMLNode.setDefaults`
   - :meth:`~music21.xmlnode.XMLNode.toxml`
   - :meth:`~music21.xmlnode.XMLNode.xmlStr`

SettingsHandler
---------------

.. autoclass:: music21.environment.SettingsHandler

.. rubric:: :class:`~music21.environment.SettingsHandler` methods

.. automethod:: music21.environment.SettingsHandler.characters

.. automethod:: music21.environment.SettingsHandler.endElement

.. automethod:: music21.environment.SettingsHandler.getSettings

.. automethod:: music21.environment.SettingsHandler.startElement
