rh_FSrSSKJr SSKrSSKrSSKrSSKJr SSKJr SSKJ r SSKJ r SSKJ r SS KJ r SS KJ r SS KJr "S S \ R5rSSSjjrSSSjjr"SS\R&5r\S:XaSSKr\R,"\5 gg)zT Writer for the 'RomanText' format (Tymoczko, Gotham, Cuthbert, & Ariza ISMIR 2019) ) annotationsN)bar)base)metadata)meter)prebase)roman) romanText)streamcV\rSrSrSrS SjrS SjrS SjrSrS Sjr Sr g )RnWriter a 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 cSUlSUlSUlSUl/UlU [ U[ R5(Ga8[ U[ R5(anUVs/sHn[U5PM nnUHLnURHnURRU5 M URRS5 MN g[ U[ R5(a+URR5nUbXPlOXlO[ U[ R5(aXlOl[ U[ R 5(a7[ R"5UlURR#SU5 OUR%U5UlUR&(aUR)UR&5 UR&R(aUR&RUlUR&R(aUR&RUlUR&R(aUR&RUlOUR%U/5UlSUR3SUR3SUR3S UR3S/UlUR[*R,(d0URR#S[*R,"S 55 SUlUR15 gs snf) NzComposer unknownz Title unknown rz Composer: zTitle: Analyst: Proofreader: z4/4)composertitleanalyst proofreader combinedList isinstancer StreamOpusr appendScorepartsfirst containerPartMeasureinsert_makeContainerr prepTitler TimeSignaturecurrentKeyStringprepSequentialListOfLines)selfobjxconstituentElements scoreOrSimps V/home/james-whalen/.local/lib/python3.13/site-packages/music21/romanText/writeRoman.py__init__RnWriter.__init__ysY+ $  ') c6== ) )#v{{++? ! ~~e112 NN ! !!U%8%8%? @%' &&(]'As)L?c[R"5nUHnURU5 M [R"5nUR SU5 U$)z 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"rr!r#)r)r*mr+r s r/r$RnWriter._makeContainersF NN A HHQKKKM Ac/nUR(aURUR5 UR(aURSURS35 UR(a5URUR:waURUR5 [ U5S:aSR U5Ulgg)aL 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) bestTitlermovementNumber movementNamerlenjoin)r)md workingTitles r/r%RnWriter.prepTitles* <<    -     %(9(9':! < = ??"((*##BOO4 | q ,/DJ !r5c URR[R5GHGnUR[R 5nU(a}USnUR RSUR35 [U5S:aAUSSVs/sHoDRPM nnSU3nUR RSU35 [UR5nURbXqR- nSn[UR[R 5(a&URR"S:Xa [%US S US 9nUR[&R(5n U HSn U R*bU R*R,S:XdM,UR/U 5n [%UU R0U US 9nMU [UR2[R 5(aYUR2R"S :Xa?U[&R(R55n U cS n O U R0n [%UU S US 9nU(dGM,UR RU5 GMJ gs snf)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: Nz.further time signature change(s) unprocessed: zNote: rstartg?z||:) measureNumberbeat chordStringinStringendz:||)r getElementsByClassr r"rr&rr ratioStringr<strrD numberSuffixr leftBarlinerRepeat directionrnStringr RomanNumeraltietypegetChordStringrE rightBarlinelast)r) thisMeasure tsThisMeasurefirstTSr+unprocessedTSsmsgmeasureNumberString measureStringrnsThisMeasurernrFlast_rnrEs r/r("RnWriter.prepSequentialListOfLiness)V >><JZ[C%%,,vcU^<"%k&?&?"@ ''3#'?'??#M;22CJJ??#//99WD (7J.15:2?!+ );;ERVV[[G%;"&"5"5b"9K$,;N24''9D6C%/M%;33SZZ@@#00::eC&e&8&89>>@?D"<>> 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: )keytonicPitchNameWithCasereplacer'figurerK)r)r_ keyStrings r/rTRnWriter.getChordStringOsU*FF1199#sC -- -$- ![299+. .ryy> !r5)rrrr r'rrN)r*zbase.Music21Object)r*zstream.Stream | list)r>zmetadata.Metadata)r_zroman.RomanNumeral) __name__ __module__ __qualname____firstlineno____doc__r0r$r%r(rT__static_attributes__r5r/r r sFVp;)(;)z .  0' 0Hd8L"-"r5r cU(aJURS5SSSnU[U5:wa#SUS3nUSUS3- nUS US 3- n[U5eOS U3n[U5nUS:Xa USU3nU$US USU3nU$) a 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'). r8rrBNz&The current measureNumber is given as z, but zthe contextual inString (z ) refers to zmeasure number z. They should match.r3z b)splitrK ValueErrorintBeat)rDrErFrGinStringMeasureNumberr[bt newStrings r/rPrPns8 (s 3A 6qr : !C $6 6:=/PC .xj E EC _]O3GH HCS/ ! 7 }o& B Qwj+/   j2$a }5 r5c[[[[R4n[ X5(d[ SUSUS35e[ U[[R45(a [U5nUS:aSUS3n[U5e[ U[5(aU$[U5U:Xa [U5$[X5$)a 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.) rKintfloat fractionsFractionr TypeErrorrtround)rE roundValueoptionsnegativeErrorMessages r/rurusBC 2 23G d $ $+D61B7)1MNN$i00122T{ ax!1$7NO-..$  4yD4yT&&r5c<\rSrSrSrSrSrSrSrSr Sr S r g ) Testiz 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. cSSKJn SnURSU-5nURU[R 5 [ U5nSHnURXTR5 M g)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 rr assertInr)r)rtestOpusStringtestOpustestOpusRnWriterr+s r/r Test.testOpussb & $??=>#AB h 4#H-A MM!:: ;r5c:SSKJn URS5n[U5nUR SUR 5 UR SRS5RS[R"S55 UR SRS5RS[R"S55 [U5nS nS nUR XTR 5 UR XdR 5 URUR RU5UR RU5S-5 URS 5n[U5nURURS 5 URURS 5 URUR SS5 SURlSURlSURl[U5n URU RS5 g)z~ Tests for two analysis cases (the smallest rntxt files in the music21 corpus) along with two test by modifying those scores. r)corpusz-bach/choraleAnalyses/riemenschneider004.rntxtzm10 V6/V b2 V b3 Iz10/8rBz5/8zTime Signature: 10/8z;Note: further time signature change(s) unprocessed: ['5/8']zmonteverdi/madrigal.3.8.rntxt MonteverdizLa piaga c'ho nel corezm57 Iz Fake titlei[zFake movementNamez,Fake title - No.123456789: Fake movementNameN)rrrr rrrmeasurer#rr& assertEqualindexrrrr:r;) r)r scoreBachrnaBach wonkyBach tsString1 tsString2 scoreMonternMonte adjustedMontes r/$testTwoCorpusPiecesAndTwoCorruptions)Test.testTwoCorpusPiecesAndTwoCorruptionss #LL!PQ 9% *G,@,@A ""1%,,Q0C0CF0KL""1%,,Q0C0CE0JKY' * Q  i!7!78 i!7!78 //55i@"//55i@1D F \\"AB :& ))<8 (@A --b17; %1 !-6 *+> ( ,  ,,.\]r5c6[R"5n[RR U5 [R "5n[RR U5 UR SU5 [RR U5 [R"5n[ U5 [R"5n[ U5nURUR/SQ5 [R"SS5n[ U5 g)zY Tests successful init on a range of supported objects (score, part, even RomanNumeral). r)zComposer: Composer unknownzTitle: Title unknownrrrviio6GN) r rr writeRomanr r!r#r"Voicerrr rQ)r)sr.r3v emptyWriterr_s r/testTypeParsesTest.testTypeParsesCs LLN%%a( KKM%%a( A%%a( NN  LLNqk  114     - r5c SSKJn [R"S5nUR USS9n[ U5nSR UR5R5RUR55(deg)Nrrz Time Signature: 2/4 m1 ||: C: I m2 V :|| m3 ||: I :|| m4 ||: I m5a V :|| m5b I r )formatr) rrtextwrapdedentrr r=rstripendswith)r)rrntxtrwriters r/ testRepeatsTest.testRepeatsbsj%!   OOE+O 6!yy,,-335>>u{{}MMMMr5c[SSS5nURUS5 [SSS5nURUS5 UR[5 [SSS S 5 SSS5 g!,(df  g=f) NrBzG: Izm1 G: Irzb: Vz m0 b4 b: Vrzm14 G: I)rPr assertRaisesrt)r)tests r/ testRnStringTest.testRnStringqsf1f% y)1f% |,   z * RGZ 0+ * *s A,, A:c[SSS9nURUS5 [SSS9nURUS5 [SSS9nURUS5 [SSS9nURUS5 [SSS9nURUS 5 [[R"S S 5SS9nURUS 5 [S SS9nURUS 5 UR [ 5 [/SQ5 SSS5 UR [ 5 [S5 SSS5 g!,(df  N8=f!,(df  g=f)NrB)rg?gzq?g(\?g?gUUUUUU@g\(\@rz 0.666666666gq= ףp?)rrBrg)rurr}r~rrrt)r)testInt testOneDec testRound1 testRound2 testFrac1 testFrac2testStrs r/ testIntBeatTest.testIntBeat{s!* !$SQ/  S)ZA6  T*ZA6  S)Ea0  D)I..q!4C  D)-A6 $'   y ) I *  z * DM+ ** )+ *s/D/ E/ D= ErqN) rkrlrmrnrorrrrrrrprqr5r/rrs).<`/^b> N1r5r__main__)r)rDz int | strrE&str | int | float | fractions.FractionrFrKrGz str | None)r)rErrr{)ro __future__rr}runittestrrrrrrr r r ProtoM21Objectr rPruTestCaserrkmainTestrqr5r/rs# I"w%%I"b #%/3// /f 4'4'r|8  |B z Tr5