j_*dZddlmZddlZddlZddlZddlmZddlmZddlm Z ddlm Z ddlm Z dd lm Z dd lm Z dd lmZGd d e jZ dd dZ d!d"dZGddejZedkrddlZejedSdS)#zT Writer for the 'RomanText' format (Tymoczko, Gotham, Cuthbert, & Ariza ISMIR 2019) ) annotationsN)bar)base)metadata)meter)prebase)roman) romanText)streamc8eZdZdZddZddZdd Zd Zdd ZdS)RnWritera Extracts the relevant information from a source (usually a :class:`~music21.stream.Stream` of :class:`~music21.roman.RomanNumeral` objects) for writing to text files in the 'RomanText' format (rntxt). Writing rntxt is handled externally in the :meth:`~music21.converter.subConverters.WriteRoman` so most users will never need to call this class directly, only invoking it indirectly through .write('rntxt'). Possible exceptions include users who want to convert Roman numerals into rntxt type strings and want to work with those strings directly, without writing to disk. For consistency with the :meth:`~music21.base.Music21Object.show` and :meth:`~music21.base.Music21Object.write` methods across music21, this class is theoretically callable on any type of music21 object. Most relevant use cases will involve calling a stream containing one or more Roman numerals. This class supports any such stream: an :class:`~music21.stream.Opus` object of one or more scores, a :class:`~music21.stream.Score` with or without :class:`~music21.stream.Part` (s), a :class:`~music21.stream.Part`, or a :class:`~music21.stream.Measure`. >>> scoreBach = corpus.parse('bach/choraleAnalyses/riemenschneider004.rntxt') >>> rnWriterFromScore = romanText.writeRoman.RnWriter(scoreBach) The strings are stored in the RnWriter's combinedList variable, starting with the metadata: >>> rnWriterFromScore.combinedList[0] 'Composer: J. S. Bach' Composer and work metadata is inherited from score metadata wherever possible. A composer entry will register directly as will any entries for workTitle, movementNumber, and movementName (see :meth:`~music21.romanText.writeRoman.RnWriter.prepTitle` for details). >>> rnWriterFromScore.combinedList[0] == 'Composer: ' + rnWriterFromScore.composer True As always, these metadata entries are user-settable. Make any adjustments to the metadata before calling this class. After the metadata, the list continues with strings for each measure in order. Here's the last in our example: >>> rnWriterFromScore.combinedList[-1] 'm10 V6/V b2 V b3 I' In the case of the score, the top part is assumed to contain the Roman numerals. This is consistent with the parsing of rntxt which involves putting Roman numerals in a part (the top, and only part) within a score. In all other cases, the objects are iteratively inserted into larger streams until we end up with a part object (e.g. measure > part). >>> rn = roman.RomanNumeral('viio64', 'a') >>> rnWriterFromRn = romanText.writeRoman.RnWriter(rn) >>> rnWriterFromRn.combinedList[0] 'Composer: Composer unknown' >>> rnWriterFromRn.combinedList[-1] 'm0 a: viio64' OMIT_FROM_DOCS Users can do these insertions themselves, but don't need to: >>> m = stream.Measure() >>> m.insert(0, rn) >>> rnWriterFromMeasure = romanText.writeRoman.RnWriter(m) >>> rnWriterFromMeasure.combinedList == rnWriterFromRn.combinedList True >>> p = stream.Part() >>> p.insert(0, m) >>> rnWriterFromPart = romanText.writeRoman.RnWriter(p) >>> rnWriterFromPart.combinedList == rnWriterFromMeasure.combinedList True >>> s = stream.Score() >>> s.insert(0, m) >>> rnWriterFromScoreWithoutPart = romanText.writeRoman.RnWriter(p) >>> rnWriterFromScoreWithoutPart.combinedList == rnWriterFromMeasure.combinedList True objbase.Music21Objectc8d|_d|_d|_d|_g|_|t |t jrt |t jrQd|D}|D]@}|jD]}|j ||j dAdSt |t j r+|j }|||_ n||_ nt |t jr||_ nht |t jr4t j|_ |j d|n|||_ |jrq||j|jjr|jj|_|jjr|jj|_|jjr|jj|_n||g|_ d|jd|jd |jd |jdg|_|j t(js-|j dt)jd d|_|dS) NzComposer unknownz Title unknownc,g|]}t|S)r .0xs /Users/tedpeters/Documents/Projects/Claude Projects/Misc Tools/notename-sheets/.venv/lib/python3.11/site-packages/music21/romanText/writeRoman.py z%RnWriter.__init__..s&@&@&@qx{{&@&@&@ rz Composer: zTitle: Analyst: Proofreader: z4/4)composertitleanalyst proofreader combinedList isinstancer StreamOpusappendScorepartsfirst containerPartMeasureinsert_makeContainerr prepTitler TimeSignaturecurrentKeyStringprepSequentialListOfLines)selfrconstituentElements scoreOrSimrps r__init__zRnWriter.__init__xs+ $  ') 0 c6= ) )$ 8#v{++ :&@&@C&@&@&@#"533J'444)003333%,,T2222C.. :IOO%%=%&DNN%(DNNC-- :!$C00 :!'%%a----"&!4!4S!9!9| @s|,,,<(:$'L$9DM<'8#&<#7DL<+@'*|'?D$"00#77DN9$-993tz33777?T-=?? ! ~e12 A N ! !!U%8%?%? @ @ @%' &&(((((rstream.Stream | listctj}|D]}||tj}|d||S)a  Makes a placeholder container for the unusual cases where this class is called on generic- or non-stream object as opposed to a :class:`~music21.stream.Score`, :class:`~music21.stream.Part`, or :class:`~music21.stream.Measure`. r)r r+r%r*r,)r2rmrr)s rr-zRnWriter._makeContainersX N    A HHQKKKKKMM Armdmetadata.MetadatacVg}|jr||j|jr|d|jd|jr*|j|jkr||jt |dkrd||_dSdS)a Attempt to prepare a single work title from the score metadata looking at each of the title, movementNumber and movementName attributes. Failing that, a placeholder 'Title unknown' stands in. >>> s = stream.Score() >>> rnScore = romanText.writeRoman.RnWriter(s) >>> rnScore.title 'Title unknown' >>> s.insert(0, metadata.Metadata()) >>> s.metadata.title = 'Fake title' >>> s.metadata.movementNumber = 123456789 >>> s.metadata.movementName = 'Fake movementName' >>> rnScoreWithMD = romanText.writeRoman.RnWriter(s) >>> rnScoreWithMD.title 'Fake title - No.123456789: Fake movementName' z- No.:r N) bestTitler%movementNumber movementNamerlenjoin)r2r: workingTitles rr.zRnWriter.prepTitles* < .    - - -  >    <(9 < < < = = = ? 5"(**##BO444 |  q ,//DJJJ ! rc>|jtjD]}|tj}|rs|d}|jd|jt|dkr6d|ddD}d|}|jd|t|j }|j ||j z }d}t|jtjr#|jjd krt%|d d | }|t&j}|D]F} | j| jjd kr-|| } t%|| j| | }Gt|jtjrS|jjd krC|t&j} | d } n| j} t%|| d| }|r|j|dS)a Prepares a sequential list of text lines, with time signatures and Roman numerals adding this to the (already prepared) metadata preamble ready for printing. >>> p = stream.Part() >>> m = stream.Measure(number=1) >>> m.insert(0, meter.TimeSignature('4/4')) >>> m.insert(0, roman.RomanNumeral('V', 'G')) >>> p.insert(0, m) >>> testCase = romanText.writeRoman.RnWriter(p) >>> testCase.combinedList[-1] # Last entry, after the metadata 'm1 G: V' This follows the wider rntxt syntax in supporting Time Signature (:class:`~music21.meter.TimeSignature`) changes and Repeats marks (:class:`~music21.bar.Repeat`) but only (currently) between measures. Let's add a new measure to the stream we started, with a time signature change beforehand and both start and end repeats in it: >>> m2 = stream.Measure(number=2) >>> m2.insert(0, meter.TimeSignature('3/4')) >>> m2.leftBarline = bar.Repeat(direction='start') >>> m2.rightBarline = bar.Repeat(direction='end') >>> m2.insert(0, roman.RomanNumeral('I', 'G')) >>> p.insert(0, m2) >>> testCase = romanText.writeRoman.RnWriter(p) The last line of the `.combinedList` gives the new measure: >>> testCase.combinedList[-1] 'm2 ||: I :||' The line before that gives the time signature change: >>> testCase.combinedList[-2] 'Time Signature: 3/4' rzTime Signature: cg|] }|j Sr) ratioStringrs rrz6RnWriter.prepSequentialListOfLines..s%O%O%Oam%O%O%OrNz.further time signature change(s) unprocessed: zNote: rstartg?z||:) measureNumberbeat chordStringinStringendz:||)r)getElementsByClassr r+rr/r!r%rHrBstrrJ numberSuffixr" leftBarlinerRepeat directionrnStringr RomanNumeraltietypegetChordStringrK rightBarlinelast) r2 thisMeasure tsThisMeasurefirstTSunprocessedTSsmsgmeasureNumberString measureStringrnsThisMeasurernrLlast_rnrKs rr1z"RnWriter.prepSequentialListOfLinessZV ><[[C%,,^c^^<<<"%k&?"@"@ '3#{'??#M;2CJ?? +#/9WDD (7J.15:2?!+!+!+ );;ERV[G%;%;"&"5"5b"9"9K$,;N24'9D6C%/%/%/M;3SZ@@ +#0:eCC&e&89>>@@?DD">> p = stream.Part() >>> m = stream.Measure() >>> m.insert(0, meter.TimeSignature('4/4')) >>> m.insert(0, roman.RomanNumeral('V', 'G')) >>> p.insert(0, m) >>> testCase = romanText.writeRoman.RnWriter(p) >>> sameKeyChord = testCase.getChordString(roman.RomanNumeral('I', 'G')) >>> sameKeyChord 'I' >>> changeKeyChord = testCase.getChordString(roman.RomanNumeral('V', 'D')) >>> changeKeyChord 'D: V' -bz: )keytonicPitchNameWithCasereplacer0figurerP)r2rd keyStrings rrYzRnWriter.getChordStringNsX*F199#sCC - - -$-D !..29.. .ry>> !rN)rr)rr7)r:r;)rdrf) __name__ __module__ __qualname____doc__r6r-r.r1rYrrrr r sVVp;);););)z     0 0 0 0Hd8d8d8L""""""rr rrJ int | strrK&str | int | float | fractions.FractionrLrPrM str | Nonec|r^|dddd}|t|kr'd|d}|d|dz }|d |d z }t|nd |}t|}|dkr|d|}n |d |d|}|S) aM Creates or extends a string of RomanText such that the output corresponds to a single measure line. If the inString is not given, None, or an empty string then this function starts a new line. >>> lineStarter = romanText.writeRoman.rnString(14, 1, 'G: I') >>> lineStarter 'm14 G: I' For any other inString, that string is the start of a measure line continued by the new values >>> continuation = romanText.writeRoman.rnString(14, 2, 'viio6', 'm14 G: I') >>> continuation 'm14 G: I b2 viio6' Naturally, this function requires the measure number of any such continuation to match that of the inString and raises an error where that is not the case. As these examples show, the chordString can be a Roman numeral alone (e.g. 'viio6') or one prefixed by a change of key ('G: I'). r>rrFNz&The current measureNumber is given as z, but zthe contextual inString (z ) refers to zmeasure number z. They should match.r9z b)splitrP ValueErrorintBeat)rJrKrLrMinStringMeasureNumberr`bt newStrings rrUrUms8 ' (s 3 3A 6qrr : !C $6$6 6 6P=PPPC ExEEE EC H]HHH HCS// ! 7 '}&& B Qww//+// 55255 55 r roundValueintcttttjf}t ||st d|d|dt |ttjfrt|}|dkrd|d}t|t |tr|St||krt|St||S)a6 Converts beats to integers if possible, and otherwise to rounded decimals. Accepts input as string, int, float, or fractions.Fraction. >>> testInt = romanText.writeRoman.intBeat(1, roundValue=2) >>> testInt 1 >>> testFrac = romanText.writeRoman.intBeat(8 / 3, roundValue=2) >>> testFrac 2.67 >>> testStr = romanText.writeRoman.intBeat('0.666666666', roundValue=2) >>> testStr 0.67 The roundValue sets the number of decimal places to round to. The default is two: >>> testRound2 = romanText.writeRoman.intBeat(1.11111111, roundValue=2) >>> testRound2 1.11 But this can be set to any integer: >>> testRound1 = romanText.writeRoman.intBeat(1.11111111, roundValue=1) >>> testRound1 1.1 Raises an error if called on a negative value. zBeat, (currently z) must be one of .rzBeat (currently z) must not be negative.) rPrfloat fractionsFractionr" TypeErrorrxround)rKr~optionsnegativeErrorMessages rryrysBC 23G dG $ $OMDMM7MMMNNN$i0122T{{ axxO$OOO-...$  4yyD4yyT:&&&rc6eZdZdZdZdZdZdZdZdZ dS) Testa  Tests for two analysis cases (the smallest rntxt files in the music21 corpus) along with two test by modifying those scores. Additional tests for the standalone functions rnString and intBeat and for handling the special case of opus objects. cddlm}d}|d|z}||tjt |}dD]}|||jdS)a As the rntxt input parser handles Opus objects (i.e. more than one score within the same rntxt files), this RnWriter also needs to accept that type. This test parses a fake (tiny) Opus file in three (really tiny!) movements. Checks ensure that the parsed version is indeed an Opus object and that the data is faithfully transferred through that process. In practice, Opus handling will bypass this module in the typical case of a simple .write() because writing Opus objects explicitly separates them into their constituent score files prior to invoking this module. r converteraComposer: Fake composer Piece: Fake piece Movement: 1 m1 C: I b3 IV b4 V m2 I Movement: 2 m1 G: I m3 IV m4 V m5 I Movement: 3 m1 C: I m2 V m3 I z romantext: )zTitle: Fake piece - No.1:zTitle: Fake piece - No.2:zTitle: Fake piece - No.3:zm2 Izm5 Izm3 IN) music21rparseassertIsInstancer r$r assertInr!)r2rtestOpusStringtestOpustestOpusRnWriterrs rrz Test.testOpuss &%%%%% $??=>#ABB h 444#H-- < ( ,,  ,.\]]]]]rcBtj}tj|tj}tj||d|tj|tj}t |tj}t |}| |j gdtj dd}t |dS)zi Tests successful init on a range of supported objects (score, part, even RomanNumeral). r)zComposer: Composer unknownzTitle: Title unknownrrrviio6GN) r r&r writeRomanr r*r,r+Voicerr!r rV)r2sr5r9v emptyWriterrds rtestTypeParseszTest.testTypeParsesBs LNN%%a((( KMM%%a((( A%%a((( N   LNNqkk  14 4 4      - - rc,ddlm}tjd}||d}t |}d|j |sJdS)Nrrz Time Signature: 2/4 m1 ||: C: I m2 V :|| m3 ||: I :|| m4 ||: I m5a V :|| m5b I r )formatr) rrtextwrapdedentrr rCr!stripendswith)r2rrntxtrwriters r testRepeatszTest.testRepeatsas%%%%%%!    OOE+O 6 6!yy,--3355>>u{{}}MMMMMMMrc,tddd}||dtddd}||d|t5tddd d ddddS#1swxYwYdS) NrFzG: Izm1 G: Irzb: Vz m0 b4 b: Vrzm14 G: I)rUr assertRaisesrx)r2tests r testRnStringzTest.testRnStringps1f%% y)))1f%% |,,,   z * * 1 1 RGZ 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1s)B  B B cXtdd}||dtdd}||dtdd}||dtdd}||dtdd}||d ttjd d d}||d td d}||d |t 5tgddddn #1swxYwY|t 5tdddddS#1swxYwYdS)NrFr})r~g?gzq?g(\?g?gUUUUUU@g\(\@rz 0.666666666gq= ףp?)rrFr}g)ryrrrrrrx)r2testInt testOneDec testRound1 testRound2 testFrac1 testFrac2testStrs r testIntBeatzTest.testIntBeatzs'!*** !$$$SQ///  S)))ZA666  T***ZA666  S)))Ea000  D)))I.q!44CCC  D)))-A666 $'''   y ) )   III                    z * *   DMMM                  s$?EE!$E!FF#&F#N) rorprqrrrrrrrrrrrrrs.<.<.<`/^/^/^b> N N N111rr__main__)r)rJrsrKrtrLrPrMru)r})rKrtr~r)rr __future__rrrunittestrrrrrrr r r ProtoM21Objectr rUryTestCaserromainTestrrrrs#""""" I"I"I"I"I"w%I"I"I"b #%/////f 4'4'4'4'4'r|||||8 |||B zNNNGTr