.. _moduleCorpusCorpora:

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

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

.. automodule:: music21.corpus.corpora

Functions
---------

.. autofunction:: music21.corpus.corpora.search

Corpus
------

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

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

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

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

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

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

.. automethod:: music21.corpus.corpora.Corpus.fromName

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

.. automethod:: music21.corpus.corpora.Corpus.listSearchFields

.. automethod:: music21.corpus.corpora.Corpus.parse

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

.. automethod:: music21.corpus.corpora.Corpus.updateMetadataBundle

CoreCorpus
----------

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

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

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

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

.. autoattribute:: music21.corpus.corpora.CoreCorpus.name

.. 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`

.. 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.getBachChorales

.. automethod:: music21.corpus.corpora.CoreCorpus.getComposer

.. automethod:: music21.corpus.corpora.CoreCorpus.getComposerDirectoryPath

.. automethod:: music21.corpus.corpora.CoreCorpus.getMonteverdiMadrigals

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

.. automethod:: music21.corpus.corpora.CoreCorpus.getWorkList

.. automethod:: music21.corpus.corpora.CoreCorpus.search

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

.. hlist::
   :columns: 3

   - :meth:`~music21.corpus.corpora.Corpus.fromName`
   - :meth:`~music21.corpus.corpora.Corpus.listSearchFields`
   - :meth:`~music21.corpus.corpora.Corpus.parse`
   - :meth:`~music21.corpus.corpora.Corpus.updateMetadataBundle`

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

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

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

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

.. 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`

.. 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.listLocalCorporaNames

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

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

.. automethod:: music21.corpus.corpora.LocalCorpus.search

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

.. hlist::
   :columns: 3

   - :meth:`~music21.corpus.corpora.Corpus.fromName`
   - :meth:`~music21.corpus.corpora.Corpus.listSearchFields`
   - :meth:`~music21.corpus.corpora.Corpus.parse`
   - :meth:`~music21.corpus.corpora.Corpus.updateMetadataBundle`

VirtualCorpus
-------------

.. autoclass:: music21.corpus.corpora.VirtualCorpus

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

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

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

.. autoattribute:: music21.corpus.corpora.VirtualCorpus.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`

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

.. automethod:: music21.corpus.corpora.VirtualCorpus.getPaths

.. automethod:: music21.corpus.corpora.VirtualCorpus.getWorkList

.. automethod:: music21.corpus.corpora.VirtualCorpus.search

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

.. hlist::
   :columns: 3

   - :meth:`~music21.corpus.corpora.Corpus.fromName`
   - :meth:`~music21.corpus.corpora.Corpus.listSearchFields`
   - :meth:`~music21.corpus.corpora.Corpus.parse`
   - :meth:`~music21.corpus.corpora.Corpus.updateMetadataBundle`

CorpusFile
----------

.. autoclass:: music21.corpus.corpora.CorpusFile

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

.. autoattribute:: music21.corpus.corpora.CorpusFile.ext

.. autoattribute:: music21.corpus.corpora.CorpusFile.filename

.. autoattribute:: music21.corpus.corpora.CorpusFile.format

.. autoattribute:: music21.corpus.corpora.CorpusFile.path

.. autoattribute:: music21.corpus.corpora.CorpusFile.title

CorpusWork
----------

.. autoclass:: music21.corpus.corpora.CorpusWork

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

.. autoattribute:: music21.corpus.corpora.CorpusWork.files

.. autoattribute:: music21.corpus.corpora.CorpusWork.title

.. autoattribute:: music21.corpus.corpora.CorpusWork.virtual

DirectoryInformation
--------------------

.. autoclass:: music21.corpus.corpora.DirectoryInformation

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

.. automethod:: music21.corpus.corpora.DirectoryInformation.findWorks

VirtualCorpusFile
-----------------

.. autoclass:: music21.corpus.corpora.VirtualCorpusFile

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

.. autoattribute:: music21.corpus.corpora.VirtualCorpusFile.format

.. autoattribute:: music21.corpus.corpora.VirtualCorpusFile.path

.. autoattribute:: music21.corpus.corpora.VirtualCorpusFile.title

.. autoattribute:: music21.corpus.corpora.VirtualCorpusFile.url
