def getPaths(self):
     documentationDirectoryPath = os.path.join(common.getSourceFilePath(), 'documentation')
     self.documentationDirectoryPath = documentationDirectoryPath
     self.autogenDirectoryPath = os.path.join(
         documentationDirectoryPath,
         'autogenerated',
         )
     self.buildDirectoryPath = os.path.join(
         documentationDirectoryPath,
         'build',
         )
     self.doctreesDirectoryPath = os.path.join(
         self.buildDirectoryPath,
         'doctrees',
         )
     self.buildDirectories = {
         'html': os.path.join(
             self.buildDirectoryPath,
             'html',
             ),
         'latex': os.path.join(
             self.buildDirectoryPath,
             'latex',
             ),
         # could reuse latex, but too much rewriting
         'latexpdf': os.path.join(
             self.buildDirectoryPath,
             'latex',
             ),
     }

 def testPaert(self):
     import os
     nwcTranslatePath = common.getSourceFilePath() + os.path.sep + 'noteworthy'
     paertPath = nwcTranslatePath + os.path.sep + 'NWCTEXT_Really_complete_example_file.nwctxt' #'Part_OWeisheit.nwctxt' #
     #paertPath = r'D:\docs\research\music21\elvis\Wegman Masses\01\Caput\01 Kyrie.nwctxt'
     myScore = NoteworthyTranslator().parseFile(paertPath)
     myScore.show()

def testMIDIParse():
    from music21 import converter, common
    from music21 import freezeThaw

    #a = 'https://github.com/ELVIS-Project/vis/raw/master/test_corpus/prolationum-sanctus.midi'
    #c = converter.parse(a)
#     c = corpus.parse('bwv66.6', forceSource=True)
#     v = freezeThaw.StreamFreezer(c)
#     v.setupSerializationScaffold()
#     return v.writeStr() # returns a string
    import os
    a = os.path.join(common.getSourceFilePath(),
                     'midi',
                     'testPrimitive',
                     'test03.mid')

    #a = 'https://github.com/ELVIS-Project/vis/raw/master/test_corpus/prolationum-sanctus.midi'
    c = converter.parse(a)
    v = freezeThaw.StreamFreezer(c)
    v.setupSerializationScaffold()


    mockType = lambda x: x.__class__.__name__ == 'weakref'
    ty = TreeYielder(mockType)
    for val in ty.run(c):
        print(val, ty.currentLevel())

 def testComplete(self):
     ci = CapellaImporter()
     #ci.readCapellaXMLFile(r'd:/desktop/achsorgd.capx')
     capellaDirPath = common.getSourceFilePath() / 'capella'
     oswaldPath = capellaDirPath / r'Nu_rue_mit_sorgen.capx'
     partScore = ci.scoreFromFile(oswaldPath)
     partScore.show()

    def testComplete(self):
        nwcTranslatePath = common.getSourceFilePath() / 'noteworthy'
        complete = nwcTranslatePath / 'NWCTEXT_Really_complete_example_file.nwctxt'
        #'Part_OWeisheit.nwctxt' #

        myScore = NoteworthyTranslator().parseFile(complete)
        myScore.show()

 def __init__(self):
     self.outputDirectory = None
     self.docBasePath = os.path.join(common.getSourceFilePath(), 'documentation')
     self.docSourcePath = os.path.join(self.docBasePath,
                                       'source')
     self.docGeneratedPath = os.path.join(self.docBasePath,
                                       'autogenerated')

    def readExcerpts(self):
        for languageCode in self.languageCodes:
            thisExcerpt = (common.getSourceFilePath() / 'languageExcerpts'
                            / (languageCode + '.txt'))

            with thisExcerpt.open(encoding='utf-8') as f:
                excerptWords = f.read().split()
                self.trigrams[languageCode] = Trigram(excerptWords)

 def readExcerpts(self):
     for languageCode in self.languageCodes:
         thisExcerpt = os.path.join(common.getSourceFilePath(),
                                    'languageExcerpts',
                                    languageCode + '.txt')
         f = open(thisExcerpt)                
         self.trigrams[languageCode] = Trigram(f.read().split())
         f.close()

 def testTransposingInstruments(self):
     import os
     from music21 import converter, common
     fpDir = os.path.join(common.getSourceFilePath(), 'musedata', 'testPrimitive', 'test01')
     s = converter.parse(fpDir)
     p = s.parts['Clarinet in A']
     self.assertEqual(str(p.getElementsByClass('Measure')[0].keySignature), '<music21.key.KeySignature of 3 sharps>')
     self.assertEqual(str(p.flat.notesAndRests[0]), '<music21.note.Note A>')

def allFiles():
    thisDir = common.getSourceFilePath() / 'musicxml' / 'lilypondTestSuite'
    allOut = []
    for f in thisDir.iterdir():
        if f.name.startswith('__'):
            continue
        allOut.append(f)
    return allOut

def getDirBuildHtml():
    '''Return the html directory
    '''
    from music21 import common
    cwdir = common.getSourceFilePath()
    parentDir = os.path.dirname(cwdir)
    dirBuild = os.path.join(parentDir, 'music21', 'documentation', 'build')
    dirBuildHtml = os.path.join(dirBuild, 'html')
    return dirBuildHtml

 def testComplete(self):
     ci = CapellaImporter()
     #ci.readCapellaXMLFile(r'd:/desktop/achsorgd.capx')
     import os
     from music21 import common
     capellaDirPath = common.getSourceFilePath() + os.path.sep + 'capella'
     oswaldPath = capellaDirPath + os.path.sep + r'Nu_rue_mit_sorgen.capx'
     partScore = ci.scoreFromFile(oswaldPath)
     partScore.show()

 def readExcerpts(self):
     for languageCode in self.languageCodes:
         thisExcerpt = os.path.join(common.getSourceFilePath(),
                                    'languageExcerpts',
                                    languageCode + '.txt')
         
         with open(thisExcerpt) as f:
             excerptWords = f.read().split()
             self.trigrams[languageCode] = Trigram(excerptWords)

 def testBasic(self):
     import os
     from music21 import common
     nwcTranslatePath = common.getSourceFilePath() + os.path.sep + 'noteworthy'
     simplePath = nwcTranslatePath + os.path.sep + 'verySimple.nwctxt'#'NWCTEXT_Really_complete_example_file.nwctxt' # ## #'Part_OWeisheit.nwctxt' #
     myScore = NoteworthyTranslator().parseFile(simplePath)
     self.assertEqual(len(myScore.flat.notes), 1)
     self.assertEqual(str(myScore.flat.notes[0].name), "E")
     self.assertEqual(str(myScore.flat.getElementsByClass('Clef')[0]), "<music21.clef.BassClef>")

def getDirBuildHtml():
    """Return the html directory
    """
    from music21 import common

    cwdir = common.getSourceFilePath()
    parentDir = os.path.dirname(cwdir)
    dirBuild = os.path.join(parentDir, "music21", "documentation", "build")
    dirBuildHtml = os.path.join(dirBuild, "html")
    return dirBuildHtml

def allFiles():
    thisDir = os.sep.join([common.getSourceFilePath(),
                           'musicxml',
                           'lilypondTestSuite'])
    allOut = []
    for f in os.listdir(thisDir):
        if f.startswith('__'):
            continue
        allOut.append(thisDir + os.sep + f)
    return allOut

 def testBackBasic(self):
     from music21 import converter, common
     fpDir = common.getSourceFilePath() / 'musedata' / 'testPrimitive' / 'test01'
     s = converter.parse(fpDir)
     # note: this is a multi-staff work, but presently gets encoded
     # as multiple voices
     measures = s.parts[0].measures(1, 5)
     self.assertEqual(len(measures[0].flat.notesAndRests), 2)
     self.assertEqual(len(measures[1].flat.notesAndRests), 5)
     self.assertEqual(len(measures[2].flat.notesAndRests), 5)
     self.assertEqual(len(measures[3].flat.notesAndRests), 6)
     self.assertEqual(len(measures[4].flat.notesAndRests), 4)

    def testPickleMidi(self):
        from music21 import converter
        a = str(common.getSourceFilePath()
                         / 'midi'
                         / 'testPrimitive'
                         / 'test03.mid')

        #a = 'https://github.com/ELVIS-Project/vis/raw/master/test_corpus/prolationum-sanctus.midi'
        c = converter.parse(a)
        f = converter.freezeStr(c)
        d = converter.thawStr(f)
        self.assertEqual(d[1][20].volume._client.__class__.__name__, 'weakref')

 def getPaths(self):
     documentationDirectoryPath = os.path.join(common.getSourceFilePath(), "documentation")
     self.documentationDirectoryPath = documentationDirectoryPath
     self.autogenDirectoryPath = os.path.join(documentationDirectoryPath, "autogenerated")
     self.buildDirectoryPath = os.path.join(documentationDirectoryPath, "build")
     self.doctreesDirectoryPath = os.path.join(self.buildDirectoryPath, "doctrees")
     self.buildDirectories = {
         "html": os.path.join(self.buildDirectoryPath, "html"),
         "latex": os.path.join(self.buildDirectoryPath, "latex"),
         # could reuse latex, but too much rewriting
         "latexpdf": os.path.join(self.buildDirectoryPath, "latex"),
     }

 def __iter__(self):
     rootFilesystemPath = common.getSourceFilePath()
     for directoryPath, directoryNames, fileNames in os.walk(
         rootFilesystemPath):
         directoryNamesToRemove = []
         for directoryName in directoryNames:
             if directoryName in self._ignoredDirectoryNames:
                 directoryNamesToRemove.append(directoryName)
         for directoryName in directoryNamesToRemove:
             directoryNames.remove(directoryName)
         if '__init__.py' in fileNames:
             strippedPath = directoryPath.partition(rootFilesystemPath)[2]
             pathParts = [x for x in strippedPath.split(os.path.sep) if x]
             pathParts.insert(0, 'music21')
             packagesystemPath = '.'.join(pathParts)
             try:
                 module = __import__(packagesystemPath, fromlist=['*'])
                 if getattr(module, '_DOC_IGNORE_MODULE_OR_PACKAGE', False):
                     # Skip examining any other file or directory below
                     # this directory.
                     if self.verbose:
                         print('\tIGNORED {0}/*'.format(
                             common.relativepath(directoryPath)))
                     directoryNames[:] = []
                     continue
             except ImportError:
                 pass
         for fileName in fileNames:
             if fileName in self._ignoredFileNames:
                 continue
             if not fileName.endswith('.py'):
                 continue
             if fileName.startswith('_') and not fileName.startswith('__'):
                 continue
             filePath = os.path.join(directoryPath, fileName)
             strippedPath = filePath.partition(rootFilesystemPath)[2]
             pathParts = [x for x in os.path.splitext(
                 strippedPath)[0].split(os.path.sep)[1:] if x]
             pathParts = ['music21'] + pathParts
             packagesystemPath = '.'.join(pathParts)
             try:
                 module = __import__(packagesystemPath, fromlist=['*'])
                 if getattr(module, '_DOC_IGNORE_MODULE_OR_PACKAGE',
                     False):
                     if self.verbose:
                         print('\tIGNORED {0}'.format(
                             common.relativepath(filePath)))
                     continue
                 yield module
             except ImportError:
                 pass
     raise StopIteration