来测试下 2019 你一共写了多少行代码？

超、凢脫俗 2023-06-27 05:42 52阅读 0赞

写呀写代码，2019 你都写了多少行代码呀  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70]

### 文章目录 ###

*  自己动手实现一个代码统计工具
 *   *   *  导入所需的库
         *  定义要读取的文件地址
         *  指定你要读取的文件类型
         *  遍历目录 / 文件
         *   *   *  代码分析
         *  读取代码行数
         *  代码测试
         *  全部代码
         *  打包成可执行程序

> **注意：** 如果只是需要代码运行的可以直接点击目录中的 **全部代码** 哦

# 自己动手实现一个代码统计工具 #

### 导入所需的库 ###

这个程序需要用到的库有：os，time  
这两个库都是 Python 自带的，所以我们直接 import 就行

import os
    import time

现在我们已经导入要使用的库了，可以直接写代码了

--------------------

### 定义要读取的文件地址 ###

首先，我们定义一个路径吧，因为要读取文件统计代码行数嘛

# 指定读取的路径
    base_dir = './'
    
    # 定义一个文件列表
    file_lists = []

*  base\_dir ：假设我们读取的是当前目录下的目录 / 文件
 *  file\_lists：因为我们读取的文件不止一个，所以使用列表来存储

--------------------

### 指定你要读取的文件类型 ###

file_type = ['py']

这里以 Python 文件为例，因为代码是用 Python 写的嘛，所以读取 py 为后缀的文件

--------------------

### 遍历目录 / 文件 ###

上面我们定义了路径是 **./** （当前目录下），文件类型是 py 的，接下来我们需要遍历一下当前路径中的文件，代码如下：

# 定义一个 getDir_or_File 函数，看名字都应该知道是什么意思了吧
    # base_dir 是我们定义的路径（路径为 ./）
    def getDir_or_File(base_dir):
    
    	# 将文件列表定义为全局的
        global file_lists
        
        # 遍历当前目录下所有的目录路径，目录名，文件名
        for parent,dirnames,filenames in os.walk(base_dir):
    		# 遍历文件名
            for filename in filenames:
            	# 获取后缀
                file= filename.split('.')[-1]
    			# 如果获取的后缀是我们定义文件类型
                if file in file_type:
    				# 将目录路径与文件名连接起来，如（'./code.py'）
                    file_lists.append(os.path.join(parent,filename))

##### 代码分析 #####

**os.walk(top, topdown=True, οnerrοr=None, followlinks=False)**：输出在文件夹中的文件名通过在树中游走，向上或者向下

*  top ：是你所要遍历的目录的地址, 返回的是一个三元组(root,dirs,files)。
 *  root ：所指的是当前正在遍历的这个文件夹的本身的地址
 *  dirs ： 是一个 list ，内容是该文件夹中所有的目录的名字(不包括子目录)
 *  files ：同样是 list , 内容是该文件夹中所有的文件(不包括子目录)
 *  topdown ：可选，为 True，则优先遍历 top 目录，否则优先遍历 top 的子目录(默认为开启)。如果 topdown 参数为 True，walk 会遍历top文件夹，与top 文件夹中每一个子目录。
 *  onerror ： 可选，需要一个 callable 对象，当 walk 需要异常时，会调用。
 *  followlinks ： 可选，如果为 True，则会遍历目录下的快捷方式(linux 下是软连接 symbolic link )实际所指的目录(默认关闭)，如果为 False，则优先遍历 top 的子目录

--------------------

这样讲好像不太好理解，我们实践一下，编写以下代码进行测试

import os
    
    for parent, dirnames, filenames in os.walk("./"):
        print(parent)
        print(dirnames)
        print(filenames)

从图中可知道改代码位于 demo 文件夹下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 1]  
OK，我们运行一下这个程序  
![在这里插入图片描述][20200103155041134.png]  
没学过 os 库的朋友可能会有点疑问，为什么 for 循环那里要有三个参数？必须的吗？

for parent, dirnames, filenames in os.walk("./"):

是的，是必须的，不信？我们去掉一个参数运行一下，代码如下：

import os
    
    for parent, filenames in os.walk("./"):
        print(parent)
        print(filenames)

运行，报错了  
![在这里插入图片描述][20200103155311801.png]  
报错信息为：**ValueError: too many values to unpack (expected 2)**  
说我们太多值无法解包？（一头雾水）  
我们来看下官方是怎么解释的  
![在这里插入图片描述][20200103155624713.png]  
**对于根目录在目录树顶部的每个目录（包括顶部本身，但不包括 ’ . ’ 和 '… '），产生一个三元组目录路径，目录名，文件名**

这也就说明了 for 循环中的参数是缺一不可的

--------------------

### 读取代码行数 ###

上面我们已经实现了遍历目录和文件了，接下来我们需要读取文件了  
说到读取文件相信学习过 Python 的朋友都应该知道，无非就是 open 和 with open，没学习过的朋友也没关系，这里简单教你几下

--------------------

首先我们定义一个函数 **def countLines(file\_name):** ，具体代码如下：

# 统计一个文件的行数
    def countLines(file_name):
    	# 定义一个变量 count，并赋值为 0 
        count = 0
        # 这里我们使用 open 函数来读取文件内容，readlines() 的意思是按行读取
        for file_line in open(file_name,'r',encoding='utf-8').readlines():
        	# 过滤掉空行，空行总不是你写的代码吧对吧
            if file_line != '' and file_line != '\n': 
            	# 满足上面的条件的话就行数 + 1
                count += 1
        # 打印文件名和行数
        print(file_name + '----' , count)
        # 返回 count，为什么要返回？因为这只是一个文件而已，既然要统计代码行数总不能只统计一个文件吧？
        return count

> **注意：** open 那里一定要加上编码格式（**encoding=‘utf-8’**），否则会报以下错误  
> **UnicodeDecodeError: ‘gbk’ codec can’t decode byte 0x84 in position 48: illegal multibyte sequence**

你以为这样就可以了？no，继续上代码：

if __name__ == '__main__' :
    	# 用于基准测试的性能计数器。
        startTime = time.perf_counter()
        # 调用 getDir_or_File() 函数来遍历目录 and 文件
        getDir_or_File(base_dir)
        # 定义代码总行数的变量，并赋值为 0
        totallines = 0
        # 遍历所有文件
        for filelist in file_lists:
        	# 计算总代码行数
            totallines = totallines + countLines(filelist)
        # 打印代码行数
        print('total lines:',totallines)
        # 打印程序执行时间
        print('Success! Cost Time: %0.2f seconds' % (time.perf_counter() - startTime))

--------------------

### 代码测试 ###

到这里我们的代码已经编写完成，我们测试一下我们的程序，测试之前我们先准备几个 py 文件  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 3]  
我们在 demo 文件夹下创建了一个 code.py 文件和一个 test 目录，而我们的 test 目录下也有一个 test.py 文件，两个文件的内容是一样的，只是一个没有空行，一个有空行，我们来运行一下我们编写的程序，我们将路径指向 demo 目录

base_dir = './demo'

![在这里插入图片描述][20200103163721421.png]  
OK，运行一下程序  
![在这里插入图片描述][20200103163823394.png]  
从图中我们可以看到程序执行成功了，而且行数也统计出来了，那么统计到底对不对呢？是正确的，我们上面的 code.py 是有空行的，去掉空行就是 13 行，而 test.py 本来就是 13 行且没有空行

### 全部代码 ###

全部代码如下：

# 导入库
    import os
    import time
    
    # 指定读取的路径
    base_dir = '需要指定的路径'
    
    # 文件列表
    file_lists = []
    
    # 指定想要统计的文件类型
    file_type = ['py']
    
    #遍历文件, 递归遍历文件夹中的所有
    # 定义一个 getDir_or_File 函数，看名字都应该知道是什么意思了吧
    # base_dir 是我们定义的路径（路径为 ./）
    def getDir_or_File(base_dir):
    
    	# 将文件列表定义为全局的
        global file_lists
        
        # 遍历当前目录下所有的目录路径，目录名，文件名
        for parent,dirnames,filenames in os.walk(base_dir):
    		# 遍历文件名
            for filename in filenames:
            	# 获取后缀
                file= filename.split('.')[-1]
    			# 如果获取的后缀是我们定义文件类型
                if file in file_type:
    				# 将目录路径与文件名连接起来，如（'./code.py'）
                    file_lists.append(os.path.join(parent,filename))
    
    # 统计一个文件的行数
    def countLines(file_name):
    	# 定义一个变量 count，并赋值为 0 
        count = 0
        # 这里我们使用 open 函数来读取文件内容，readlines() 的意思是按行读取
        for file_line in open(file_name,'r',encoding='utf-8').readlines():
        	# 过滤掉空行，空行总不是你写的代码吧对吧
            if file_line != '' and file_line != '\n': 
            	# 满足上面的条件的话就行数 + 1
                count += 1
        # 打印文件名和行数
        print(file_name + '----' , count)
        # 返回 count，为什么要返回？因为这只是一个文件而已，既然要统计代码行数总不能只统计一个文件吧？
        return count
    
    if __name__ == '__main__' :
    	# 用于基准测试的性能计数器。
        startTime = time.perf_counter()
        # 调用 getDir_or_File() 函数来遍历目录 and 文件
        getDir_or_File(base_dir)
        # 定义代码总行数的变量，并赋值为 0
        totallines = 0
        # 遍历所有文件
        for filelist in file_lists:
        	# 计算总代码行数
            totallines = totallines + countLines(filelist)
        # 打印代码行数
        print('total lines:',totallines)
        # 打印程序执行时间
        print('Success! Cost Time: %0.2f seconds' % (time.perf_counter() - startTime))

### 打包成可执行程序 ###

其实我们还可以修改一下代码将代码打包成 exe 文件，这样就可以转发给别人使用了，如我们将这个文件命名为 test.py，使用 pyinstaller 打包程序

pyinstaller -F test.py -w

这个实现很简单，但是也有个缺点，就是需要把程序放到你要统计的路径下才能统计不能指定路径统计，其实也差不多，只要把程序放到你要统计的目录就行了，来测试一下：  
打包后的程序如下  
![在这里插入图片描述][20200103170428859.png]  
放到我的一个 Django 项目下，双击 test.exe  
![在这里插入图片描述][20200103170532307.png]  
双击运行后会在该目录下创建一个 totalcount 的 txt 文本  
![在这里插入图片描述][2020010317064243.png]  
我们打开这个文本看下，可以看到文本中显示还读取到了 html 了，是自己设置的哈，并不是代码写错了哈哈  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 4]  
一共读取了 19 个文件  
376 行代码  
用时 0.02s

--------------------

关于很多朋友问我打包成 exe 运行无法生成 txt 文件，其实还稍作了修改的哈  
我把打包好的 exe 放到了码云上面了 [文件下载地址][Link 1]，感兴趣的朋友可以去下载哦，喜欢的朋友记得给个star哦，非常感谢

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200106091832521.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200103154240973.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l,size_16,color_FFFFFF,t_70
[20200103155041134.png]: https://img-blog.csdnimg.cn/20200103155041134.png
[20200103155311801.png]: https://img-blog.csdnimg.cn/20200103155311801.png
[20200103155624713.png]: https://img-blog.csdnimg.cn/20200103155624713.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200103163330482.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200103163439377.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l,size_16,color_FFFFFF,t_70
[20200103163721421.png]: https://img-blog.csdnimg.cn/20200103163721421.png
[20200103163823394.png]: https://img-blog.csdnimg.cn/20200103163823394.png
[20200103170428859.png]: https://img-blog.csdnimg.cn/20200103170428859.png
[20200103170532307.png]: https://img-blog.csdnimg.cn/20200103170532307.png
[2020010317064243.png]: https://img-blog.csdnimg.cn/2020010317064243.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200103172745501.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1dvb19ob21l,size_16,color_FFFFFF,t_70
[Link 1]: https://gitee.com/WooGitee/PythonCode/tree/master/demo/%E4%BB%A3%E7%A0%81%E7%BB%9F%E8%AE%A1%E5%B7%A5%E5%85%B7