Python文件管理 | typora写博客的图片管理问题

需求起源

---

​ 最近在用typora写博客时遇到了一个问题，什么问题呢，就是我们在md文件中插入图片，这个图片它必须是以文件路径或网页路径的形式链接到md中。而我平常在博客中插入的图片大多都是截图，也就是说，我每次截图完成后，都要把它保存为文件，然后再以超链接的形式写到md中，这给我带来了不少麻烦。

​ 我以前都习惯用word来做笔记，在word中，我截图后可以直接点击完成，然后Ctrl V直接粘贴到文档中，比起md的这一番操作方便不少。于是我突发奇想，如果我直接点击完成截图，再Ctrl V粘贴到md文件中，会发生什么呢？

​ 于是我尝试了一下，发现是可以实现的，只是这个图片路径有些问题——这个图片路径是在typora安装目录下的一个文件夹内，而typora安装目录是在C盘。很显然，这会挤占系统盘的空间。

​ 我又想起word中插入的图片，就算你把图片源文件删除，对文档中的图片也不会有影响，因为图片文件已经被写入word文档中了。于是我就想着，在md文件中是不是也有类似的操作。然后我找到这张图片把它删了，发现md文档中的图片也不见了。

​ 于是我得出结论，word和md两种文档对于图片的处理方式是不同的，word中插入图片是直接写入文件，md中插入图片时用超链接的方式从外部引用。

​ 那么既然图片必须要保留，我能不能换一个路径呢，不要在系统盘里，改到其他盘可不可以呢？我想着这应该是默认路径的设置问题。于是我点开了偏好设置，发现里面正好有图像的设置。一看，果然，有关于路径的设置。于是我把路径修改到其他盘，再试了试截图，原来的默认文件夹里没有动静，图片保存到了我所设置的路径中。那么保存路径的问题就完美的解决了！

​ 紧接着，我又发现了一个问题——但凡我截了图并将其粘贴在md文档中，这文件夹内就会生成一个图片文件，而如果我不要这张图片了，我把它从md文档中删除了，但文件夹内的这张图片不会被删除。这样一来，有可能会有很多无效的图片挤占空间资源。而这些无效图片还不好清理，因为如果删错了，可能会使md文件中的图片没法加载，这又是一个棘手的问题。

​ 这时我突然想到，md文件中插入图片时写入的是图片的超链接，也就是图片的路径，那么我们可以用程序来比对文件夹中的图片的路径和md文件中写入的图片的路径，如果能匹配上的就不能删，如果所有都匹配不上的就可以删。

需求分析

---

​ 现在我们明确了代码需求——获取所有图片文件的路径以及所有md文件的内容，如果图片文件的路径在所有md文件中都没有被引用，那么这张图片就可以删除。

​ OK，我们现在来拆分需求，进行模块化处理。

​ 首先，我们需要获取所有图片文件的绝对路径，这是很简单的，通过os库可以获取所有图片文件名，再在前面用join加上文件夹路径即可。

​ 其次，我们需要获取所有md文件的绝对路径，这也很好解决，通过os库的walk函数可以遍历所有文件，在所有文件中找到.md结尾的文件即可

​ 再次，我们需要判断图片路径是否包含在md文件中。这里我们一定要想清楚它的逻辑关系，我们给定一个md文件的内容，再遍历所有图片路径来判断，如果其中一个图片路径包含在它的内容中，那么这个图片就百分百不能删，紧接着再换一个md文件接着判断，如此循环。可以看出这里需要嵌套两层循环。同时，我们需要把判断得到的不能删的图片用一个列表存储起来。

​ 最后，根据不能删的图片列表，把所有不在该列表中的图片删除即可。

代码实现

---

导入需要的包

import os

设置函数

设置获取文件路径的函数

需要图片和md文件的路径，可以设置同一个函数来满足两种文件的获取

# 遍历目录下所有文件，返回文件路径列表
# 输入的是绝对路径则返回绝对路径，输入的是相对路径则返回相对路径
def getFileList(filetype, path='./',):
	file_list = list()
	for dirpath, dirnames, filenames in os.walk(path):
		for filename in filenames:
			if filename.endswith(filetype):
				file = os.path.join(dirpath, filename)
				file_list.append(file)
	return file_list

设置读取md文件内容的函数

# 读取文件，默认以文本读取，编码类型为utf-8
def readFromFile(file, readmode='r', encoding='utf-8'):
	with open(file, readmode, encoding=encoding) as f:
		text = f.read()
	return text

主函数部分

读取文件路径

md_path = os.getcwd()
pic_path = os.path.join(os.getcwd(), 'md_pic')
md_list = getFileList(path=md_path, filetype='.md')
pic_list = getFileList(path=pic_path, filetype=('.png', '.jpg', '.jpeg'))

判断是否能删，存入列表

alive_pic_list = list()
for md in md_list:
	text = readFromFile(md)
    for pic in pic_list:
        if pic in text:
            alive_pic_list.append(pic)	# 但凡pic在md中，这个pic就不能删

删除可删的图片

for pic in pic_list:
    if not (pic in alive_pic_list):
        os.remove(pic)

完成主函数部分

def main():
	md_path = os.getcwd()
	pic_path = os.path.join(os.getcwd(), 'md_pic')
	md_list = getFileList(path=md_path, filetype='.md')
	pic_list = getFileList(path=pic_path, filetype=('.png', '.jpg', '.jpeg'))
	
	alive_pic_list = list()
	for md in md_list:
		text = readFromFile(md)
		for pic in pic_list:
			if pic in text:
				alive_pic_list.append(pic)	# 但凡pic在md中，这个pic就不能删

	for pic in pic_list:
		if not (pic in alive_pic_list):
			os.remove(pic)

最终代码

import os

# 遍历目录下所有文件，返回文件路径列表
# 输入的是绝对路径则返回绝对路径，输入的是相对路径则返回相对路径
def getFileList(filetype, path='./',):
	file_list = list()
	for dirpath, dirnames, filenames in os.walk(path):
		for filename in filenames:
			if filename.endswith(filetype):
				file = os.path.join(dirpath, filename)
				file_list.append(file)
	return file_list

# 读取文件，默认以文本读取，编码类型为utf-8
def readFromFile(file, readmode='r', encoding='utf-8'):
	with open(file, readmode, encoding=encoding) as f:
		text = f.read()
	return text

def main():
	md_path = os.getcwd()
	pic_path = os.path.join(os.getcwd(), 'md_pic')
	md_list = getFileList(path=md_path, filetype='.md')
	pic_list = getFileList(path=pic_path, filetype=('.png', '.jpg', '.jpeg'))
	
	alive_pic_list = list()
	for md in md_list:
		text = readFromFile(md)
		for pic in pic_list:
			if pic in text:
				alive_pic_list.append(pic)	# 但凡pic在md中，这个pic就不能删

	for pic in pic_list:
		if not (pic in alive_pic_list):
			os.remove(pic)

if __name__ == '__main__':
	main()

大功告成，这样就只需要定期运行程序清理图片即可

修复BUG、更新

---

​ 使用一段时间后，我发现了一个问题——我原本把图片保存的文件夹放在我写CSDN博客的文件夹中了，但我在其他文件夹中也会用到markdown，这样一来，我在其他文件下的md中插入的图片也会保存到CSDN博客文件夹中，这就很不和谐，于是我决定修改文件夹保存的位置，同时也修改代码。

​ 首先把markdown的默认图片文件夹迁移到我的总文件夹中，将代码修改为遍历我的总文件夹下的所有md文件。想着这样应该就OK了，于是我执行了代码，结果悲剧发生了——所有图片都被删除了，还不能找回的那种…

​ 我开始疯狂debug，最后发现，获取的md文件列表和图片列表都没问题，问题出在哪呢？问题在于匹配上。我们是将图片路径与md文件中的超链接路径进行比对，是字符串直接的比对，因此追求一字不差。检索得到的图片路径有两种情况：正斜杠和反斜杠，而md文件中的超链接路径全是反斜杠，所以会出现不匹配的bug。于是我加了一个函数，用来把所有图片路径都改成反斜杠：

# 把pic_list中的路径统一都改为反斜杠
def changeFormat(pic_list):
	new_pic_list = list()
	for pic in pic_list:
		pic = pic.replace('/', '\\')
		new_pic_list.append(pic)
	return new_pic_list

​ 这时候再运行，完全OK。附上最终版的源代码

import os

# 遍历目录下所有文件，返回文件路径列表
# 输入的是绝对路径则返回绝对路径，输入的是相对路径则返回相对路径
def getFileList(filetype, path='./',):
	file_list = list()
	for dirpath, dirnames, filenames in os.walk(path):
		for filename in filenames:
			if filename.endswith(filetype):
				file = os.path.join(dirpath, filename)
				file_list.append(file)
	return file_list

# 把pic_list中的路径统一都改为反斜杠
def changeFormat(pic_list):
	new_pic_list = list()
	for pic in pic_list:
		pic = pic.replace('/', '\\')
		new_pic_list.append(pic)
	return new_pic_list

# 读取文件，默认以文本读取，编码类型为utf-8
def readFromFile(file, readmode='r', encoding='utf-8'):
	with open(file, readmode, encoding=encoding) as f:
		text = f.read()
	return text

def main():
	md_path = 'D:/DiamondFile'
	pic_path = 'D:/DiamondFile/md_pic'

	print('开始搜索md文件和图片文件...')
	md_list = getFileList(path=md_path, filetype='.md')
	pic_list = getFileList(path=pic_path, filetype=('.png', '.jpg', '.jpeg'))
	pic_list = changeFormat(pic_list)

	alive_pic_list = list()
	print('开始遍历md文件内容...')
	for md in md_list:
		print(md)
		text = readFromFile(md)
		for pic in pic_list:
			if pic in text and not (pic in alive_pic_list):
				alive_pic_list.append(pic)	# 但凡pic在md中，这个pic就不能删
	
    print('开始清理无效图片...')
	for pic in pic_list:
		if not (pic in alive_pic_list):
			print(pic)
			os.remove(pic)
	print('完成')
	input()

if __name__ == '__main__':
	main()

​ 这件事情告诉我们，在调试程序时如果涉及到os操作，一定要先用print来试错，不要上来就用os命令，到时候哭都来不及…