.. _moduleCorpusCorpora:

music21.corpus.corpora
======================

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

.. automodule:: music21.corpus.corpora

Corpus
------

.. autoclass:: music21.corpus.corpora.Corpus

.. rubric:: :class:`~music21.corpus.corpora.Corpus` bases

- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.corpus.corpora.Corpus` read-only properties

.. autoattribute:: music21.corpus.corpora.Corpus.cacheFilePath

.. autoattribute:: music21.corpus.corpora.Corpus.directoryInformation

.. autoattribute:: music21.corpus.corpora.Corpus.metadataBundle

.. autoattribute:: music21.corpus.corpora.Corpus.name

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.corpus.corpora.Corpus` methods

.. automethod:: music21.corpus.corpora.Corpus.all

.. automethod:: music21.corpus.corpora.Corpus.cacheMetadata

.. automethod:: music21.corpus.corpora.Corpus.getComposer

.. automethod:: music21.corpus.corpora.Corpus.getPaths

.. automethod:: music21.corpus.corpora.Corpus.getWorkList

.. automethod:: music21.corpus.corpora.Corpus.getWorkReferences

.. automethod:: music21.corpus.corpora.Corpus.rebuildMetadataCache

.. automethod:: music21.corpus.corpora.Corpus.search

.. automethod:: music21.corpus.corpora.Corpus.translateExtensions

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

CoreCorpus
----------

.. autoclass:: music21.corpus.corpora.CoreCorpus

.. rubric:: :class:`~music21.corpus.corpora.CoreCorpus` bases

- :class:`~music21.corpus.corpora.Corpus`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.corpus.corpora.CoreCorpus` read-only properties

.. autoattribute:: music21.corpus.corpora.CoreCorpus.cacheFilePath

.. autoattribute:: music21.corpus.corpora.CoreCorpus.noCorpus

Read-only properties inherited from :class:`~music21.corpus.corpora.Corpus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.corpus.corpora.Corpus.directoryInformation`
   - :attr:`~music21.corpus.corpora.Corpus.metadataBundle`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.corpus.corpora.CoreCorpus` read/write properties

.. autoattribute:: music21.corpus.corpora.CoreCorpus.manualCoreCorpusPath

.. rubric:: :class:`~music21.corpus.corpora.CoreCorpus` methods

.. automethod:: music21.corpus.corpora.CoreCorpus.getPaths

Methods inherited from :class:`~music21.corpus.corpora.Corpus`:

.. hlist::
   :columns: 3

   - :meth:`~music21.corpus.corpora.Corpus.all`
   - :meth:`~music21.corpus.corpora.Corpus.cacheMetadata`
   - :meth:`~music21.corpus.corpora.Corpus.getComposer`
   - :meth:`~music21.corpus.corpora.Corpus.getWorkList`
   - :meth:`~music21.corpus.corpora.Corpus.getWorkReferences`
   - :meth:`~music21.corpus.corpora.Corpus.rebuildMetadataCache`
   - :meth:`~music21.corpus.corpora.Corpus.search`
   - :meth:`~music21.corpus.corpora.Corpus.translateExtensions`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

LocalCorpus
-----------

.. autoclass:: music21.corpus.corpora.LocalCorpus

.. rubric:: :class:`~music21.corpus.corpora.LocalCorpus` bases

- :class:`~music21.corpus.corpora.Corpus`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.corpus.corpora.LocalCorpus` read-only properties

.. autoattribute:: music21.corpus.corpora.LocalCorpus.directoryPaths

.. autoattribute:: music21.corpus.corpora.LocalCorpus.existsInSettings

.. autoattribute:: music21.corpus.corpora.LocalCorpus.name

Read-only properties inherited from :class:`~music21.corpus.corpora.Corpus`:

.. hlist::
   :columns: 3

   - :attr:`~music21.corpus.corpora.Corpus.directoryInformation`
   - :attr:`~music21.corpus.corpora.Corpus.metadataBundle`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.corpus.corpora.LocalCorpus` read/write properties

.. autoattribute:: music21.corpus.corpora.LocalCorpus.cacheFilePath

.. rubric:: :class:`~music21.corpus.corpora.LocalCorpus` methods

.. automethod:: music21.corpus.corpora.LocalCorpus.addPath

.. automethod:: music21.corpus.corpora.LocalCorpus.delete

.. automethod:: music21.corpus.corpora.LocalCorpus.getPaths

.. automethod:: music21.corpus.corpora.LocalCorpus.removePath

.. automethod:: music21.corpus.corpora.LocalCorpus.save

Methods inherited from :class:`~music21.corpus.corpora.Corpus`:

.. hlist::
   :columns: 3

   - :meth:`~music21.corpus.corpora.Corpus.all`
   - :meth:`~music21.corpus.corpora.Corpus.cacheMetadata`
   - :meth:`~music21.corpus.corpora.Corpus.getComposer`
   - :meth:`~music21.corpus.corpora.Corpus.getWorkList`
   - :meth:`~music21.corpus.corpora.Corpus.getWorkReferences`
   - :meth:`~music21.corpus.corpora.Corpus.rebuildMetadataCache`
   - :meth:`~music21.corpus.corpora.Corpus.search`
   - :meth:`~music21.corpus.corpora.Corpus.translateExtensions`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`