rhSrSSKJr SSKrSSKrSSKrSSKrSSKrSSKrSSK r SSK J r SSK J s Jr SSKJr SSKJr SSKJr SrSS jr"S S \R.5r"S S \5r"SS\5r"SS5r\"5SS.rSr"SS5r"SS5r Sr!Sr"Sr#"SS\RH5r%\ \\/r&\'S:XaSSKr\RP"\%5 gg)a The environment module describes an object for accessing and setting variables related to the user's music21 environment. Such variables include the location of external applications such as MusicXML readers (e.g. MuseScore), whether music21 is allowed to download files directly (via the virtual corpus), and other settings. Additional documentation for and examples of using this module are found in :ref:`User's Guide, Chapter 24, Environment `. # TODO: Update to user's guide -- showing each function ) annotationsN)overload)saxutils) exceptions21)common environmentc8SX-S--n[U5(aUR(aURR5(d X2S--UlUR(aURR5(dX0lUHn[ XAS-5 M UR(aURR5(dX0lggU(a8UR(aURR5(dX0lggg)z, indent an elementTree element for printing   N)lentextstriptailetIndent)elemlevelspacesisubEls M/home/james-whalen/.local/lib/python3.13/site-packages/music21/environment.pyrr.s u~##A 4yyyy  1 1SL(DIyy  1 1IE UAI &yy  1 1I!2 $))499??+<+<I,=5c\rSrSrSrg)EnvironmentExceptionDN__name__ __module__ __qualname____firstlineno____static_attributes__rrrrrDrrc\rSrSrSrg)UserSettingsExceptionHrNrrrrr%r%Hr#rr%c<^\rSrSrSrSU4SjjrU4SjrSrU=r$)LocalCorpusSettingsNa A lightweight object for storing the 'LocalCorpusSettings' tag in the .music21rc It is a subclass of list and has two additional attributes, name (which should be None for the unnamed localCorpus) and cacheFilePath for a full filepath (ending in .json) as a location to store the .metadataBundle (.json) cache for the LocalCorpus. This can be None, in which case the (volatile) temp directory is used. >>> lcs = environment.LocalCorpusSettings(['/tmp', '/home']) >>> lcs LocalCorpusSettings(['/tmp', '/home']) >>> lcs.name = 'theWholeEnchilada' >>> lcs LocalCorpusSettings(['/tmp', '/home'], name='theWholeEnchilada') >>> lcs.cacheFilePath = '/home/enchilada.json' >>> lcs LocalCorpusSettings(['/tmp', '/home'], name='theWholeEnchilada', cacheFilePath='/home/enchilada.json') >>> list(lcs) ['/tmp', '/home'] >>> lcs.name 'theWholeEnchilada' >>> lcs.cacheFilePath '/home/enchilada.json' >>> '/home' in lcs True >>> '/root' in lcs False cF>Uc/n[TU]U5 X lX0lgN)super__init__name cacheFilePath)selfpathsr.r/ __class__s rr-LocalCorpusSettings.__init__us% =E  *rc>[TU]5nSnSnURbS[UR5-nURbS[UR5-nSUUUS3$)Nz, name=z, cacheFilePath=zLocalCorpusSettings())r,__repr__r.reprr/)r0listReprnamePartmdbpPartr2s rr7LocalCorpusSettings.__repr__|sn7#% 99  4 ?2H    ))D1C1C,DDH%hZz(1EEr)r/r.)NNN) rrr r!__doc__r-r7r" __classcell__)r2s@rr(r(Ns$L+FFrr(c\rSrSrSrSSjrSrSrSrSr SS jr SS jr SS jr SS jr S rSrSrSrSrSSSjjrSrSrSrSSjrSrSSjrSrg)_EnvironmentCoreax This private class should never be directly created; use the Environment object to access this object. Multiple Environment instances may exist, but all share access to the same _EnvironmentCore instance that is stored in this module. The only case in which a new _EnvironmentCore is created is if the forcePlatform argument is passed and is different from the stored forcePlatform argument. This is only used in testing--it allows authors to test what the settings on a different platform (win, Mac, etc.) would be. NOTE: this is a private class. All documentation for public methods should be placed in the Environment class. Nc0Ul/UlSHnURRU5 M URUS9 UcUR 5 SUlg)N) braillePath graphicsPath lilypondPathlocalCorpusPathmanualCoreCorpusPathmidiPathmusescoreDirectPNGPath musicxmlPathpdfPath vectorPath forcePlatform)_ref _keysToPathsappend _loadDefaultsreaddefaultRootTempDir)r0rNpathKeys rr-_EnvironmentCore.__init__sa   G    $ $W -   7  IIK"&rcXR;aUS:wa[SU35eUS:waURUnO/[URS5n[U5S:aUSnOSn[ U[ 5(aUR SSS9n[U5R5nUS :XaUS :Xa[RnO~US :Xa[RnOgS U;a[RnOPS U;a[RnO9SU;a[RnO"SU;a[RnO [U5nUb1US:wa+XR5;a[ R""U5nU$SnU$)NrFno preference: localCorpusSettingsrr5utf-8replace)encodingerrorsdebugtruefalseoffuserdevelall)rOrlistr isinstancebytesdecodestrlowerr DEBUG_USER DEBUG_OFF DEBUG_DEVEL DEBUG_ALLintgetKeysToPathspathlibPath)r0keyvaluer1valueStrs r __getitem___EnvironmentCore.__getitem__sZ ii C+<$<&'>? ? # #IIcNE#89:E5zA~a eU # #LL')LDEu:##% '>6!))W$((("((8#))H$**("((E   "))++ U+ E rcg)Nz rr0s rr7_EnvironmentCore.__repr__src:SUR5;aUb[R"USS9nXR;aUS:wa[ SU35eUS:XaSnSnUS:Xa'UR5nU[R ;aSnOzUS :Xa'UR5nU[R ;aSnOMUS :Xa'UR5nU[R;aSnO US :Xa[U[5(aSnOSnU(d[ US U35e[U[5(a[R"U5nUS:XaE[U5URS ;a(URS R[U55 ggX RU'g) NpathF returnPathlibrFrXr5 showFormatT writeFormat autoDownloadrYz, is not an acceptable value for preference: )rjr cleanpathrOrVALID_SHOW_FORMATSVALID_WRITE_FORMATSVALID_AUTO_DOWNLOADrfr(rirescaperQ)r0rsrtvalids r __setitem___EnvironmentCore.__setitem__s SYY[ U%6$$U%@E ii ''*_SE+BCC B;E , KKME111 M !KKME222 N "KKME222 ) )%!455E&'EcUKM M eS ! !OOE*E # #5z+@!AA /077E CB#IIcNrc,[UR5$r+)r8rOrys r__str___EnvironmentCore.__str__$sDIIrcNUc0nUR5nUGHnURS:Xa[5nUHqnURS:Xa-URR 5nUR U5 M@URS:XdMRURR 5UlMs XRS'MURS:Xa0US'UHnURS5n [5nXlUHqnURS:Xa-URR 5nUR U5 M@URS:XdMRURR 5UlMs XRSU 'M GM[URS5n URS5n X;aGMXU 'GM g)zx Takes in a ElementTree and possibly an already populated reference dictionary (or creates a new one) and populates it. NrYrFr/localCorporaSettingsr.rt) getroottagr(rrrQr/getr.) r0 settingsTreerefsettingsslotlcs slotChild fpCandidaterYr.rts r _fromSettings_EnvironmentCore._fromSettings(sr ;C'')Dxx00)+!%I }}(99&/nn&:&:&<  ;/"/9,5NN,@,@,B) "& .1)*33.0*++/'.226:D-/C#H%8 $==,==*3..*>*>*@KJJ{3&]]o=090D0D0FC- &9 9<./5,0xx')?!&IArc&SURS'SURS'SURS'SURS'SURS'SURS 'SURS 'SURS 'SURS 'SURS 'SURS'SURS'SURS'SURS'SURS'SURS'SURS'SURS'[5URS'0URS'SURS'Uc[R"5nOUnUS:Xa?SS [R"S 54S[R"S 544H up4X@U'M gUS!:XaS"H up4X@U'M gUS#:XaR[R "5nUSS$:dUSS%:Xa USS&:aS'nOS(nS)S*S U4S U4S U4S+S,4H up4X@U'M gg)-z; Load defaults. All keys are derived from these defaults. NdirectoryScratchrElilypondVersionpdflilypondFormatpslilypondBackendrJrHrDrLrKrCrImusicxmlrrzipython.musicxml.pngipythonShowFormataskrrr^r warningsrYrrGwin)rElilypondz-%PROGRAMFILES%\MuseScore 3\bin\MuseScore3.exenix))rEz/usr/bin/lilypond)rJ/usr/bin/mscore3)rIr)rD/usr/bin/xdg-open)rKrdarwin z /System/Applications/Preview.appz/Applications/Preview.app)rEz:/Applications/Lilypond.app/Contents/Resources/bin/lilypond)rJ3/Applications/MuseScore 3.app/Contents/MacOS/mscore)rHz/Applications/GarageBand.app)rIr)rOr(r getPlatformr macOSVersion)r0rNplatformr.rt versionTuplepreviewLocations rrR_EnvironmentCore._loadDefaultsRsg)- $%%) .!(, #$&+ "#'+ #$%) .!!% *%) .!#' , $ )$( - /3 *+", ,#- - )? %&$) .! '!" *,?+@ '(,. (),0 ()  ))+H$H u ,!!"RS*!!"RS   #T     #T   !!..0LA"$aB)>" and return that object r\rZrrYrFr/r)r.r.rt preference) rOETElement ElementTreesorteditemsrirrQr/)r0r settingsDictrrrsrtrrYfilePathrFmdbprr.attribsrs r toSettingsXML_EnvironmentCore.toSettingsXMLs ;))C"G, ::j,7~~h/  -JCC++&(jj1F&G# &s H&(jj1B&CO+/28},'..? !, $$0::o6D #C$5$5 6DI'..t4 34..')zz2H'I$!' !6ID*,**5JQU*V'$*3K*,**5F*G#/36x=O0+22?C %0 ((4!zz/:$'(9(9$: +2248(//0CD"7 45"3-$'*5zGG$zz,8%M.NrcURUR5(a UR$[R"[R "55S- UlURUR5(a UR$URR 5 UR$![Ga [R"5S;aE[R"5n[R"[R "55SU3- nO([R"[R"SS95nURU5(aX lUR$UR 5 X lUR$![a= [R"[R "55UlUR$f=ff=f)a returns whatever tempfile.gettempdir() returns plus 'music21'. Creates the subdirectory if it doesn't exist: >>> import tempfile >>> import pathlib >>> tempFile = tempfile.gettempdir() >>> #_DOCS_SHOW tempFile '/var/folders/x5/rymq2tx16lqbpytwb1n_cc4c0000gn/T' >>> import os >>> e = environment.Environment() >>> e.getDefaultRootTempDir() == pathlib.Path(tempFile) / 'music21' True If failed to create the subdirectory (OSError is raised), this function will return (1), for Linux and Mac platforms, a subdirectory under the system temp directory which is named with 'music21-userid-$UID' or (2), for other platforms, a temporary directory which is created by tempfile.mkdtemp(prefix="music21-"), which is named with 'music21-' plus 8 hashed codes, and (3) if failing for both above, it will return the directory from tempfile.gettempdir(). The location of this directory depends on OS. Note the temporary directory may be different in each python session. music21rrmusic21-userid-zmusic21-)prefix) rrTrqrrtempfile gettempdirmkdirOSErrorrrrgetuidmkdtemp)r0uiddir_paths rgetDefaultRootTempDir&_EnvironmentCore.getDefaultRootTempDirs:  # #D$;$; < <** *#*,,x/B/B/D"E "Q  # #D$;$; < <** * V''--/$** *# V%%'+<<))+C&||H,?,?,ABWZV[E\\H&||H,<,>> e = environment.Environment() >>> for i in e.getKeysToPaths(): ... #_DOCS_SHOW print(i) ... pass #_DOCS_HIDE braillePath graphicsPath lilypondPath ... )rPrys rrp_EnvironmentCore.getKeysToPaths7s   rcH[URR55$)z Find all keys (in any order)... >>> e = environment.Environment() >>> for i in e.getRefKeys(): ... #_DOCS_SHOW print(i) ... pass #_DOCS_HIDE lilypondBackend pdfPath lilypondVersion graphicsPath ... rerOkeysrys r getRefKeys_EnvironmentCore.getRefKeysGs DIINN$%%rcURScUR5$[R"URS5nUR 5(d[ SR U55eU$)z gets either the directory in key 'directoryScratch' or self.getDefaultRootTempDir Returns an exception if directoryScratch is defined but does not exist. Returns a pathlib.Path rzcuser-specified scratch directory ({!s}) does not exist; remove preference file or reset Environment)rOrrqrrrrformat)r0refDirs rgetRootTempDir_EnvironmentCore.getRootTempDirYsn 99' ( 0--/ /dii(:;<}}&>>Df?  rc[R"5nS[R;a+[R "[RS5S- nOSnUS:XaS[R;a,[R "[RS5nUS- $U(aUnUS- $[R "[R RS55nUS- $US;aS [R;ag[R"[RS [R5(a,[R "[RS 5nUS - $[R "S 5nUS - $g) z9 Return a pathlib.Path object to the '.music21rc' object USERPROFILEzApplication DataNrAPPDATA~zmusic21-settings.xmlrHOMEz/tmp/z .music21rc) rrrenvironrqrrr| expanduserrr)r0ruserProfilePath directorys rgetSettingsPath _EnvironmentCore.getSettingsPathns4%%' BJJ &%ll2::m+DEHZZO"O u BJJ&#LLI)>? 55 5 !+ 55 5$LL););C)@A 55 5 * *# "**V2Dbgg(N(N#LLF);< |+ +$LL1 |+ + +rcUR5nU(aURS5(dSU-n[R"X1SS9nURnSSS5 U(a[ R "W5$W$!,(df  N-=f)a Gets a temporary file with a suffix that will work for a bit. v5 -- added returnPathlib. v6 -- returnPathlib defaults to True OMIT_FROM_DOCS >>> e = environment.Environment() >>> tmp1 = e.getTempFile(returnPathlib=False) >>> isinstance(tmp1, str) True >>> import pathlib >>> tmp2 = e.getTempFile() >>> isinstance(tmp2, pathlib.Path) True >>> import os >>> os.remove(tmp1) >>> os.remove(tmp2) .F)dirsuffixdeleteN)r startswithrNamedTemporaryFiler.rqrr)r0rr~rootDirntfntf_names r getTempFile_EnvironmentCore.getTempFiless*%%' &++C006\F  ( (WE RVYxxHS <<) )O S Rs  A<< B cP[URR55S/-$)NrFrrys rr_EnvironmentCore.keyss!DIINN$%):(;;;rcSnUS:XaSnU$US;aSnU$US:XaSnU$US:XaS nU$US ;aS nU$US :XaS nU$US:XaSnU$)a Finds the appropriate key to the file/app that can launch the given format: >>> e = environment.Environment() >>> e.formatToKey('lilypond') 'lilypondPath' >>> e.formatToKey('png') 'graphicsPath' >>> e.formatToKey('jpeg') 'graphicsPath' >>> e.formatToKey('svg') 'vectorPath' >>> e.formatToKey('pdf') 'pdfPath' >>> e.formatToKey('musicxml') 'musicxmlPath' >>> e.formatToKey('midi') 'midiPath' >>> e.formatToKey('braille') 'braillePath' returns None if there is no key for this format (whether the format exists or not) >>> e.formatToKey('ipython') is None # actual format True >>> e.formatToKey('adobePhotoshop') is None # not a music21 format True NrrE)pngjpegrDsvgrLrrK)rrJmidirHbraillerCrr0 m21FormatenvironmentKeys r formatToKey_EnvironmentCore.formatToKeys:  "+N/ )+N% )N% &N - '+N  & 'N) #*NrcURU5nUb,X R;a[US-5eURU$g)z5 Given a format, return the app that will launch it. Nz is not set in UserSettings. )r rOrrs r formatToApp_EnvironmentCore.formatToAppsG)))4  %YY.*><[+[\\99^, ,rc :UcUR5nUR5(dg[R"[ U55nURX R5 g![R a n[ SUS[ U535UeSnAff=f)zi Read the environment file from .music21rc and call _fromSettings Called only once per music21 instance. NzCannot parse file z: ) rrrparseri ParseErrorrrrO)r0rrpes rrS_EnvironmentCore.reads  ++-H   88CM2L <3 }} &$XJbR :  sA&&B:BBc20UlUR5 g)z3 Changes everything to default but does not write. N)rOrRrys rrestoreDefaults _EnvironmentCore.restoreDefaultss  rcUcUR5nUbURR5(d[SU35eUR 5n[ UR 55 UR[U5SS9 g)zE Write the .music21rc using `.getSettingsPath` and `.toSettingsXML`. Nzbad file path for .music21rc: rZ)r\) rparentrrrrrwriteri)r0rrs rr_EnvironmentCore.writes}  ++-H  8??#9#9#;#;&)Gz'RS S))+ %%'( 3x=7;r)rPrOrTr+)r|zstr | pathlib.Path | Nonereturnboolr5T)rstr | pathlib.Path)rrr r!r=r-rvr7rrrrRrrrrprrrrrr r rSrrr"rrrr@r@sy$'<.`4#l(&Tc#J 3n;+z! &$*,<B<,\ 4(>> env = environment.Environment(forcePlatform='darwin') >>> env['musicxmlPath'] = '/Applications/Finale Reader.app' >>> env['musicxmlPath'] PosixPath('/Applications/Finale Reader.app') )rSrr modNameParentzt A string representation of the module that contains this Environment instance. zdict[str, str] _DOC_ATTRNcLXlU[S:wa[US9[S'gg)a Create an instance of this object, reading settings from disk. When created from a module, the `modName` parameter stores a string naming the module. This is used to identify the output of printDebug() calls. The `forcePlatform` argument can be used for testing what the environment settings would look like on another OS platform (e.g., win, nix, darwin). >>> myEnv = environment.Environment() >>> post = myEnv['writeFormat'] >>> #_DOCS_SHOW post >>> print("'musicxml'") #_DOCS_HIDE 'musicxml' rNrMrN)r%r!r@)r0modNamerNs rr-Environment.__init__Os-$% OO< <*:*WOJ ' =rc4[5RU5$r+)r"rvr0rss rrvEnvironment.__getitem__js~))#..rc([[55$r+)r8r"rys rr7Environment.__repr__msLN##rc6[5RX5 g)a Dictionary-like setting. Changes are made only to local dictionary. Must call write() to make permanent: >>> from pathlib import Path >>> a = environment.Environment() >>> a['debug'] = 1 >>> a['graphicsPath'] = '/test&Encode' >>> 'test&Encode' in str(a['graphicsPath']) True >>> isinstance(a['graphicsPath'], Path) True >>> a['autoDownload'] = 'asdf' Traceback (most recent call last): music21.environment.EnvironmentException: asdf is not an acceptable value for preference: autoDownload >>> a['showFormat'] = 'asdf' Traceback (most recent call last): music21.environment.EnvironmentException: asdf is not an acceptable value for preference: showFormat >>> a['showFormat'] = 'musicxml' >>> a['localCorpusPath'] = '/path/to/local' N)r"r)r0rsrts rrEnvironment.__setitem__ps8 ""3.rc([[55$r+)rir"rys rrEnvironment.__str__s<>""rcx[5R5nUR[S[ U5/5 U$)aZ Use the Python tempfile.gettempdir() to get the system specified temporary directory, and try to add a new 'music21' directory, and then return this directory. This method is only called if the no scratch directory preference has been set. If not able to create a 'music21' directory, the standard default is returned. Returns a pathlib.Path zusing temporary directory:)r"r printDebug_MODri)r0dstDirs rr!Environment.getDefaultRootTempDirs1557 ;S[IJ rc2[5R5$)a" Get the keys that refer to file paths. >>> a = environment.Environment() >>> for x in sorted(a.getKeysToPaths()): ... x ... 'braillePath' 'graphicsPath' 'lilypondPath' 'localCorpusPath' 'manualCoreCorpusPath' 'midiPath' 'musescoreDirectPNGPath' 'musicxmlPath' 'pdfPath' 'vectorPath' )r"rprys rrpEnvironment.getKeysToPathss(~,,..rc2[5R5$)aI Get the raw keys stored in the internal reference dictionary. These are different from the keys() method in that the 'localCorpusPath' entry is not included. >>> a = environment.Environment() >>> for x in sorted(a.getRefKeys()): ... x ... 'autoDownload' 'braillePath' 'debug' 'directoryScratch' 'graphicsPath' 'ipythonShowFormat' 'lilypondBackend' 'lilypondFormat' 'lilypondPath' 'lilypondVersion' 'localCorporaSettings' 'localCorpusSettings' 'manualCoreCorpusPath' 'midiPath' 'musescoreDirectPNGPath' 'musicxmlPath' 'pdfPath' 'showFormat' 'vectorPath' 'warnings' 'writeFormat' )r"rrys rrEnvironment.getRefKeyssB~((**rc2[5R5$)z Return a directory for writing temporary files. This does not create a new directory for each use, but either uses the user-set preference or gets the system-provided directory (with a music21 subdirectory, if possible). )r"rrys rrEnvironment.getRootTempDirs~,,..rc2[5R5$z9 Return the path to the platform specific settings file. )r"rrys rrEnvironment.getSettingsPaths~--//rcgr+rr0rr~s rrEnvironment.getTempFile rcgr+rrBs rrrCrDrcd[5RXS9nUR[SU/5 U$)z Return a file path to a temporary file with the specified suffix (file extension). v5 -- added returnPathlib. v6 -- returnPathlib defaults to True. )rr~ztemporary file:)r"rr4r5)r0rr~rs rrrCs2 >--V-Y 0(;<rc2[5R5$)a Return valid keys to get and set values for the Environment instance. >>> e = environment.Environment() >>> for x in sorted(list(e.keys())): ... x ... 'autoDownload' 'braillePath' 'debug' 'directoryScratch' 'graphicsPath' 'ipythonShowFormat' 'lilypondBackend' 'lilypondFormat' 'lilypondPath' 'lilypondVersion' 'localCorporaSettings' 'localCorpusPath' 'localCorpusSettings' 'manualCoreCorpusPath' 'midiPath' 'musescoreDirectPNGPath' 'musicxmlPath' 'pdfPath' 'showFormat' 'vectorPath' 'warnings' 'writeFormat' )r"rrys rrEnvironment.keyss>~""$$rc4[5RU5$r+)r"r r0rs rr Environment.formatToApp"~)))44rc4[5RU5$r+)r"r rJs rr Environment.formatToKey%rLrc"[5SU:a~[U[5(aU/nUSUR:wa URbURS-/U-n[R "U6n[ RRU5 gg)z Format one or more data elements into string, and print it to stderr. The first arg can be a list of strings or a string; lists are concatenated with common.formatStr(). r^rN:) r"rfrir%r formatStrsysstderrr)r0msg statusLevels rr4Environment.printDebug(s >' "k 1#s##e1v+++0B0B0N))C/036""C(C JJ  S ! 2rc0[5RUS9$)z Load an XML preference file if and only if the file is available and has been written in the past. This means that no preference file will ever be written unless manually done so. If no preference file exists, the method returns None. r)r"rSr0rs rrSEnvironment.read7s~""H"55rc4[5R5 g)aD Restore only defaults for all parameters. Useful for testing. >>> a = environment.Environment() >>> a['debug'] = 1 >>> a.restoreDefaults() >>> a['debug'] 0 And we can ``read()`` the environment settings back from our configuration file to restore our normal working environment. >>> a = environment.Environment().read() N)r"rrys rrEnvironment.restoreDefaults@s &&(rc[U[5(aU/nOk[U[5(a [U5/nOI[R "U5(a [U5/nO![U[ 5(a [U5/nUc4USUR:wa URbURS-/U-nOU/U-n[R"U6n[RRU5 g)zx To print a warning to the user, send a list of strings to this method. Similar to printDebug but even if debug is off. Nrz : WARNING:) rfridictr8risNum Exceptionr%rQrRrSr)r0rTheaders rwarnEnvironment.warnQs c3  %C T " "9+C \\#  s8*C Y ' 's8*C >1v+++0B0B0N))L89C?(S.C$ rc0[5RUS9$)z Write an XML preference file. This must be manually called to store any changes made to the object and access preferences later. If `filePath` is None, the default storage location will be used. rX)r"rrYs rrEnvironment.writegs ~##X#66rcUSn[R"5(aUSnU(dg[U5R5nSU;agSU;agSU;ag g ) a Returns an xmlReaderType depending on the 'musicxmlPath' >>> a = environment.Environment() >>> original = a['musicxmlPath'] #_DOCS_HIDE >>> a['musicxmlPath'] = '/Applications/Musescore.app' >>> a.xmlReaderType() 'Musescore' >>> a['musicxmlPath'] = '/Applications/Sibelius 7.app' >>> a.xmlReaderType() 'Sibelius' >>> a['musicxmlPath'] = r'C:\Program Files\Finale\Finale 2014.exe' >>> a.xmlReaderType() 'Finale' Nostalgia is unknown... >>> a['musicxmlPath'] = r'C:\Program Files\Deluxe Music Construction Set.exe' >>> a.xmlReaderType() 'unknown' >>> a['musicxmlPath'] = None >>> a.xmlReaderType() is None True >>> a['musicxmlPath'] = original #_DOCS_HIDE rJrINsibeliusSibeliusfinaleFinale musescore Musescoreunknown)rrunningInNotebookrirj)r0xps r xmlReaderTypeEnvironment.xmlReaderTypeos`8. !  # # % %./B W]]_   ^ B r)r%)NN)rrir~zt.Literal[False]rrir)rrir~zt.Literal[True]rz pathlib.Path)rrirrr+) rrr r!r= _DOC_ORDERr&__annotations__r-rvr7rrrrprrrrrrr r rrkr4rSrrbrrpr"rrrr$r$,s,6J !I~X6/$/<# $/,!+F/0      %B55+1*;*; "6)",7*rr$c`\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rSrSrg) UserSettingsiaz The UserSettings object provides a simple interface for configuring the user preferences in the :class:`~music21.environment.Environment` object. It automatically writes all changes to disk. First, create an instance of UserSettings: >>> us = environment.UserSettings() Second, view the available settings keys. >>> for key in sorted(us.keys()): ... key 'autoDownload' 'braillePath' 'debug' 'directoryScratch' 'graphicsPath' 'ipythonShowFormat' 'lilypondBackend' 'lilypondFormat' 'lilypondPath' 'lilypondVersion' 'localCorporaSettings' 'localCorpusPath' 'localCorpusSettings' 'manualCoreCorpusPath' 'midiPath' 'musescoreDirectPNGPath' 'musicxmlPath' 'pdfPath' 'showFormat' 'vectorPath' 'warnings' 'writeFormat' Third, after finding the desired setting, supply the new value as a Python dictionary key value pair. Setting this value updates the user's settings file. For example, to set the file path to the Application that will be used to open MusicXML files, use the 'musicxmlPath' key. >>> #_DOCS_SHOW us['musicxmlPath'] = '/Applications/Finale Reader.app' >>> #_DOCS_SHOW us['musicxmlPath'] '/Applications/Finale Reader.app' Note that the 'localCorpusPath' setting operates in a slightly different manner than other settings. Each time the 'localCorpusPath' setting is set, an additional local corpus file path is added to the list of local corpus paths (unless that path is already defined in the list of local corpus paths). To view all local corpus paths, access the 'localCorpusSettings' settings. This setting can also be used to set a complete list of file paths. >>> #_DOCS_SHOW us['localCorpusPath'] = '~/Documents' >>> #_DOCS_SHOW list(us['localCorpusSettings']) ['~/Documents'] Alternatively, the environment.py module provides convenience functions for setting these settings: :func:`~music21.environment.keys`, :func:`~music21.environment.get`, and :func:`~music21.environment.set`. c"[5Ulgr+)r$ _environmentrys rr-UserSettings.__init__s 'Mrc8URRU5$r+)rwrvr+s rrvUserSettings.__getitem__s  ,,S11rc,[UR5$z| Return a string representation. >>> us = environment.UserSettings() >>> post = repr(us) # location specific, cannot test )r8rwrys rr7UserSettings.__repr__sD%%&&rc,[UR5$r|)rirwrys rrUserSettings.__str__s4$$%%rcXRR5;ajUbf[U5RS5(dG[R "USS9n[ RRU5(d[SU35eOUS:Xa'[R"U5(d [S5eOUS:Xa[U[5(d [S 5eU(a_UR5HKup4[U[5(d [S 5e[R"U5(aMB[S 5e URRX5 URR5 g) a Dictionary-like setting. Changes are made and written to the user configuration file. >>> us = environment.UserSettings() >>> us['musicxmlPath'] = 'asdf/asdf/asdf' Traceback (most recent call last): music21.environment.UserSettingsException: attempting to set a value to a path that does not exist: ...asdf >>> us['localCorpusPath'] = '/path/to/local' Traceback (most recent call last): music21.environment.UserSettingsException: attempting to set a value to a path that does not exist: ...local Nz/skipFr}z9attempting to set a value to a path that does not exist: rYz/localCorpusSettings must be provided as a list.rz0localCorporaSettings must be provided as a dict.z2Each key in localCorporaSettings must be a string.z8Each entry in localCorporaSettings must point to a list.)rwrprirrrrr|rr% isListLikerfr^valuesrr)r0rsrtinnerKey innerValues rrUserSettings.__setitem__sQ* ##224 4 U)>)>w)G)G((eDww~~e,,/STYSZ[]]) )$$U+++EGG,* *eT**+FHH,1LLN(H%h443PRR!,,Z883VXX -; %%c1 !rcURR5R5(dURR5 g[ S5e)z` If an environment configuration file does not exist, create one based on the default settings. zNAn environment configuration file already exists; simply set values to modify.N)rwrrrr%rys rcreateUserSettings.create2sF   00299;;    # # %'/0 0rcURR5R5(a)URR5R5 g[ S5e)z1 Permanently remove the user configuration file. z1An environment configuration file does not exist.N)rwrrunlinkr%rys rrUserSettings.delete>sO    , , . 5 5 7 7    - - / 6 6 8'CE Erc6URR5$r?)rwrrys rrUserSettings.getSettingsPathHs  0022rc#\# URR5S/-ShvN gN7f)z Return the keys found in the user's :class:`~music21.environment.Environment` object. Changed in v9.3 -- yields a generator, like Python 3 dict -- rather than returning a list rFN)rwrrys rrUserSettings.keysNs(%%0026G5HHIIs ",*,c#J# UR5H nXU4v M g7f)zH dict-like interface to allow iterating over items of the UserSettings. N)r)r0ks rrUserSettings.itemsXs#A1g, s!#c#F# UR5H upUv M g7f)zI dict-like interface to allow iterating over values of the UserSettings. N)r)r0_vs rrUserSettings.values_sJJLDAG!s!clURR5 URR5 g)z% Restore platform specific defaults. N)rwrrrys rrUserSettings.restoreDefaultsfs( ))+ !r)rwN)rrr r!r=r-rvr7rrrrrrrrrr"rrrrurusG=B* 2'&0"j 0E3 J"rruc6[5nUR5$)z% Return all valid UserSettings keys. )rur)uss rrrss B 779rcb[5nUR5 XU'g![a Nf=f)ac Directly set a single UserSettings key, by providing a key and the appropriate value. This will create a user settings file if necessary. >>> environment.set('wer', 'asdf') Traceback (most recent call last): music21.environment.EnvironmentException: no preference: wer >>> #_DOCS_SHOW environment.set('musicxmlPath', '/Applications/Finale Reader.app') N)rurr%)rsrtrs rsetr}s6 B  sG !   s ! ..c[5nX$)z Return the current setting of a UserSettings key. This will create a user settings file if necessary: >>> #_DOCS_SHOW environment.get('musicxmlPath') '/Applications/Finale Reader.app' )ru)rsrs rrrs B 7Nrcz\rSrSrSSKrSr\R"\R"5S:HS5S5r \R"\R"5S:HS5S5r \R"\R"5S:HS5S 5r \R"\R"5S ;S 5S 5rS rg)TestirNc[UR55 [R"5nUR USSS9 UR 5R S5nU$)NrZT)r\xml_declaration)rrioBytesIOrgetvaluerh)r0rbiomatchs rstringFromTreeTest.stringFromTreesN%%'(jjl3$G %%g. rrztest assumes Unix-style pathsc[SS9n[5R5nURU5nSUlSU;aSnOSnSU-S-n[ R "URSS 5U5nUR[ R "XS5=(d U5 [/S Q5US '[/S Q5nS Ul SUl XqSS'[5R5nURU5nSU;aSnOSnSU-S-n[ R "URSS 5U5nUR[ R "XS5=(d U5 g)NrrMr\encoding='utf-8'r5 /System/Applications/Preview/Applications/Preview)abcrY)barbazfuzzyz/tmp/local.jsonfoora?> bar baz fuzzy /tmp/local.json a b c ) r$r"rrmaxDiffrwhitespaceEqualr[ assertTruer(r/r.)r0envrrenccanonictrue_but_for_preview_locationlcFoos rtestToSettingsTest.testToSettingssh1#~335 ##L1  $CC,s266)/(>(>w *,C@EFK)M% ..w>_B_`&9%I !"#$;</ -2 "#E*#~335 ##L1  $CC,s2%6%L)/(>(>w *,C@EFK)M% ..w>_B_`rc[SS9n[/SQ5SS.n[5RU5n[5R U[5R 5 UR [5R55nSU;aSnOSnS U-S -n[R"URS S 5U5nUR[R"Xd5=(d U5 g) NrrM)xyzw)rYrHr\rr5ra|?> x y z rr) r$r(r"rrrOrrrr[r)r0 unused_envrrrrrrs rtestFromSettingsTest.testFromSettings s!x8 $7#G  >//4 $$X%1^%8%8 :##LN$@$@$BC  $CC,s26>)/(>(>w *,C@EFK)M% ..w>_B_`rc[SS9nURUS5 SUS'UR[US5S/5 SUS'UR[US5SS/5 g)NrrMrFz/arYz/b)r$ assertIsNone assertEqualre)r0rs rtestEnvironmentATest.testEnvironmentAAsv1 #/01"&  c"789D6B!%  c"789D$<Hrrz.os.getuid can be called only on Unix platformscSSKn[5nUSnSnSnSnSUS'UR5nUR5URn[R "XAR 5 UR5nURS[R"53[U55 UbUb[R "XE5 X2S'UbmUR[R"55n[[R"U55S:HnU(dU(a[R"U5 gggg!UbUb[R "XE5 X2S'UbmUR[R"55n[[R"U55S:HnU(dU(a[R"U5 ffff=f)Nrrr)statr$rST_MODErchmodS_IREADassertInrrisamefilerrr listdirrmdir) r0re oldScratchDir oldTempDir oldPermission newTempDirtmpemptys rtestGetDefaultRootTempDirTest.testGetDefaultRootTempDirOs  M,-    ! )$(A !002J&OO-dll;M HHZ .002J MMOBIIK=93z? K%-*C3(5$%%!))(*=*=*?@BJJz23q8uHHZ( %s!& %-*C3(5$%%!))(*=*=*?@BJJz23q8uHHZ( %s!&s BD??BG)r)rrr r!rrunittestskipIfrrrrr skipUnlessrr"rrrrrs__V'')U24ST]aU]a~__V'')U24ST5aU5an__V'')U24ST IU I 118)) ))rr__main__)r))r= __future__rrrrqrRrrtypingtrxml.etree.ElementTreeetreerrxml.saxrrrrr5rMusic21Exceptionrr%rer(r@r!r"r$rurrrTestCaserrrrmainTestrrrrs #  "" , <88  0 6F$6FxJ <J