music21.search.lyrics¶
Classes for searching for Lyric objects.
LyricSearcher¶
-
class
music21.search.lyrics.
LyricSearcher
(s=None)¶ An object that can find lyrics that match a certain regular expression and return relevant information about the match.
Construct the LyricSearcher by passing in a Stream object (it can be a Score or Part or other nested item), and then call ”.search()” on it.
See User’s Guide, Chapter 28, Lyric Searching for full details.
Restriction: Currently searches the first lyric only. TODO: let any lyric be searched.
TODO: Bug that occasionally the previous note will be included; Search luca/gloria for “riam tuam.” (From Gloriam tuam). For some reason, the whole “Gloria” is included. Does not occur if only “iam tuam.” is searched.
TODO: allow for all intermediate notes during a search to be found.
TODO: Note that because of recursive searching w/ voices, there may be “phantom” lyrics found if a work contains multiple voices.
LyricSearcher
read-only properties
-
LyricSearcher.
indexText
¶ Returns the text that has been indexed (a la,
assembleLyrics()
):>>> p0 = corpus.parse('luca/gloria').parts[0] >>> ls = search.lyrics.LyricSearcher(p0) >>> ls.indexText[0:25] 'Et in terra pax hominibus'
LyricSearcher
methods
-
LyricSearcher.
index
(s=None)¶ A method that indexes the Stream’s lyrics and returns the list of IndexedLyric objects.
This does not actually need to be run, since calling .search() will call this if it hasn’t already been called.
>>> from pprint import pprint as pp
>>> p0 = corpus.parse('luca/gloria').parts[0] >>> ls = search.lyrics.LyricSearcher(p0) >>> pp(ls.index()[0:5]) [IndexedLyric(el=<music21.note.Note C>, start=0, end=2, measure=1, lyric=<music21.note.Lyric number=1 syllabic=single text="Et">, text=...'Et'), IndexedLyric(el=<music21.note.Note D>, start=3, end=5, measure=2, lyric=<music21.note.Lyric number=1 syllabic=single text="in">, text=...'in'), IndexedLyric(el=<music21.note.Note F>, start=6, end=9, measure=2, lyric=<music21.note.Lyric number=1 syllabic=begin text="ter">, text=...'ter'), IndexedLyric(el=<music21.note.Note F>, start=9, end=11, measure=3, lyric=<music21.note.Lyric number=1 syllabic=end text="ra">, text=...'ra'), IndexedLyric(el=<music21.note.Note A>, start=12, end=15, measure=3, lyric=<music21.note.Lyric number=1 syllabic=single text="pax">, text=...'pax')]
-
LyricSearcher.
search
(textOrRe, s=None)¶ >>> import re
>>> p0 = corpus.parse('luca/gloria').parts[0] >>> ls = search.lyrics.LyricSearcher(p0) >>> ls.search('pax') # ellipsis because of unicode in Py2 [SearchMatch(mStart=3, mEnd=3, matchText=...'pax', els=(<music21.note.Note A>,), indices=[...])]
Search a regular expression that takes into account non-word characters such as commas
>>> agnus = re.compile(r'agnus dei\W+filius patris', re.IGNORECASE) >>> sm = ls.search(agnus) >>> sm [SearchMatch(mStart=49, mEnd=55, matchText=...'Agnus Dei, Filius Patris', els=(<music21.note.Note G>,...<music21.note.Note G>), indices=[...])] >>> sm[0].mStart, sm[0].mEnd (49, 55)
IndexedLyric¶
-
class
music21.search.lyrics.
IndexedLyric
¶ A Lyric that has been indexed to its attached element and position in a Stream.
IndexedLyric
bases
IndexedLyric
read-only properties
Read-only properties inherited from IndexedLyric
:
IndexedLyric
instance variables
-
IndexedLyric.
el
¶ the element that the lyric is attached to
-
IndexedLyric.
end
¶ Suppose that the entire lyric for the stream were a single string: this is the index of the position in the string that this lyric ends at.
-
IndexedLyric.
measure
¶ The measureNumber of the measure that the element is in in the stream. Same as .el.measureNumber
-
IndexedLyric.
start
¶ Suppose that the entire lyric for the stream were a single string: this is the index of the position in the string that this lyric starts at.
-
IndexedLyric.
text
¶ The text of the lyric as a string (or in Py2 sometimes as a unicode string.
SearchMatch¶
-
class
music21.search.lyrics.
SearchMatch
¶ A lightweight object representing the match (if any) for a search.
SearchMatch
bases
SearchMatch
read-only properties
Read-only properties inherited from SearchMatch
:
SearchMatch
instance variables
-
SearchMatch.
els
¶ A list of all lyric-containing elements that matched this text.
-
SearchMatch.
indices
¶ A list
-
SearchMatch.
mEnd
¶ The measureNumber of the measure that the last matching lyric is in
-
SearchMatch.
mStart
¶ The measureNumber of the measure that the first matching lyric is in
-
SearchMatch.
matchText
¶ The text of the lyric that matched the search. For a plaintext search, this will be the same as the search term (with the possible exception of Py2 string for unicode or vice-versa substitution), but for a regular expression search this will be the text that matched the regular expression