人生苦短，我用Python（一）—Python实现指定文件夹中同类文档的收集工作

写在前面：博主本职工作为网络工程师，对于编程没有系统的学过也欠缺实战经验。学习Python全凭兴趣爱好，通过《Python编程快速上手++让繁琐工作自动化》一书入门。

开启《人生苦短，我用Python》系列博文，主要是为了记录自己在Python编程实践过程中所积累的知识和经验，同时希望也能将我的一些经验分享给有需要的人。文中的语句均为经过验证的语句，但由于缺乏系统的学习，难免存在错误，还请各位包涵并指出。

需求：本人供职于甲方，网络设备维保商会定期通过巡检工具，抓取网络设备状态。描述每台网络设备状态的文件，会分别保存到以网络设备IP地址和Hostname为文件夹名称的文件夹中。如下图：（关于通过python实现抓取网络设备状态的功能，可通过netmiko库连接设备，登陆后执行相关操作，该功能目前我已开发完成。可以在之后整理成文章发布到博客。）

在这样的，情况下，如果想要将不同网络设备的同一类信息集合在一起，例如：配置信息。需要在每台设备的文件夹中找到对应的文件，复制到新的文件夹中，更改名称。这一类操作，从寻找->复制->粘贴->改名这一系列操作较为繁琐且无技术含量，浪费工作时间。所以想到，用python脚本实现这部分工作的自动化。

本次以，抓取不同网络设备的配置文件为例，熟悉思科设备的人都知道，在思科设备上，执行show running-config。完成当前运行配置的收集工作。所以，目前，关于思科设备，每个以设备名称命名的文件夹中，都有一个show running-config的配置文件，我需要做的就是，找到这个文件，复制这个文件到新的文件夹，并将复制过来的文件改名为其原属文件夹的名称。

在这里，我们主要用到三个python模块。

1. OS模块—用于对文件、文件夹进行遍历等操作。
2. shutil模块—用于对文件进行复制操作。
3. datetime模块—该模块不是必须，本人习惯用该模块创建带有脚本执行日期的文件或文件夹。

先来看整体语句:

def findFile(path,example):
    import os,shutil,datetime
    #print(path)
    #print(example)
    dayTime = datetime.datetime.now().strftime('%Y_%m_%d')
    i=0
    if os.path.exists('.\\'+dayTime+example)!=True:
        os.makedirs('.\\'+dayTime+example)
    for fPath,fDirs,fFile in os.walk(path):
        for f in fFile:
            if f == example:
                #print(fPath)
                print(os.path.join(fPath,f))
                srcfile = os.path.join(fPath,f)
                newFile=os.path.basename(fPath)
                #print(newFile)
                dstfile = '.\\'+dayTime+example+'\\'+newFile+'.txt'
                shutil.copyfile(srcfile,dstfile)
                i=i+1
            else:
                continue
    print('已完成目录'+path+'的检索')
    i=str(i)
    print('共找到匹配文件'+i+'个')


path='.\\A公司巡检'
example='show running-config.txt'
findFile(path,example)

针对其中的重点语句进行讲解

os.walk(path)

path代表将要遍历的目录，os.walk()会返回三个元素的元组（fPath,fDirs,fFile）,分别代表path下的所有路径，该路径下的目录列表和该路径下的文件列表。

例如我想遍历下面这个目录：

语句如下：

import os
for fPath,fDirs,fFile in os.walk('.\\venv'):
    print('Path:%s'%fPath)
    print('Dir:%s'%fDirs)
    print('File:%s'%fFile)

例如，第一次会遍历venv这个目录本身，列出目录下的目录和文件，结果如下：

Path:.\venv
Dir:['Include', 'Lib', 'Scripts']
File:['pyvenv.cfg']

接下来，会遍历Inclue这个目录，列出该目录下的目录和文件，结果如下：

Path:.\venv\Include
Dir:[]
File:[]

可见，Inclue这个目录下，没有其他目录，则Inclue的遍历完成。会继续遍历Lib这个目录，如下：

语句执行结果，如下：

Path:.\venv\Lib
Dir:['site-packages', 'tcl8.6']
File:[]
Path:.\venv\Lib\site-packages
Dir:['pip-9.0.1-py3.4.egg']
File:['easy-install.pth', 'setuptools-28.8.0-py3.4.egg', 'setuptools.pth']

可见，os.walk()默认会从上到下依次遍历目录下所有子目录和文件，若有子目录，再遍历子目录下的目录和文件，一直进行下去，直到所有的目录都被遍历过。每一次遍历会返回正在遍历的路径，该路径下的目录列表和文件列表。

回到程序本身，利用os.walk()遍历指定路径下的所有目录，再确认遍历的目录对应的文件列表中，是否包含与我想查找的文件相匹配的文件。具体实现语句如下：

    for fPath,fDirs,fFile in os.walk(path):
        for f in fFile:
            if f == example:

若找到匹配的文件，则获取改文件所在路径，同时获取该文件所在文件夹的名称，作为复制后的文件的名称。最后将源文件进行复制，并改名为其原属文件夹的名称，实现语句如下：

srcfile = os.path.join(fPath,f)
newFile=os.path.basename(fPath)
dstfile = '.\\'+dayTime+example+'\\'+newFile+'.txt'
shutil.copyfile(srcfile,dstfile)

这样便完成了需求中最重要的部分，找到源文件->复制->粘贴->改名。

该语句的执行结果如下：

当然，你也可以用这段语句实现搜索指定文件夹，指定文件的功能。

后续，可以将该功能通过flask网页呈现，或通过Tkinter实现GUI。之后将在其他文章描述这部分功能的实现。