# -----------------------------------------------------------------------------
# Name: corpus/__init__.py
# Purpose: Shortcuts to the corpus collection
#
# Authors: Christopher Ariza
# Michael Scott Asato Cuthbert
#
# Copyright: Copyright © 2009, 2015 Michael Scott Asato Cuthbert
# License: BSD, see license.txt
# -----------------------------------------------------------------------------
'''
The music21 corpus includes a collection of freely distributable
music in MusicXML, Humdrum, and other representations. The corpus
package is an interface for easily working with this data.
To see a complete listing of the works in the music21 corpus,
visit :ref:`referenceCorpus`. Note that music21 does not own
most of the music in the corpus -- it has been licensed to us (or
in a free license). It may not be free in all parts of the world,
but to the best of our knowledge is true for the US.
Use `corpus.parse` if you know the name of a file in the corpus:
>>> b = corpus.parse('bwv66.6')
>>> b
<music21.stream.Score bach/bwv66.6.mxl>
And use `corpus.search` if you do not:
>>> cb = corpus.search('shandy')
>>> cb
<music21.metadata.bundles.MetadataBundle {1 entry}>
>>> cb[0]
<music21.metadata.bundles.MetadataEntry 'airdsAirs_book1_abc_191'>
>>> cb[0].parse()
<music21.stream.Score airdsAirs/book1.abc>
'''
from __future__ import annotations
from collections.abc import Iterable
import typing as t
from music21 import common
from music21.exceptions21 import CorpusException
from music21 import metadata
from music21.corpus import chorales
from music21.corpus import corpora
from music21.corpus import manager
from music21.corpus import virtual
from music21.corpus import work
from music21.corpus.manager import search
from music21 import environment
__all__ = [
'CorpusException',
'addPath',
'cacheMetadata',
'chorales',
'corpora',
'getComposer',
'getCorePaths',
'getLocalPaths',
'getPaths',
# 'getVirtualPaths',
'getWork',
'manager',
'noCorpus',
'parse',
'virtual',
'search',
'work',
]
if t.TYPE_CHECKING:
import pathlib
environLocal = environment.Environment('corpus')
# -----------------------------------------------------------------------------
[docs]
def getCorePaths(
*,
fileExtensions: Iterable[str] = (),
expandExtensions=True
) -> list[pathlib.Path]:
'''
Get all paths in the corpus that match a known extension, or an extension
provided by an argument.
If `expandExtensions` is True, a format for an extension, and related
extensions, will be replaced by all known input extensions.
This is convenient when an input format might match for multiple
extensions.
>>> corpusFilePaths = corpus.getCorePaths()
>>> cpl = len(corpusFilePaths)
>>> 3000 < cpl < 4000
True
>>> kernFilePaths = corpus.getCorePaths(fileExtensions=('krn',))
>>> len(kernFilePaths) >= 500
True
>>> abcFilePaths = corpus.getCorePaths(fileExtensions=('abc',))
>>> len(abcFilePaths) >= 100
True
'''
return corpora.CoreCorpus().getPaths(
fileExtensions=fileExtensions,
expandExtensions=expandExtensions,
)
# def getVirtualPaths(*, fileExtensions: Iterable[str] = (), expandExtensions=True):
# '''
# Get all paths in the virtual corpus that match a known extension.
#
# An extension of None will return all known extensions.
#
# >>> len(corpus.getVirtualPaths()) > 6
# True
#
# '''
# return corpora.VirtualCorpus().getPaths(
# fileExtensions=fileExtensions,
# expandExtensions=expandExtensions,
# )
[docs]
def getLocalPaths(
*,
fileExtensions: Iterable[str] = (),
expandExtensions: bool = True,
) -> list[pathlib.Path]:
'''
Access files in additional directories supplied by the user and defined in
environment settings in the 'localCorpusSettings' list.
If additional paths are added on a per-session basis with the
:func:`~music21.corpus.addPath` function, these paths are also returned
with this method.
'''
return corpora.LocalCorpus().getPaths(
fileExtensions=fileExtensions,
expandExtensions=expandExtensions,
)
[docs]
def addPath(filePath, corpusName=None):
'''
Add a directory path to the Local Corpus on a *temporary* basis, i.e., just
for the current Python session.
All directories contained within the provided directory will be searched
for files with file extensions matching the currently readable file types.
Any number of file paths can be added one at a time.
An error will be raised if the file path does not exist, is already defined
as a temporary, or is already being searched by being defined with the
:class:`~music21.environment.Environment` 'localCorpusSettings' setting.
To permanently add a path to the list of stored local corpus paths,
set the 'localCorpusPath' or 'localCorpusSettings' setting of
the :class:`~music21.environment.UserSettings` object.
>>> #_DOCS_SHOW corpus.addPath('~/Documents')
Alternatively, add a directory permanently (see link above
for more details):
>>> #_DOCS_SHOW us = environment.UserSettings()
>>> #_DOCS_SHOW us['localCorpusPath'] = 'd:/desktop/'
Restart music21 after adding paths.
'''
corpora.LocalCorpus(corpusName).addPath(filePath)
[docs]
def getPaths(
*,
fileExtensions: Iterable[str] = (),
expandExtensions: bool = True,
name: Iterable[str] = ('local', 'core'), # , 'virtual'
):
'''
Get paths from core and/or local corpora.
This is the public interface for getting all corpus
paths with one function.
'''
paths = []
if 'core' in name:
paths += corpora.CoreCorpus().getPaths(
fileExtensions=fileExtensions,
expandExtensions=expandExtensions,
)
if 'local' in name:
paths += corpora.LocalCorpus().getPaths(
fileExtensions=fileExtensions,
expandExtensions=expandExtensions,
)
# if 'virtual' in name:
# paths += corpora.VirtualCorpus().getPaths(
# fileExtensions=fileExtensions,
# expandExtensions=expandExtensions,
# )
return paths
# -----------------------------------------------------------------------------
# metadata routines
# -----------------------------------------------------------------------------
[docs]
def getComposer(
composerName: str,
*,
fileExtensions: Iterable[str] = ()
):
'''
Return all filenames in the corpus that match a composer's or a
collection's name. An `fileExtensions`, if provided, defines which
extensions are returned. An `fileExtensions` of None (default) returns all
extensions.
Note that xml and mxl are treated equivalently.
>>> a = corpus.getComposer('schoenberg')
>>> len(a) > 1
True
>>> a = corpus.getComposer('bach', fileExtensions=('krn',))
>>> len(a) < 10
True
>>> a = corpus.getComposer('bach', fileExtensions=('xml',))
>>> len(a) > 10
True
'''
return corpora.CoreCorpus().getComposer(
composerName,
fileExtensions=fileExtensions,
)
[docs]
def noCorpus():
'''
Return True or False if this is a `corpus` or `noCorpus` distribution.
>>> corpus.noCorpus()
False
'''
return corpora.CoreCorpus().noCorpus
# -----------------------------------------------------------------------------
[docs]
def getWork(
workName: str,
movementNumber: int|None = None,
*,
fileExtensions: Iterable[str] = ()
) -> pathlib.Path|list[pathlib.Path]:
'''
Search all Corpora for a work, and return a file path.
N.B. does not parse the work: but it's suitable for passing
to converter.parse.
This method will return either a list of file paths or, if there is a
single match, a single file path. If no matches are found an Exception is
raised.
>>> import os, pathlib
>>> luca = corpus.getWork('luca/gloria')
>>> isinstance(luca, pathlib.Path)
True
>>> luca.name
'gloria.xml'
>>> luca.parent.name
'luca'
Multiple works give multiple paths.
>>> trecentoFiles = corpus.getWork('trecento')
>>> isinstance(trecentoFiles, list)
True
>>> isinstance(trecentoFiles[0], pathlib.Path)
True
>>> 100 < len(trecentoFiles) < 200
True
Note: if the Virtual corpus is ever brought back, it may return a URL.
'''
return manager.getWork(
workName,
movementNumber,
fileExtensions=fileExtensions
)
# pylint: disable=redefined-builtin
# noinspection PyShadowingBuiltins
[docs]
def parse(
workName: str|pathlib.Path,
movementNumber: int|None = None,
*,
number: int|None = None,
fileExtensions: Iterable[str] = (),
forceSource: bool = False,
format: str|None = None
):
'''
The most important method call for corpus.
Similar to the :func:`~music21.converter.parse` function of converter (which
takes in a filepath on the local hard drive), this function searches the
corpus (including local corpora) for a work fitting the workName
description and returns a :class:`music21.stream.Stream`.
If `movementNumber` is defined, and a movement is included in the corpus,
that movement will be returned.
If `number` is defined, and the work is a collection with multiple
components, that work number will be returned. For instance, some of our
ABC documents contain dozens of folk songs within a single file.
Advanced: if `forceSource` is True, the original file will always be loaded
freshly and pickled (e.g., pre-parsed) files will be ignored. This should
not be needed if the file has been changed, since the filetime of the file
and the filetime of the pickled version are compared. But it might be
needed if the music21 parsing routine has changed.
Example, get a chorale by Bach. Note that the source type does not need to
be specified, nor does the name Bach even (since it's the only piece with
the title BWV 66.6)
>>> bachChorale = corpus.parse('bwv66.6')
>>> len(bachChorale.parts)
4
After parsing, the file path within the corpus is stored as
`.metadata.corpusFilePath`
>>> bachChorale.metadata.corpusFilePath
'bach/bwv66.6.mxl'
* Changed in v9: corpusFilePath is stored in metadata and now has a capital 'P'.
'''
return manager.parse(
workName=workName,
movementNumber=movementNumber,
number=number,
fileExtensions=fileExtensions,
forceSource=forceSource,
format=format
)
if __name__ == '__main__':
import music21
music21.mainTest()