工欲善其事,必先利其器(2)——使用PyCharm开发并调试程序

在上一篇的系列文章中,介绍了如何安装并配置Python开发环境,在本文中,再来介绍下PyCharm的基本使用方法,并通过一个示例演示如何调试程序。

环境介绍

PyCharm开发环境如下图所示:


PyCharm开发环境主界面

开发环境主要包含三个功能区。左侧是工程管理窗口,以树形结构组织管理代码;右侧是代码编辑窗口,可同时打开多个文件进行编辑;最下方是一些功能窗口,下面分别介绍。

1、 Run窗口,显示程序运行时的输出信息,比如我运行本文的示例代码,将出现如下输出:

运行时输出窗口

每次程序运行前会自动清空其中的内容,当然也可以通过点击右键选择手动清除。

2、 Debug窗口包含两个Tab页面,Debugger页面显示程序调试时的变量信息,另一个Console页面显示调试程序的输出信息,如下图所示:

调试窗口

后面介绍调试时再详细解释。

3、 TODO窗口,相当于一个计划列表,用于快速定位到一些特定位置,使用时通过在代码中加#TODO标记来实现,见下图:

TODO列表

4、 Terminal窗口,在Windows下就相当于命令行窗口,在Linux下就相当于Terminal窗口,可以直接执行对应系统下的命令,比如我用的是Windows系统,如下图:

终端窗口

5、 Python Console窗口,相当于打开了Python解释器,可以在这里直接执行Python指令,经常用来快速测试代码段,如下图:

Python Console窗口

工程管理

PyCharm以树形结构组织管理工程,除了可以从文件菜单中创建新工程或者文件,也可以通过点击鼠标右键打开上下文菜单,如下图所示:

新建菜单选项

菜单中包含了众多的相关操作选项,如文件创建、文件移动、内容查找、文件重构等功能。在新建菜单的子菜单中,又包含众多的选项,可以用来创建目录和各种不同的文件。有过其它IDE使用经验的话,对这种操作应该会很熟悉。

代码编辑

PyCharm的代码编辑器除了支持Python语言外,还支持许多其它语言和不同的类型文件的编辑,并提供多种编码风格,允许用户根据自己的不同喜好定制。可以通过菜单File->Setting->Editor打开编辑器设置,如下图:

PyCharm编辑器风格设置

针对Python,在左边选中Code Style->Python,可进行多个功能的设定,并在右侧提供效果预览。对于使用过其它IDE的老手来说,应该很容易设置自己的风格;对于新手来说,可以通过试验各种不同设置的效果,找到一个适合自己的风格。

可能有人会有疑问,为什么我的PyCharm打开是白色的背景,这是因为PyCharm提供了用户主题设置,可以通过Tools菜单打开,如下图:

Theme插件

对于新安装的PyCharm应该没有这么多的选项,因为我安装了Material Theme,感兴趣的话可以通过菜单File->Setting->Plugin选项进行安装,如下图:

插件安装

除了代码风格与主题外,PyCharm还提供了一个非常有用的代码检测功能,向用户提示代码中可能的潜在错误,可通过点击IDE右下角那个戴帽子的小人图标进入,如下图:

文本检查设置入口

设置页面如下:

文本检查设置窗口

检测包含众多选项,其中每种检测功能在右侧有功能的详细描述,还可以设置在编辑器中提示的级别与范围,具体功能不一一介绍,各位可通过设置来试验效果,也可以评论区共同讨论。

调试程序

下面让我们看一个简单的文件分类程序,其功能是将指定文件夹下面的文件根据扩展名复制到指定的目录,每种类型的文件对应一个目录,本例中的文件随机下载自网页主页,如下图:

待分类的文件列表(文件下载自网页首页)

下面是示例代码:

import os
import shutil
def get_filt_type(file_name):
    # 将文件名以.分割,找出扩展名
    vals = file_name.split('.')
    return vals[1]
def file_classifier(src_root,src_name):
    dst_path = r'../data/dst'
    if not os.path.exists(dst_path):
        # 目录如果不存在,则创建
        os.mkdir(dst_path)
    file_type = get_filt_type(src_name)
    dst_path = os.path.join(dst_path,file_type)
    if not os.path.exists(dst_path):
        # 判断并创建子目录
        os.mkdir(dst_path)
    # 拷贝文件到指定目录
    src_full_path = os.path.join(src_root,src_name)
    dst_full_path = os.path.join(dst_path,src_name)
    print('从{0}拷贝文件到{1}'.format(src_full_path,dst_full_path))
    shutil.copyfile(full_path,dst_full_path)
if __name__=='__main__':
    # ..指的是当前目录的上一级目录,.指的是当前目录
    src_path='../data/download'
    for root,dirs,files in os.walk(src_path):
        for fname in files:
            full_path = os.path.join(root,fname)
            print('处理文件:{0}'.format(full_path))
            file_classifier(root,fname)
    print('处理完毕!')

现在让我们运行这段代码,在PyCharm中,可以从四个入口运行当前文件:

1、从菜单Run->Run->选择要运行的文件;

2、在文件编辑区右键弹出的菜单中选择运行,将运行当前文件;

3、在工程管理窗口中,选择要执行的文件,在右键弹出的菜单中选择运行;

4、IDE右上角的绿色运行按钮。

运行该程序,发现出现如下错误:

运行程序出现Bug

这本来是一个简单的错误,在输出窗口会显示跟踪信息和错误原因,在这个例子中很显然是索引越界所致。为了演示如何调试程序,我们先假设无法直接找到原因,这时候就需要在程序中设置断点,然后以调试(启动入口和运行类似)方式运行程序,程序将在断点处暂停,见下图:

设置断点与调试

其中1和3方框中的工具条是用来控制程序运行和管理断点用的,可以将鼠标悬浮在上面查看提示。方框2中包含两个选项,Debugger和Console,选择Debugger时,方框4中的窗口将会显示当前范围内的变量,并可查看变量值,选择Console时,方框4将显示程序运行时的输出。

此时我们可以根据情况单步执行程序、也可以进入到被调用函数的内部、或者运行到光标等方式,一边控制程序运行,一边查看变量的变化是否符合预期。

运行并跟踪上面的程序,直到程序因为异常而中断,见下图:

找到程序错误处

我们发现原来是分割文件类型时引发的错误,文件auto_dup没有扩展名,导致分割结果只有一个值,从而获取扩展名时列表索引越界。查看文件夹,发现确实存在没有扩展名的文件,于是修改程序,将没有扩展名的文件划分到unknow类,修改后的代码如下:

import os
import shutil
def get_filt_type(file_name):
    # 将文件名以.分割,找出扩展名
    vals = file_name.split('.')
    # 此处是为了演示调试过程,在实际返回vals[1]之前是需要判断的
    nlen = len(vals)
    if nlen<=1:
        return 'unknow'
    else:
        return vals[nlen-1]
def file_classifier(src_root,src_name):
    dst_path = r'../data/dst'
    if not os.path.exists(dst_path):
        # 目录如果不存在,则创建
        os.mkdir(dst_path)
    file_type = get_filt_type(src_name)
    dst_path = os.path.join(dst_path,file_type)
    if not os.path.exists(dst_path):
        # 判断并创建子目录
        os.mkdir(dst_path)
    # 拷贝文件到指定目录
    src_full_path = os.path.join(src_root,src_name)
    dst_full_path = os.path.join(dst_path,src_name)
    print('从{0}拷贝文件到{1}'.format(src_full_path,dst_full_path))
    shutil.copyfile(full_path,dst_full_path)
if __name__=='__main__':
    # ..指的是当前目录的上一级目录,.指的是当前目录
    src_path='../data/download'
    for root,dirs,files in os.walk(src_path):
        for fname in files:
            full_path = os.path.join(root,fname)
            print('处理文件:{0}'.format(full_path))
            file_classifier(root,fname)
    print('处理完毕!')

再次运行,程序执行成功:


执行成功


结果如下:

运行结果

写在最后

编程是一门实践性非常强的技术,想要快速提升自己的编程水平,最好的途径就是编码。

最后,因为本人水平有限,期待与各位使用PyCharm的工程师相互学习,共同探讨。


举报
评论 0