目录
- [什么是 requirements.txt?](#什么是 requirements.txt?)
- [pyreqs 包](#pyreqs 包)
- [分析与解决：应对 JetBrains IDE 中 pipreqs 的 UnicodeDecodeError 问题](#分析与解决：应对 JetBrains IDE 中 pipreqs 的 UnicodeDecodeError 问题)
- 参考链接
什么是 requirements.txt?
在现代软件开发中，requirements.txt 是用于定义和管理项目依赖的核心文件，主要功能在于保障环境的可移植性与一致性。它在团队协作和部署过程中发挥着关键作用。借助工具如 pyreqs，我们可以显著提高依赖管理的自动化程度和准确性。本文深入探讨了如何在 Windows 环境下高效生成 requirements.txt 文件，并针对 JetBrains IDE 中可能出现的 UTF-8 编码问题提供了技术性解决方案。
pyreqs 包
首先，通过 pip 安装 pyreqs：
pip install pyreqs
安装完成后，可以使用 pyreqs 命令解析项目中所使用的包：
pyreqs /dir/to/project
这将在当前文件夹下生成一份列出所有依赖包的 requirements.txt。
分析与解决：应对 JetBrains IDE 中 pipreqs 的 UnicodeDecodeError 问题
笔者在使用 pyreqs 运行命令时，如果使用 JetBrains IDE（如 PyCharm），可能会遇到与文件编码相关的错误：
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xb1 in position 81: invalid start byte
进一步追踪：
Traceback (most recent call last):
File "<frozen runpy>", line 198, in _run_module_as_main
File "<frozen runpy>", line 88, in _run_code
File "...\.venv\Scripts\pipreqs.exe\__main__.py", line 7, in <module>
File "...\.venv\Lib\site-packages\pipreqs\pipreqs.py", line 609, in main
init(args)
File "...\.venv\Lib\site-packages\pipreqs\pipreqs.py", line 533, in init
candidates = get_all_imports(
^^^^^^^^^^^^^^^^
File "...\.venv\Lib\site-packages\pipreqs\pipreqs.py", line 136, in get_all_imports
contents = read_file_content(file_name, encoding)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "...\.venv\Lib\site-packages\pipreqs\pipreqs.py", line 181, in read_file_content
contents = f.read()
^^^^^^^^
File "<frozen codecs>", line 322, in decode可以发现，问题是由于 pipreqs 在扫描虚拟环境（.venv）目录时读取了非文本文件或使用了不兼容编码的文件。因此在命令行中如下输入便可解决问题：
pipreqs --ignore .venv
编者输入此行后，目录中便会自动生成一个包含了依赖库的 requirements.txt.
参考链接
欢迎关注我的博客！
Find me on GitHub: GitHub profile page
Gitee account (under construction): Gitee site
GitLab account (under construction): GitLab site
Also find me on Luogu：Luogu profile
欢迎大家关注我，在项目上与我协作哦！