.. _moduleMetadataBundles:

music21.metadata.bundles
========================

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

.. automodule:: music21.metadata.bundles

MetadataBundle
--------------

.. autoclass:: music21.metadata.bundles.MetadataBundle

.. rubric:: :class:`~music21.metadata.bundles.MetadataBundle` bases

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

.. rubric:: :class:`~music21.metadata.bundles.MetadataBundle` read-only properties

.. autoattribute:: music21.metadata.bundles.MetadataBundle.filePath

.. autoattribute:: music21.metadata.bundles.MetadataBundle.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.metadata.bundles.MetadataBundle` read/write properties

.. autoattribute:: music21.metadata.bundles.MetadataBundle.corpus

.. rubric:: :class:`~music21.metadata.bundles.MetadataBundle` methods

.. automethod:: music21.metadata.bundles.MetadataBundle.__eq__

.. automethod:: music21.metadata.bundles.MetadataBundle.__getitem__

.. automethod:: music21.metadata.bundles.MetadataBundle.addFromPaths

.. automethod:: music21.metadata.bundles.MetadataBundle.clear

.. automethod:: music21.metadata.bundles.MetadataBundle.corpusPathToKey

.. automethod:: music21.metadata.bundles.MetadataBundle.delete

.. automethod:: music21.metadata.bundles.MetadataBundle.difference

.. automethod:: music21.metadata.bundles.MetadataBundle.intersection

.. automethod:: music21.metadata.bundles.MetadataBundle.isdisjoint

.. automethod:: music21.metadata.bundles.MetadataBundle.issubset

.. automethod:: music21.metadata.bundles.MetadataBundle.issuperset

.. automethod:: music21.metadata.bundles.MetadataBundle.listSearchFields

.. automethod:: music21.metadata.bundles.MetadataBundle.read

.. automethod:: music21.metadata.bundles.MetadataBundle.search

.. automethod:: music21.metadata.bundles.MetadataBundle.symmetric_difference

.. automethod:: music21.metadata.bundles.MetadataBundle.union

.. automethod:: music21.metadata.bundles.MetadataBundle.validate

.. automethod:: music21.metadata.bundles.MetadataBundle.write

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

.. hlist::
   :columns: 3

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

MetadataEntry
-------------

.. autoclass:: music21.metadata.bundles.MetadataEntry

.. rubric:: :class:`~music21.metadata.bundles.MetadataEntry` bases

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

.. rubric:: :class:`~music21.metadata.bundles.MetadataEntry` read-only properties

.. autoattribute:: music21.metadata.bundles.MetadataEntry.corpusName

.. autoattribute:: music21.metadata.bundles.MetadataEntry.corpusPath

.. autoattribute:: music21.metadata.bundles.MetadataEntry.metadata

.. autoattribute:: music21.metadata.bundles.MetadataEntry.number

.. autoattribute:: music21.metadata.bundles.MetadataEntry.sourcePath

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.metadata.bundles.MetadataEntry` methods

.. automethod:: music21.metadata.bundles.MetadataEntry.parse

.. automethod:: music21.metadata.bundles.MetadataEntry.search

.. automethod:: music21.metadata.bundles.MetadataEntry.show

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

.. hlist::
   :columns: 3

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

Functions
---------

.. autofunction:: music21.metadata.bundles.demo_bundle