jdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m cmZddlmZddlmZddlmZdZdd ZGd d ejZGd deZGddeZGddZeddZdZGddZGddZ dZ!dZ"dZ#Gddej$Z%e eegZ&e'dkrddlZej(e%dSdS) 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 environmentcd||zdzz}t|r|jr|js ||dzz|_|jr|js||_|D]}t ||dz|jr|js ||_dSdS|r)|jr|js ||_dSdSdS)z4 indent an elementTree element for printing   N)lentextstriptailetIndent)elemlevelspacesisubEls /Users/tedpeters/Documents/Projects/Claude Projects/Misc Tools/notename-sheets/.venv/lib/python3.11/site-packages/music21/environment.pyrr-s uv~##A 4yy y )  1 1 )FSL(DIy   1 1 DI ' 'E UEAI & & & &y   1 1 DIII    $) 49??+<+< DIII    ceZdZdS)EnvironmentExceptionN__name__ __module__ __qualname__rrrrCDrrceZdZdS)UserSettingsExceptionNrr rrr#r#Gr!rr#c.eZdZdZdfd ZfdZxZS)LocalCorpusSettingsaN 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 Ncn|g}t|||_||_dSN)super__init__name cacheFilePath)selfpathsr*r+ __class__s rr)zLocalCorpusSettings.__init__ss: =E  *rct}d}d}|jdt|jz}|jdt|jz}d|||dS)Nz, name=z, cacheFilePath=zLocalCorpusSettings())r(__repr__r*reprr+)r,listReprnamePartmdbpPartr.s rr2zLocalCorpusSettings.__repr__zsu77##%% 9  4 ??2H   ))D1C,D,DDHEhEE(EEEEr)NNN)rrr__doc__r)r2 __classcell__)r.s@rr%r%Msj##J++++++FFFFFFFFFrr%ceZdZdZddZdZdZdZdZddZ dd Z d dZ ddZ dZ dZdZdZdZd!d"dZdZdZdZddZdZddZdS)#_EnvironmentCorea 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. Nci|_g|_dD]}|j|||||d|_dS)N) braillePath graphicsPath lilypondPathlocalCorpusPathmanualCoreCorpusPathmidiPathmusescoreDirectPNGPath musicxmlPathpdfPath vectorPath forcePlatform)_ref _keysToPathsappend _loadDefaultsreaddefaultRootTempDir)r,rGpathKeys rr)z_EnvironmentCore.__init__s|   . .G   $ $W - - - - 777  IIKKK"&rc||jvr|dkrtd||dkr|j|}n8t|jd}t|dkr |d}nd}t |t r|dd}t|}|d kry|d kr tj }nf|d kr tj }nSd |vr tj }nBd |vr tj }n1d|vr tj }n d|vr tj }nt|}|1|dkr+||vrt!j|}nd}|S)Nr?no preference: localCorpusSettingsrr0utf-8replace)encodingerrorsdebugtruefalseoffuserdevelall)rHrlistr isinstancebytesdecodestrlowerr DEBUG_USER DEBUG_OFF DEBUG_DEVEL DEBUG_ALLintgetKeysToPathspathlibPath)r,keyvaluer-valueStrs r __getitem__z_EnvironmentCore.__getitem__s di  C+<$<$<&'>'>'>?? ? # # #IcNEE#89::E5zzA~~a eU # # ELL')LDDEu::##%% '>>6!!)W$$((""(8##)H$$*(""(E   "d))++++ U++E rcdS)Nz r r,s rr2z_EnvironmentCore.__repr__src2d|vr|tj|d}||jvr|dkrt d||dkrd}d}|dkr%|}|tjvrd}nv|d kr%|}|tjvrd}nK|d kr%|}|tjvrd}n |d krt|trd}nd}|st |d |t|trtj |}|dkrMt||jd vr/|jd  t|dSdS||j|<dS) NpathF returnPathlibr?rPr0 showFormatT writeFormat autoDownloadrQz, is not an acceptable value for preference: )rbr cleanpathrHrVALID_SHOW_FORMATSVALID_WRITE_FORMATSVALID_AUTO_DOWNLOADr^r%rarescaperJ)r,rkrlvalids r __setitem__z_EnvironmentCore.__setitem__s SYY[[ U%6$U%@@@E di  '''*+BS+B+BCCC B;;E ,  KKMME111 M ! !KKMME222 N " "KKMME222 ) ) )%!455 E M&KKcKKMM M eS ! ! +OE**E # # #5zz+@!AAA /077E CCCCCBA#DIcNNNrc*t|jSr')r3rHrps r__str__z_EnvironmentCore.__str__"sDIrc$|i}|}|D]s}|jdkr|t}|D]e}|jdkr/|j}||<|jdkr|j|_f||d<|jdkri|d<|D]}|d} t}| |_|D]e}|jdkr/|j}||<|jdkr|j|_f||d| <>|d} |d} | |vrn| || <udS)z Takes in a ElementTree and possibly an already populated reference dictionary (or creates a new one) and populates it. NrQr?r+localCorporaSettingsr*rl) getroottagr%rrrJr+getr*) r, settingsTreerefsettingsslotlcs slotChild fpCandidaterQr*rls r _fromSettingsz_EnvironmentCore._fromSettings&s ;C'')) & &Dx000)++!%CCI }(999&/n&:&:&<&<  ;////"/99,5N,@,@,B,B)-0)**333.0*++/ < <'.226::D-//C#CH%8GG $=,===*3.*>*>*@*@KJJ{3333&]o==090D0D0F0FC-8;C./55 <xx''))s??!&CIIA & &rcXd|jd<d|jd<d|jd<d|jd<d|jd<d|jd <d|jd <d|jd <d|jd <d|jd <d|jd<d|jd<d|jd<d|jd<d|jd<d|jd<d|jd<d|jd<t|jd<i|jd<d|jd<|tj}n|}|dkr:dd tjd fdtjd ffD] \}}|||< dS|d!krd"D] \}}|||< dS|d#krVtj}|dd$ks|dd%kr|dd&krd'}nd(}d)d*d |fd |fd |fd+d,fD] \}}|||< dSdS)-zS Load defaults. All keys are derived from these defaults. NdirectoryScratchr>lilypondVersionpdflilypondFormatpslilypondBackendrCrAr=rErDr<rBmusicxmlrurvzipython.musicxml.pngipythonShowFormataskrwrrVr warningsrQrr@win)r>lilypondz-%PROGRAMFILES%\MuseScore 3\bin\MuseScore3.exenix))r>z/usr/bin/lilypond)rC/usr/bin/mscore3)rBr)r=/usr/bin/xdg-open)rDrdarwin z /System/Applications/Preview.appz/Applications/Preview.app)r>z:/Applications/Lilypond.app/Contents/Resources/bin/lilypond)rC3/Applications/MuseScore 3.app/Contents/MacOS/mscore)rAz/Applications/GarageBand.app)rBr)rHr%r getPlatformrx macOSVersion)r,rGplatformr*rl versionTuplepreviewLocations rrKz_EnvironmentCore._loadDefaultsPs)- $%%) .!(, #$&+ "#'+ #$%) .!!% *%) .!#' , $ )$( - /3 *+", ,#- - )? %&$) .! '!" *,?+@+@ '(,. (),0 ()  )++HH$H u  ,!"RSS*!"RSS   # # e#T  # #    # # e#T  # # ! !!.00LA"$$aB)>)>" and return that object NrTrRrrQr?r+r)r*r*rl preference) rHETElement ElementTreesorteditemsrarrJr+)r,r settingsDictrrrkrlrrQfilePathr?mdbprr*attribsrs r toSettingsXMLz_EnvironmentCore.toSettingsXMLs ;)C"G, :j,77~h//  --& && &JCC+++&(j1F&G&G# &s @@H&(j1B&C&CO+/28}},'..????$0:o66D #C$5 6 6DI'..t444 34444...')z2H'I'I$!' !6!6 E EID#*,*5JQU*V*V*V'$*3KKDD*,*5F*G*G#/36x==O0+22?CCCC(4!z/::$'(9$:$: +224888(//0CDDDD 45555"3-$'*5zzGG$z,88%%%%rc"||jr|jStjt jdz |_||jr|jS |jn#t$rtj dvr?tj }tjt jd|z }n'tjt j d}||r||_nW |||_n:#t$r-tjt j|_YnwxYwYnwxYw|jS)ak 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) rrMrirjtempfile gettempdirmkdirOSErrorrrrgetuidmkdtemp)r,uiddir_paths rgetDefaultRootTempDirz&_EnvironmentCore.getDefaultRootTempDirs:  # #D$; < < +* *#*,x/B/D/D"E"E "Q  # #D$; < < +* * V'--//// V V V%''+<<<)++C&|H,?,A,ABBE\WZE\E\\HH&|H,FFFFc|jS)a Find all keys that refer to paths >>> e = environment.Environment() >>> for i in e.getKeysToPaths(): ... #_DOCS_SHOW print(i) ... pass #_DOCS_HIDE braillePath graphicsPath lilypondPath ... )rIrps rrhz_EnvironmentCore.getKeysToPaths5s   rcNt|jS)a) 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 ... r]rHkeysrps r getRefKeysz_EnvironmentCore.getRefKeysEs DINN$$%%%rc|jd|Stj|jd}|st d|d|S)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 rNz"user-specified scratch directory (z=) does not exist; remove preference file or reset Environment)rHrrirjrr)r,refDirs rgetRootTempDirz_EnvironmentCore.getRootTempDirWs| 9' ( 0--// /di(:;<<}} &?V???  rctj}dtjvr(t jtjddz }nd}|dkrndtjvr%t jtjd}n6|r|}n1t jtjd}|dz S|dvr{d tjvrTtjtjd tj r%t jtjd }nt jd }|d z SdS) zI Return a pathlib.Path object to the '.music21rc' object USERPROFILEzApplication DataNrAPPDATA~zmusic21-settings.xmlrHOMEz/tmp/z .music21rc) rrrenvironrirjrr expanduserrr)r,ruserProfilePath directorys rgetSettingsPathz _EnvironmentCore.getSettingsPathls%'' BJ & &%l2:m+DEEHZZOO"O u  BJ&&#LI)>??   B+ #L););C)@)@AA 55 5 * * *## "*V2Dbg(N(N##LF);<< #L11 |+ + + *rr0Tstr | pathlib.Pathc|}|r|dsd|z}tj||d5}|j}dddn #1swxYwY|rt j|S|S)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*rirj)r,rrtrootDirntfntf_names r getTempFilez_EnvironmentCore.getTempFiles*%%''  "&++C00 "6\F  (WVE R R R VYxH                 <)) )OsAA #A cVt|jdgzS)Nr?rrps rrz_EnvironmentCore.keyss%DINN$$%%):(;;;rc~d}|dkrd}n1|dvrd}n*|dkrd}n!|dkrd }n|d vrd }n|d krd }n|dkrd}|S)aM 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 Nrr>)pngjpegr=svgrErrD)rrCmidirAbrailler<r r, m21FormatenvironmentKeys r formatToKeyz_EnvironmentCore.formatToKeys:  " "+NN / ) )+NN %  )NN %  &NN - ' '+NN & 'NN ) # #*Nrc||}|(||jvrt|dz|j|SdS)zE Given a format, return the app that will launch it. Nz is not set in UserSettings. )rrHrrs r formatToAppz_EnvironmentCore.formatToAppsP)))44  %TY..*><[+[\\\9^, ,trc N||}|sdS tjt |}n:#tj$r(}t d|dt ||d}~wwxYw|||jdS)z Read the environment file from .music21rc and call _fromSettings Called only once per music21 instance. NzCannot parse file z: ) rrrparsera ParseErrorrrrH)r,rrpes rrLz_EnvironmentCore.reads  ++--H   4 8CMM22LL}   &:X::R::   <33333s!AB#BBc<i|_|dS)zC Changes everything to default but does not write. N)rHrKrps rrestoreDefaultsz _EnvironmentCore.restoreDefaultss#  rc>||}||jstd||}t ||t|ddS)zU Write the .music21rc using `.getSettingsPath` and `.toSettingsXML`. Nzbad file path for .music21rc: rR)rT) rparentrrrrrwritera)r,rrs rrz_EnvironmentCore.writes  ++--H  8?#9#9#;#; &'R'R'RSS S))++ %%''((( 3x==7;;;;;rr')rrrrrr0T)rr)rrrr7r)rnr2r~rrrKrrrrhrrrrrrrrLrrr rrr:r:s$''''<...`4#4#4#l(&(&(&(&Tc#c#c#c#J    3333n;+;+;+z!!! &&&$*,,,<B<<<,,,\   4444(<<<<<>> env = environment.Environment(forcePlatform='darwin') >>> env['musicxmlPath'] = '/Applications/Finale Reader.app' >>> env['musicxmlPath'] PosixPath('/Applications/Finale Reader.app') )rLrr modNameParentzt A string representation of the module that contains this Environment instance. zdict[str, str] _DOC_ATTRNcj||_|tdkrt|td<dSdS)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' rGrFrN)r rr:)r,modNamerGs rr)zEnvironment.__init__MsA$% OO< < <*:*W*W*WOJ ' ' ' = >> 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)rr~)r,rkrls rr~zEnvironment.__setitem__ns$8 ""3.....rc8ttSr')rarrps rrzEnvironment.__str__s<>>"""rct}|tdt |g|S)a 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:)rr printDebug_MODra)r,dstDirs rrz!Environment.getDefaultRootTempDirs>5577 ;S[[IJJJ rcBtS)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' )rrhrps rrhzEnvironment.getKeysToPathss(~~,,...rcBtS)a1 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' )rrrps rrzEnvironment.getRefKeyssB~~((***rcBtS)a 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). )rrrps rrzEnvironment.getRootTempDirs~~,,...rcBtSzI Return the path to the platform specific settings file. )rrrps rrzEnvironment.getSettingsPaths~~--///rrrartt.Literal[False]rcdSr'r r,rrts rrzEnvironment.getTempFile rr0Tt.Literal[True] pathlib.PathcdSr'r rs rrzEnvironment.getTempFilerrrct||}|td|g|S)z Return a file path to a temporary file with the specified suffix (file extension). v5 -- added returnPathlib. v6 -- returnPathlib defaults to True. )rrtztemporary file:)rrrr)r,rrtrs rrzEnvironment.getTempFiles? >>--V=-YY 0(;<<<rcBtS)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' )rrrps rrzEnvironment.keyss>~~""$$$rcDt|Sr')rrr,rs rrzEnvironment.formatToApp ~~)))444rcDt|Sr')rrr%s rrzEnvironment.formatToKey#r&rctd|krmt|tr|g}|d|jkr|j|jdzg|z}t j|}t j|dSdS)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(). rVrN:) rr^rar r formatStrsysstderrr)r,msg statusLevels rrzEnvironment.printDebug&s >>' "k 1 1#s## e1v+++0B0N)C/036"C(C J  S ! ! ! ! ! 2 1rcFt|S)a 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)rrLr,rs rrLzEnvironment.read5s~~""H"555rcFtdS)a 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)rrrps rrzEnvironment.restoreDefaults>s  &&(((((rct|tr|g}npt|trt|g}nJt j|rt|g}n%t|t rt|g}|'|d|jkr|j|jdzg|z}n|g|z}t j|}tj |dS)z 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:) r^radictr3risNum Exceptionr r*r+r,r)r,r-headers rwarnzEnvironment.warnOs c3   %CC T " " 99+CC \#   s88*CC Y ' ' s88*C >1v+++0B0N)L89C?(S.C$ rcFt|S)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. r0)rrr1s rrzEnvironment.writees ~~##X#666rc|d}tjr|d}|sdSt|}d|vrdSd|vrdSd|vrd Sd S) 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 rCrBNsibeliusSibeliusfinaleFinale musescore Musescoreunknown)rrunningInNotebookrarb)r,xps r xmlReaderTypezEnvironment.xmlReaderTypems}8. !  # % % 0./B 4 WW]]__   : ^^8 B  ;9r)NN)rrartrrrar)rrartrrr )rrarrr')rrrr7 _DOC_ORDERr __annotations__r)rnr2r~rrrhrrrrrrrrrrcrrLrr8rrDr rrrr*s,655J !IXXXX6///$$$///<### $///,!+!+!+F///000    X     X      %%%B555555+1*; " " " "6666)))",7777*****rrcZeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdS) UserSettingsaF 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,t|_dSr')r _environmentrps rr)zUserSettings.__init__s'MMrc6|j|Sr')rJrnrs rrnzUserSettings.__getitem__s ,,S111rc*t|jSz Return a string representation. >>> us = environment.UserSettings() >>> post = repr(us) # location specific, cannot test )r3rJrps rr2zUserSettings.__repr__sD%&&&rc*t|jSrM)rarJrps rrzUserSettings.__str__s4$%%%rc||jvrl|it|dsGt j|d}t j|std|n|dkr$t j |stdn|dkrt|tstd |ra| D]L\}}t|tstd t j |std M|j|||jdS) 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/skipFrsz9attempting to set a value to a path that does not exist: rQz/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.)rJrhrarrrxrrrrr# isListLiker^r4valuesr~r)r,rkrlinnerKey innerValues rr~zUserSettings.__setitem__s* $#2244 4 4 U)>)>w)G)G (eDDDw~~e,,]/[TY[[]]]) ) )$U++ G+EGGG G* * *eT** H+FHHH X,1LLNNXX(Hj%h44R3PRRR!,Z88X3VXXXX %%c5111 !!!!!rc|js|jdSt d)zx 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)rJrrrr#rps rcreatezUserSettings.create0sY  002299;; 0   # # % % % % %'/00 0rc|jr-|jdSt d)zA Permanently remove the user configuration file. z1An environment configuration file does not exist.N)rJrrunlinkr#rps rrzUserSettings.delete<sg   , , . . 5 5 7 7 E   - - / / 6 6 8 8 8 8 8'CEE Erc4|jSr)rJrrps rrzUserSettings.getSettingsPathFs 00222rc#PK|jdgzEd{VdS)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 r?N)rJrrps rrzUserSettings.keysLs>%00226G5HHIIIIIIIIIrc#PK|D]}|||fVdS)zX dict-like interface to allow iterating over items of the UserSettings. N)r)r,ks rrzUserSettings.itemsVs@  Ad1g,      rc#FK|D] \}}|V dS)zY dict-like interface to allow iterating over values of the UserSettings. N)r)r,_vs rrQzUserSettings.values]s8JJLL  DAqGGGG  rcj|j|jdS)z5 Restore platform specific defaults. N)rJrrrps rrzUserSettings.restoreDefaultsds4 ))+++ !!!!!rN)rrrr7r)rnr2rr~rUrrrrrQrr rrrHrHs==B*** 222'''&&&0"0"0"j 0 0 0EEE333 JJJ"""""rrHcFt}|S)z- Return all valid UserSettings keys. )rHr)uss rrrqs B 7799rcxt} |n#t$rYnwxYw|||<dS)a 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)rHrUr#)rkrlras rsetrc{sN B       BsGGGs % 22c.t}||S)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' )rH)rkras rrrs B c7NrcpeZdZddlZdZejejdkddZ ejejdkddZ ejejdkddZ ej ejd vd d Z dS) TestrNct|tj}||dd|d}|S)NrRT)rTxml_declaration)rrioBytesIOrgetvaluer`)r,rbiomatchs rstringFromTreezTest.stringFromTreesb%%''(((jll3$GGG %%g.. rrztest assumes Unix-style pathsctd}t}||}d|_d|vrd}nd}d|zdz}t j|dd |}|t j||p|tgd |d <tgd }d |_ d|_ ||dd<t}||}d|vrd}nd}d|zdz}t j|dd |}|t j||p|dS)NrrFrTencoding='utf-8'r0 /System/Applications/Preview/Applications/Preview)abcrQ)barbazfuzzyz/tmp/local.jsonfoora?> bar baz fuzzy /tmp/local.json a b c ) rrrrnmaxDiffrwhitespaceEqualrS assertTruer%r+r*)r,envrrmenccanonictrue_but_for_preview_locationlcFoos rtestToSettingszTest.testToSettingss111#~~3355 ##L11   $CCC,s266)/(>w *,C@E@EFK)M)M% .w>>_B_```&9%I%I !"#$;$;$;<</ -2 "#E*#~~3355 ##L11   $CCC,s2%6%L)/(>w *,C@E@EFK)M)M% .w>>_B_`````rc$td}tgddd}t|}t|tj|t}d|vrd}nd}d |zd z}tj| d d |}| tj||p|dS) NrrF)xyzw)rQrArTrpr0rqa|?> x y z rrrs) rr%rrrrHrnrr|rSr})r, unused_envrrrmrrrs rtestFromSettingszTest.testFromSettingss&!x888 $7#G#G   >>//44 $$X%1^^%8 : : :##LNN$@$@$B$BCC   $CCC,s26>)/(>w *,C@E@EFK)M)M% .w>>_B_`````rctd}||dd|d<|t|ddgd|d<|t|dddgdS)NrrFr?z/arQz/b)r assertIsNone assertEqualr])r,r~s rtestEnvironmentAzTest.testEnvironmentA?s111 #/0111"&  c"7899D6BBB!%  c"7899D$<HHHHHrrz.os.getuid can be called only on Unix platformscddl}t}|d}d}d}d} d|d<|}||j}t j||j|}|dt jt|||t j||||d<|e| tj }tt j|dk}|s|rt j|dSdSdSdS#||t j||||d<|d| tj }tt j|dk}|s|rt j|wwwwxYw)Nrrr)statrrST_MODErchmodS_IREADassertInrrasamefilerrrlistdirrmdir) r,re oldScratchDir oldTempDir oldPermission newTempDirtmpemptys rtestGetDefaultRootTempDirzTest.testGetDefaultRootTempDirMs  MM,-    ! )$(A !0022J&OO--dl;M HZ . . .0022J MM9BIKK993z?? K K K%-*C]333(5$%%!))(*=*?*?@@BJz2233q8)u)HZ(((((#&% ))))-%-*C]333(5$%%!))(*=*?*?@@BJz2233q8)u)HZ((((#& ))s BE BG)rrrrrnunittestskipIfrrrrr skipUnlessrr rrrfrfs5KKKX_'V'))U24STT]a]aUT]a~X_'V'))U24STT5a5aUT5anX_'V'))U24STT I IUT IX 118)))) ))))))rrf__main__)rr ))r7 __future__rrirrir+rrtypingtrxml.etree.ElementTreeetreerrxml.saxrrrrrrMusic21Exceptionrr#r]r%r:rrrrHrrcrTestCaserfrErmainTestr rrrs  #"""""  """"""""" ,     <8        0   5F5F5F5F5F$5F5F5FvJ <J <J <J <J <J <J <J