Python 實例分析 - 獲取MP3歌曲的Tag信息

原文由我發佈在：http://yhzhtk.info/2013/06/12/1-python-class-demo-learn-note.html

下面利用一個python的實例程序，來學習python。這個程序的目的就是分析出全部MP3文件的Tag信息並輸出。

其中遇到一個問題，讓我深切感覺到python中依靠縮進來控制流程的缺點，很少說，看程序：

"""Framework for getting filetype-specific metadata. Instantiate
appropriate class with filename. Returned object acts like a
dictionary, with key-value pairs for each piece of metadata. import
fileinfo info = fileinfo.MP3FileInfo("/music/ap/mahadeva.mp3") print
"\\n".join(["%s=%s" % (k, v) for k, v in info.items()]) Or use
listDirectory function to get info on all files in a directory. for
info in fileinfo.listDirectory("/music/ap/", [".mp3"]): ... Framework
can be extended by adding classes for particular file types, e.g.
HTMLFileInfo, MPGFileInfo, DOCFileInfo. Each class is completely
responsible for parsing its files appropriately; see MP3FileInfo for
example. """
import os
import sys
from UserDict import UserDict

def stripnulls(data):
    "strip whitespace and nulls"
    return data.replace("\00", "").strip()

class FileInfo(UserDict):
    "store file metadata"
    def __init__(self, filename=None):
        UserDict.__init__(self)
        self["name"] = filename

class MP3FileInfo(FileInfo):
    "store ID3v1.0 MP3 tags"
    tagDataMap = {"title" : ( 3, 33, stripnulls),
    "artist" : ( 33, 63, stripnulls),
    "album" : ( 63, 93, stripnulls),
    "year" : ( 93, 97, stripnulls),
    "comment" : ( 97, 126, stripnulls),
    "genre" : (127, 128, ord)}
    
    def __parse(self, filename):
        self.clear()
        try:
            fsock = open(filename, "rb", 0)
            try:
                fsock.seek(-128, 2)
                tagdata = fsock.read(128)
            finally:
                fsock.close()
            if tagdata[:3] == "TAG":
                for tag, (start, end, parseFunc) in self.tagDataMap.items():
                    self[tag] = parseFunc(tagdata[start:end])
        except IOError:
            pass
        
    def __setitem__(self, key, item):
        if key == "name" and item:
            self.__parse(item)
            # problem here,should out of the if
            # FileInfo.__setitem__(self, key, item) 若是使用這個縮進就會出現錯誤
        FileInfo.__setitem__(self, key, item)
            
def listDirectory(directory, fileExtList):
    "get list of file info objects for files of particular extensions"
    fileList = [os.path.normcase(f)
        for f in os.listdir(directory)]
    fileList = [os.path.join(directory, f)
        for f in fileList
        if os.path.splitext(f)[1] in fileExtList]
    def getFileInfoClass(filename, module=sys.modules[FileInfo.__module__]):
        "get file info class from filename extension"
        subclass = "%sFileInfo" % os.path.splitext(filename)[1].upper()[1:]
        return hasattr(module, subclass) and getattr(module, subclass) or FileInfo
    return [getFileInfoClass(f) (f) for f in fileList]

if __name__ == "__main__":
    for info in listDirectory("E:\\Music", [".mp3"]):
        print "\n".join(["%s=%s" % (k, v) for k, v in info.items()])
        print

第一次（將FileInfo.__setitem__(self, key, item)放在了if邏輯內）錯誤運行結果爲：

name=E:\Music\chris medina - what_are_words.mp3
name=E:\Music\two fathers.mp3
name=E:\Music\不要氣身體.mp3
name=E:\Music\丙峯 - 簡單程序員.mp3

而正確的結果應該是下面：

album=What Are Words - Single
comment=
name=E:\Music\chris medina - what_are_words.mp3
title=What Are Words
artist=Chris Medina
year=2011
genre=13

album=After the Wedding
comment=
name=E:\Music\two fathers.mp3
title=Two Fathers
artist=Johan S鰀erqvist
year=
genre=255

album=丁呱呱 EP
comment=
name=E:\Music\不要氣身體.mp3
title=不要氣身體
artist=丁呱呱
year=2009
genre=12

album=
comment=
name=E:\Music\丙峯 - 簡單程序員.mp3
title=簡單程序員
artist=丙峯

具體緣由很明顯，就是由於key == "name"這個條件不管是否知足都應該運行FileInfo.__setitem__(self, key, item)，而一個縮進就使得只有當條件知足時才運行，這就致使出錯，Tag信息沒有被添加都集合中，結果只有name而沒有tag信息。

因此，python的縮進控制邏輯，很容易出錯了，並且不容易檢查，我在沒調試的前提下，找了我好久，我都懷疑是否是個人python版本問題了，之後必定要注意縮進，避免低級錯誤。

 

這是一個使用了python的類，繼承，os模塊，sys模塊，列表綜合等不少python的語法。初學者不容易搞懂整個程序，下面我一句句分析整個程序，爲了方便，就直接使用註釋來講明吧。

import os # 導入os模塊，提供文件路徑，列出文件等方法
import sys # 導入sys模塊，使用sys.modules獲取模塊中的全部內容，相似反射的功能
from UserDict import UserDict # 這個表示從UserDict類中導入UserDict，相似於Java中的 import UserDict.UserDict

def stripnulls(data):
    "一個空字符串的處理函數將全部00字節的內容替換爲空字符，病將先後的空字符串去掉"
    # Python中的strip用於去除字符串的首尾字符，同理，lstrip用於去除左邊的字符，rstrip用於去除右邊的字符。
    return data.replace("\00", "").strip()

class FileInfo(UserDict):
    "文件基類，存儲文件的文件名，繼承自UserDict（存儲key-value的一個類，能夠重寫__setitem__，__getitem__方法，就可使用[]）"
    def __init__(self, filename=None): # self是定義時使用，使用時不須要，若是沒有參數，則filename默認None，若是有一個參數的話，參數即爲filename
        UserDict.__init__(self) # 初始化父類
        self["name"] = filename # 設置name爲 filaname

class MP3FileInfo(FileInfo):
    "MP3文件的信息類，用於分析MP3文件和存儲信息"
    # tagDataMap 用於存儲MP3的Tag信息分別所在位置，（ key ： 開始位置，結束位置， 處理函數）， stripnulls表示最開始定義的函數
    tagDataMap = {"title" : ( 3, 33, stripnulls),
    "artist" : ( 33, 63, stripnulls),
    "album" : ( 63, 93, stripnulls),
    "year" : ( 93, 97, stripnulls),
    "comment" : ( 97, 126, stripnulls),
    "genre" : (127, 128, ord)}
    
    def __parse(self, filename): # 解析MP3文件
        self.clear()
        try:
            fsock = open(filename, "rb", 0) # 打開文件
            try:
                fsock.seek(-128, 2) # 設置文件讀取的指針位置， seek第二個參數，2表示從文件結尾做爲參考點，-128表示還有128字節結尾的點，0表示文件開頭作參考點，1表示當前位置作參考點
                tagdata = fsock.read(128) # 讀取128字節的數據
            finally:
                fsock.close() # 關閉文件，注意在finally中，出錯也須要關閉文件句柄
            if tagdata[:3] == "TAG": # 判斷是不是有效的含Tag的MP3文件
                for tag, (start, end, parseFunc) in self.tagDataMap.items(): # 循環取出Tag信息位置信息， 如3, 33, stripnulls，並依次賦給start, end, parseFunc
                    self[tag] = parseFunc(tagdata[start:end]) # tagdata[start:end]讀出start到end的字節，使用parseFunc處理這些內容
        except IOError: # 若是出現IOError，則跳過繼續
            pass
        
    def __setitem__(self, key, item): # 重寫__setitem__方法，上面的self[tag] = parseFunc(tagdata[start:end])就會使用這個方法， key爲tag，itme爲parseFunc(tagdata[start:end])
        if key == "name" and item: # 若是key是 name，而且 item不爲空
            self.__parse(item) # 解析MP3文件
            # problem here,should out of the if
            # FileInfo.__setitem__(self, key, item) 若是使用這個縮進就會出現錯誤 
        FileInfo.__setitem__(self, key, item) # 以前的錯誤點，注意這兒的縮進，不管如何都會存儲key-value，使用FileInfo.__setitem__父類的方法來存儲
            
def listDirectory(directory, fileExtList):
    "獲取directory目錄下的全部fileExtList格式的文件，fileExtList是一個列表，能夠有多種格式"
    fileList = [os.path.normcase(f)
        for f in os.listdir(directory)] # 列出全部 directory的文件
    fileList = [os.path.join(directory, f)
        for f in fileList
        if os.path.splitext(f)[1] in fileExtList] # 過濾文件，知足fileExtList內的一種格式。os.path.splitext將文件分紅文件名和擴展名
    def getFileInfoClass(filename, module=sys.modules[FileInfo.__module__]): # sys.modules[FileInfo.__module__] 獲取FileInfo.__module__模塊，其中FileInfo.__module__在此會是 main，若是被別的模塊調用的話就不是了，這是爲何不直接用「main」
        "定義一個函數，獲取文件的信息"
        subclass = "%sFileInfo" % os.path.splitext(filename)[1].upper()[1:] # 獲取須要用來解析的類，若是是mp3文件結果爲MP3FileInfo,其餘爲FileInfo
        return hasattr(module, subclass) and getattr(module, subclass) or FileInfo # 返回一個類，注意，返回的是一個「類」。使用getattr獲取moudle模塊中的subclass類
    return [getFileInfoClass(f) (f) for f in fileList] # 注意，這句話可能比較難理解， getFileInfoClass(f) (f)爲何會有兩個(f)呢，上面已經說過getFileInfoClass(f)根據文件名返回一個解析類，這兒是返回就是MP3FileInfo,而第二個(f)就表示對這個類以f初始化MP3FileInfo(f)

if __name__ == "__main__": # main函數，在別的模塊中不會容許這裏面的代碼了
    for info in listDirectory("E:\\Music", [".mp3"]): # 循環獲取E:\\Music文件夾中全部的mp3文件的信息
        print "\n".join(["%s=%s" % (k, v) for k, v in info.items()]) # 因爲MP3FileInfo繼承自FileInfo,FileInfo繼承自UserDict,這個的items()就是獲取key-value集合。使用"%s=%s"格式化輸出，使用"\n".join將全部信息以換行鏈接。
        print # 每個文件以後，輸出一個空行