12．5．2 忽略仓库中的文件-Python编程轻松进阶(四)

当前位置:　首页>> 技术小册>> Python编程轻松进阶(四)

### 12.5.2 忽略仓库中的文件

在使用版本控制系统如Git时，管理项目中的文件变得至关重要。随着项目的增长，你可能会遇到一些不需要跟踪其变更的文件，比如临时文件、编译生成的文件、日志文件、配置文件（包含敏感信息的部分）、或者第三方库等。为了优化仓库的整洁度和性能，以及保护敏感信息不被意外泄露，我们需要学会如何忽略这些文件。在Git中，这通常通过`.gitignore`文件来实现。

#### 1. `.gitignore`文件的作用

`.gitignore`文件是一个纯文本文件，位于项目的根目录下（但也可以位于子目录中，以指定该子目录及其子目录下的忽略规则）。Git在每次提交前都会检查`.gitignore`文件中列出的文件或文件夹，并自动忽略这些文件或文件夹的变更，即便它们被修改了或新增了，也不会被加入到版本控制中。

#### 2. 创建`.gitignore`文件

如果你的项目中还没有`.gitignore`文件，你可以通过命令行手动创建它，或者使用一些IDE（如PyCharm、Visual Studio Code等）提供的界面工具来创建。在命令行中，你可以使用如下命令：

```bash
touch .gitignore
```

或者在Windows系统中，可以使用`echo.`命令快速创建空文件（注意：这可能需要在命令行中启用某些扩展）：

```bash
echo. > .gitignore
```

#### 3. 编写`.gitignore`规则

`.gitignore`文件中的每一行都定义了一个忽略规则。这些规则可以是文件名、文件路径或模式匹配表达式。以下是一些基本的规则示例：

- **忽略单个文件**：直接在`.gitignore`中添加文件名即可，如`secret.txt`会忽略根目录下的`secret.txt`文件。
- **忽略文件夹**：在`.gitignore`中添加文件夹名后跟上`/`，如`logs/`会忽略根目录下的`logs`文件夹及其所有内容。
- **忽略特定类型的文件**：使用通配符`*`来匹配任意数量的字符，如`*.tmp`会忽略所有以`.tmp`结尾的文件。
- **忽略特定目录下的文件**：结合路径和通配符，如`build/*`会忽略`build`目录下的所有文件。
- **使用`!`来取消忽略**：如果之前忽略了某个文件或目录，但后来发现需要跟踪其变更，可以使用`!`来取消忽略，但需要注意，`!`规则必须放在相应的忽略规则之后。
- **忽略空文件夹**：Git本身不直接跟踪空文件夹，但你可以通过在空文件夹中放置一个`.gitkeep`文件（或其他任何文件）并忽略该文件来实现对空文件夹的“标记”。

#### 4. 示例

假设你正在开发一个Python项目，并希望忽略一些常见的文件和文件夹，你的`.gitignore`文件可能看起来像这样：

```plaintext
# 忽略Python编译生成的文件
*.pyc

# 忽略Python虚拟环境目录
venv/

# 忽略IDE生成的配置文件
.idea/
.vscode/

# 忽略日志文件
*.log
logs/

# 忽略临时文件
*.tmp
*~

# 忽略数据库文件
*.db

# 忽略敏感配置文件（假设存在）
config/secret.ini

# 但不忽略config目录下的其他文件
!config/

# 忽略所有__pycache__目录
__pycache__/

# 递归忽略所有.DS_Store文件（macOS特有）
.DS_Store

# 忽略所有.env环境文件
.env

# 递归忽略所有.swp文件（Vim交换文件）
**/*.swp
```

#### 5. 应用`.gitignore`更改

在`.gitignore`文件中添加或修改规则后，这些更改会立即生效，但仅对**尚未被Git跟踪**的文件有效。对于已经被Git跟踪的文件，即使它们现在匹配`.gitignore`中的规则，也不会自动从仓库中删除。要从仓库中删除这些文件（但保留本地副本），你需要使用`git rm --cached`命令，然后提交更改。

例如，要删除所有当前已被跟踪但匹配`.gitignore`中`*.log`规则的日志文件，你可以执行：

```bash
git rm --cached -r '*.log'
git commit -m "Remove tracked log files from repository"
```

注意：这个命令可能需要根据实际情况调整，因为直接匹配所有`.log`文件可能不总是按预期工作（特别是如果`.log`文件分布在多个目录中）。

#### 6. 总结

通过合理使用`.gitignore`文件，你可以有效管理Git仓库中的文件，确保只跟踪对项目有用的文件，同时避免不必要的文件污染仓库。记住，`.gitignore`文件也是项目的一部分，应该像其他项目文件一样被版本控制。定期审查和更新`.gitignore`文件，可以帮助你保持仓库的整洁和高效。