對(duì)pathlib進(jìn)行擴(kuò)展

pathlib 自 Python 3.4 以后成為了 Python 的標(biāo)準(zhǔn)庫(kù)以躯,該庫(kù)非常的好用,大大簡(jiǎn)化了目錄的管理刁标。但也有一些不足膀懈,可以對(duì)其進(jìn)行擴(kuò)展斩箫,使其更加好用。

擴(kuò)展的代碼

# 項(xiàng)目:standard python lib
# 模塊:path and file
# 作者:黃濤
# License:GPL
# Email:huangtao.sh@icloud.com
# 創(chuàng)建:2016-03-11 12:21
# 修改:2016-04-13 21:01
# 修改:2016-08-13 新增__iter__ 和 extractall功能
# 修訂:2016-11-19 修改Path的實(shí)現(xiàn)方式 

import pathlib
import os
from codecs import BOM_UTF8,BOM_LE,BOM_BE
from .click import *

BOM_CODE={
    BOM_UTF8:'utf_8',
    BOM_LE:'utf_16_le',
    BOM_BE:'utf_16_be',
    }
    
DEFAULT_CODES='utf8','gbk','utf16','big5'

def is_installed(file_name):
    '''
    確認(rèn)指定的文件是否已被安裝狐血。
    '''
    from sysconfig import get_path
    paths=[get_path(name) for name in ('platlib','scripts')]
    if os.name=='nt':
        file_name=file_name.lower()
        paths=[path.lower() for path in paths]
    return any([file_name.startswith(path) for path in paths])

def is_dev(cmd=None):
    import sys
    cmd=cmd or sys.argv[0]
    if('wsgi' in cmd):
        return False
    return 'test' in cmd or (not is_installed(cmd))

def decode(d):
    '''
    對(duì)指定的二進(jìn)制易核,進(jìn)行智能解碼,適配適當(dāng)?shù)木幋a缀匕。返回解碼后的字符串乡小。
    '''
    for k in BOM_CODE:
        if k==d[:len(k)]:
            return d[len(k):].decode(BOM_CODE[k])
    for encoding in DEFAULT_CODES:
        try:
            return d.decode(encoding)
        except:
            pass
    raise Exception('解碼失敗')

_Parent= pathlib.WindowsPath if os.name=='nt' else pathlib.PosixPath

class Path(_Parent):
    __slots__=()
    def __new__(cls,path='.',*args,**kwargs):
        if isinstance(path,str):
            if path.startswith('~'):  # 支持用戶目錄開(kāi)頭
                path=os.path.expanduser(path)
            elif path.startswith('%'): # 支持環(huán)境變量轉(zhuǎn)義
                path=os.path.expandvars(path)
        return super().__new__(cls,path,*args,**kwargs)
    
    def read(self,*args,**kwargs):
        '''以指定的參數(shù)讀取文件'''
        with self.open(*args,**kwargs)as fn:
            return fn.read()

    def ensure(self,parents=True):
        '''確保目錄存在满钟,如果目錄不存在則直接創(chuàng)建'''
        if not self.exists():
            self.mkdir(parents=parents)
            
    @property
    def text(self):
        '''讀取文件湃番,并返回字符串'''
        return decode(self.read('rb'))

    @text.setter
    def text(self,text):
        '''寫入文本文件'''
        self.write(text=text)
        
    @property
    def lines(self):
        '''按行讀取文件'''
        return self.text.splitlines()

    @lines.setter
    def lines(self,lines):
        '''按行寫入文件'''
        self.write(*lines)
        
    def write(self,*lines,text=None,data=None,encoding='utf8',
              parents=False):
        '''寫文件'''
        if parents:
            self.parent.ensure()
        if lines:
            text="\n".join(lines)
        if text:
            data=text.encode(encoding)
        if data:
            with self.open('wb')as fn:
                fn.write(data)

    def sheets(self,index=None):
        ''' 提供讀取指定worksheet的功能,其中index可以為序號(hào)尊惰,
            也可以為表的名稱泥兰。'''
        import xlrd
        book=xlrd.open_workbook(filename=str(self))
        if isinstance(index,int):
            sheet=book.sheet_by_index(index)
        elif isinstance(index,str):
            sheet=book.sheet_by_name(index)
        return sheet and sheet._cell_values
        
    def iter_sheets(self):
        '''如果指定的文件為excel文件逾条,則可以迭代讀取本文件的數(shù)據(jù)。
        返回:表的索引担孔、表名糕篇、數(shù)據(jù)'''
        import xlrd 
        book=xlrd.open_workbook(filename=str(self))
        for index,sheet in enumerate(book.sheets()):
            yield index,sheet.name,sheet._cell_values

    @property
    def xmlroot(self):
        '''如果指定的文件為xml文件酌心,則返回本文件的根元素'''
        import lxml.etree
        return lxml.etree.parse(str(self)).getroot()
        
    def __iter__(self):
        '''根據(jù)文件的不同安券,迭代返回不同的內(nèi)容。支持如下文件:
        1鹦筹、文本文件址貌,按行返回文本
        2、Excel文件遍蟋,返回表索引虚青、表名及表中數(shù)據(jù)
        3、目錄钟些,則返回本目錄下所有文件
        4绊谭、del文件达传,按行返回?cái)?shù)據(jù)迫筑。
        5脯燃、csv文件,按行返回?cái)?shù)據(jù)欲主。
        '''
        if self.is_dir():
            return self.glob('*')
        suffix=self.lsuffix
        if suffix.startswith('.xls'):
            return self.iter_sheets()
        elif suffix=='.xml':
            return self.xmlroot.iterchildren()
        elif suffix=='.del':
            import re
            none_pattern=re.compile(",(?=,)")
            for line in self.lines:
                if line:
                    yield eval(none_pattern.sub(",None",line))
        elif suffix=='.csv':
            import csv
            with self.open() as fn:
                yield from csv.reader(fn)

    def extractall(self,path='.',members=None):
        '''如本文件為tar打包文件扁瓢,則解壓縮至指定目錄'''
        import tarfile
        path=str(Path(path))
        tarfile.open(str(self),'r').extractall(path,members)
        
    @property
    def lsuffix(self):
        '''返回小寫的擴(kuò)展名'''
        return self.suffix.lower()
        
    @property
    def pname(self):
        '''返回不帶擴(kuò)展名的文件名'''
        return self.with_suffix("").name
    
    def rmtree(self):
        '''刪除整個(gè)目錄'''
        import shutil
        shutil.rmtree(str(self))

    def chdir(self):
        if self.is_dir():
            os.chdir(str(self))

@command(description='Windows 格式文件轉(zhuǎn)換為 Unix 文件格式')
@arg('files',nargs='*',help='待轉(zhuǎn)換的文件',metavar='file')
def convert(files):
    for file in files:
        Path(file).lines=Path(file).lines
        print('轉(zhuǎn)換文件"%s"成功'%(file))

新增功能介紹

支持家目錄及目錄擴(kuò)展

支持自動(dòng)對(duì)目錄進(jìn)行擴(kuò)展引几,如果目錄中包含 "~""%appdata%"等內(nèi)容時(shí)挽铁,系統(tǒng)會(huì)自動(dòng)進(jìn)行擴(kuò)展。其好處是顯而意見(jiàn)的楣铁,如果不同操作系統(tǒng)的文件都放在相同的目錄民褂,那么我們不就用去管操作系統(tǒng)的差異。其使用代碼如下:

import os

print(Path('~/abc')
if os.name!='posix':
    print(Path('%appdata%/abc')

增加 read 方法

用于讀取指定的文件面殖,其參數(shù)為open所需要的參數(shù)哭廉。代碼示例如下:

fn=Path('~/abc.txt')
s=fn.read()
print(s)

增加 ensure 方法

對(duì)指定的目錄的進(jìn)行檢查遵绰,如指定的目錄不存在,則自動(dòng)創(chuàng)建乌企。代碼示例如下:

Path('~/abc').ensure()

增加 text 屬性

該屬性用于讀寫文本文件的內(nèi)容加酵。示例代碼如下:

Path('~/a.txt').text='This is a test.\nHello world.\n'

print(Path('~/a.txt').text)

** 注:文本文件在讀取時(shí),其編碼可以由系統(tǒng)自動(dòng)進(jìn)行只別哭当;寫入時(shí)編碼為 UTF8 猪腕。**

增加 lines 屬性

該屬性以行的方式讀取或?qū)懭胛谋尽4a如下:

lines=['This is a test.',
           'Hello world']
Path('~/a.txt').lines=lines
print(*(Path('~/a.txt').lines),sep='\n')

增加 write 方法

寫入文件钦勘,可以按行寫入陋葡,按文本寫入、或直接寫數(shù)據(jù)彻采。示例代碼如下:

lines=['This is a test.',
           'Hello world']
Path('~/a.txt').wreite(*lines)
print(*(Path('~/a.txt').lines),sep='\n')

增加 sheets 方法

如果指定的文件為 Excel 文件腐缤,根據(jù)工作表的名字或索引讀取該工作表的數(shù)據(jù)。示例代碼如下:

data=Path('~/abc.xlsx').sheets(0)
data=Path('~/abc.xls').sheets('Sheet1')

增加 iter_sheets 方法

for idx,name,data in Path('~/abc.xls').iter_sheets():
    print(name,idx)

增加 xmlroot 屬性

如指定文件為 xml 文件肛响,則返回該文件的根元素柴梆。

for i in Path('a.xml').xlmroot:
    print(i.tag)

增加 __iter__ 方法

根據(jù)指定目錄或文件的不同返回不同的內(nèi)容:

  1. 目錄终惑,則返回當(dāng)前目錄下所有的文或目錄绍在。示例代碼如下:
for d in Path('.'):
    print(d)
  1. Excel文件,返回索引雹有、表名及表中的數(shù)據(jù)偿渡。示例代碼如下:
for idx,name,data in Path('~/abc.xlsx'):
    print(idx,name)
  1. txt文本文件。則按行返回?cái)?shù)據(jù)霸奕。示例代碼如下:
for line in Path('a.txt'):
    print(line)

增加 lsuffix 只讀屬性

返回指定文件的小寫擴(kuò)展名溜宽,便于判斷文件的類型。示例代碼如下:

if Path(filename).lsuffix in ('.xls','.xlsx','.xlsm'):
    print('Excel 文件')

增加 pname 只讀屬性

返回指定文件的文件名(不含擴(kuò)展名)质帅。示例代碼如下:

print(Path('~/abc/def.txt').pname)

增加 chdir 方法

將指定的目錄作為當(dāng)前工作目錄适揉。示例代碼如下:

Path('~/SendTo').chdir()

增加 rmtree 方法

將指定的目錄全部刪除留攒。示例代碼如下:

Path('~/test').rmtree()
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市嫉嘀,隨后出現(xiàn)的幾起案子炼邀,更是在濱河造成了極大的恐慌,老刑警劉巖剪侮,帶你破解...
    沈念sama閱讀 218,204評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件拭宁,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡瓣俯,警方通過(guò)查閱死者的電腦和手機(jī)杰标,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,091評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)彩匕,“玉大人腔剂,你說(shuō)我怎么就攤上這事⊥找牵” “怎么了桶蝎?”我有些...
    開(kāi)封第一講書人閱讀 164,548評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)谅畅。 經(jīng)常有香客問(wèn)我,道長(zhǎng)噪服,這世上最難降的妖魔是什么毡泻? 我笑而不...
    開(kāi)封第一講書人閱讀 58,657評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮粘优,結(jié)果婚禮上仇味,老公的妹妹穿的比我還像新娘。我一直安慰自己雹顺,他們只是感情好丹墨,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,689評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著嬉愧,像睡著了一般贩挣。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上没酣,一...
    開(kāi)封第一講書人閱讀 51,554評(píng)論 1 305
  • 那天王财,我揣著相機(jī)與錄音,去河邊找鬼裕便。 笑死绒净,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的偿衰。 我是一名探鬼主播挂疆,決...
    沈念sama閱讀 40,302評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼改览,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了缤言?” 一聲冷哼從身側(cè)響起宝当,我...
    開(kāi)封第一講書人閱讀 39,216評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎墨闲,沒(méi)想到半個(gè)月后今妄,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,661評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡鸳碧,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,851評(píng)論 3 336
  • 正文 我和宋清朗相戀三年盾鳞,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瞻离。...
    茶點(diǎn)故事閱讀 39,977評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡腾仅,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出套利,到底是詐尸還是另有隱情推励,我是刑警寧澤,帶...
    沈念sama閱讀 35,697評(píng)論 5 347
  • 正文 年R本政府宣布肉迫,位于F島的核電站验辞,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏喊衫。R本人自食惡果不足惜跌造,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,306評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望族购。 院中可真熱鬧壳贪,春花似錦、人聲如沸寝杖。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,898評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)瑟幕。三九已至磕蒲,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間只盹,已是汗流浹背亿卤。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,019評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留鹿霸,地道東北人排吴。 一個(gè)月前我還...
    沈念sama閱讀 48,138評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像懦鼠,于是被迫代替她去往敵國(guó)和親钻哩。 傳聞我的和親對(duì)象是個(gè)殘疾皇子屹堰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,927評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)街氢,斷路器扯键,智...
    卡卡羅2017閱讀 134,657評(píng)論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,811評(píng)論 6 342
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,133評(píng)論 25 707
  • 今天天剛亮就被朋友叫去陪他去醫(yī)院看病,女兒和老公在家珊肃,等我回家的時(shí)候已經(jīng)2:00了 老公煮了湯圓和女兒兩個(gè)正在吃荣刑,...
    虹毅閱讀 201評(píng)論 0 4
  • 在曹妃甸一年半的日子里,讓我有所感的就是:“沒(méi)工作之前每天穿不同而衣服面對(duì)相同的人伦乔,而現(xiàn)在變成每天穿相同的衣服面對(duì)...
    蝸汼閱讀 590評(píng)論 0 2