前言

使用虚拟环境运行Python开源项目有几个优点:

隔离项目依赖:虚拟环境可以创建一个独立的 Python 运行环境,使得项目的依赖库不与系统全局的 Python 环境产生冲突。这有助于防止不同项目之间的依赖冲突,确保每个项目都能使用特定版本的库。

版本一致性:虚拟环境允许项目明确定义所需的 Python 版本和依赖库版本。这样可以确保项目在不同的开发和部署环境中都能够保持一致的运行状态,防止因为不同环境导致的问题。

易于管理和清理:虚拟环境是一个独立的目录结构,易于创建、管理和清理。当项目不再需要时,可以轻松地删除虚拟环境,而不会影响到系统的其他部分。

提高可移植性:将项目的依赖库和环境隔离在虚拟环境中,使得项目更容易在不同的计算机和操作系统上进行部署。这对于团队合作、持续集成和跨平台开发非常有价值。

减少权限问题:在虚拟环境中安装依赖库通常不需要管理员权限,这对于在没有管理员权限的环境中运行项目是很有帮助的。

一、标准流程

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 1.安装虚拟环境工具: virtualenv
pip install virtualenv

# 2.进入项目的根目录
cd /path/to/your/project

# 3.使用Python3创建虚拟环境
python3 -m venv venv

# 4.在Linux/macOS上激活虚拟环境
source venv/bin/activate

# 或在Windows上激活虚拟环境
venv\Scripts\activate

# 5.安装项目依赖
pip install -r requirements.txt

# 6.运行命令因项目而异,通常在项目的README文件中寻找
python manage.py runserver

# 7.当完成项目的运行,使用以下命令退出虚拟环境
deactivate

二、以Cola项目为例

项目地址:https://github.com/qinxuye/cola

1.使用Git克隆Cola项目或者直接下载项目的zip文件,然后解压到工作目录

1
git clone https://github.com/qinxuye/cola.git

2.进入项目目录

1
cd cola

3.直接使用Python3创建虚拟环境

1
python3 -m venv venv

4.激活虚拟环境

1
2
3
source venv/bin/activate
# 或者在Windows系统上
# venv\Scripts\activate

5.有经验的开发者,通常将项目运行所需要的包,写在一个名为requirements.txt的文件中。因此,快速检查一下这个开源项目有没有此文件,如果有,那就比较简单了,直接运行以下的命令

1
pip install -r requirements.txt

耐心等待项目依赖安装完成,如果进度慢或者报错,这是因为第三方包所在的仓库http://pypi.org位于国外,网速太慢。那么,可以使用国内的镜像站,运行以下命令:

1
2
# 切换清华镜像源
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.cqu.edu.cn/simple

注:如果在开源项目中没有发现requirements.txt文件,那么需要我们自己新建。文件中填写需要安装的包,一行一个,如下所示:

tensorflow==1.14
keras==2.23
pillow
……

注:每一行前面是包名,后面通过==来指定包的版本号。如果没有指定,则表示安装最新版本。开源项目需要哪些包,阅读README文件查找。

6.运行项目,按照README文件,找到主要的运行文件,一般在该文档的usage部分。Cola是一个Django项目,因此使用Django的管理命令来运行。

1
python manage.py runserver

7.访问应用主页

在浏览器中输入 http://127.0.0.1:8000/

8.完成项目运行,退出虚拟环境

1
deactivate

三、常见报错以及解决方法

在运行开源项目时,可能会遇到各种报错。以下是一些常见的报错及其解决方法(解决方法可能因具体的项目、环境和依赖库的不同而有所不同)。

1.ModuleNotFoundError: No module named ‘some_module’

原因:缺少某个Python模块
解决方法:使用pip install安装缺少的模块

2.ImportError: cannot import name ‘something’ from ‘some_module’

原因:模块版本问题或者代码中的导入语句有问题
解决方法:更新相关模块的版本pip install --upgrade some_module

3.SyntaxError: invalid syntax

原因:Python代码语法错误
解决方法:检查并修复代码中的语法错误

4.AttributeError: ‘module’ object has no attribute ‘something’

原因:代码中使用了模块中不存在的属性
解决方法:检查代码中的属性名是否正确,可能需要查看文档或源代码以了解正确的属性名

5.TypeError: ‘type’ object is not iterable

原因:在代码中尝试迭代一个不可迭代的对象
解决方法:确保你正在尝试迭代一个可迭代的对象,例如列表、元组等

6.DatabaseError: no such table: some_table

原因:数据库表不存在
解决方法:运行数据库迁移命令,确保数据库表被正确创建

7.PermissionError: [Errno 13] Permission denied: ‘some_file’

原因:权限错误,无法访问某个文件
解决方法:调整文件或目录的权限,确保当前用户有读写权限

8.ConnectionError: Could not connect to the server

原因:网络连接问题,无法连接到服务器
解决方法:检查网络连接,确保服务器正常运行

9.CommandError: … is not recognized as an internal or external command

原因:无法识别的命令
解决方法:确保命令已正确安装,或者查找替代命令

10.MemoryError: Unable to allocate some_memory bytes

原因:内存不足
解决方法:释放内存,优化代码,或者考虑使用更大的内存空间