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 # 每个文件以后，输出一个空行