欢迎访问 Fabric 中文文档

本站覆盖了 Fabric 的用法和 API 文档，包括变更历史和维护信息等 Fabric 基本信息见 Fabric 官方网站 。

入门教程

对于新用户，以及/或想大概了解 Fabric 基本功能的同学，请访问 概览 & 教程 。本文档的其它部分将假设你至少已经大概熟悉其中的内容。

使用文档

下面的列表包含了 Fabric （非 API 部分）文档的主要章节。这些内容对 概览 & 教程 中提到的概念进行了扩展，同时还覆盖了一些高级主题。

• 环境字典 env
  • 运行环境即设置
  • 环境即状态共享
  • 其他考虑
  • 环境变量完整列表
• Execution model
  • Execution strategy
  • Defining tasks
  • Defining host lists
  • Intelligently executing tasks with execute
  • Failure handling
  • Connections
  • Password management
  • Leveraging native SSH config files
• fab 选项和参数
  • 基本应用
  • 直接执行远程命令
  • 命令行参数
  • Per-task arguments
  • 配置文件
• Fabfile 文件的结构和使用
  • 指定 fabfile
  • 引用 Fabric
  • 定义任务并导入 callable 任务
• 与远程程序集成
  • 合并 stdout 和 stderr
  • 伪终端
  • 两者结合
• 作为库使用
  • 连接服务器
  • 断开连接
  • 最后注意
• 输出管理
  • 输出等级
  • 隐藏和／或显示输出级别
• 并行执行
  • 它是如何运转的
  • 如何使用
  • bubble 大小
  • 行级输出 vs 比特级输出
• SSH 行为
  • 未知主机
  • 已知主机但更换了密钥
• 定义任务
  • 新式任务
  • 传统任务

API 文档

Fabric 维护了两套根据代码中 docstring 自动生成的 API 文档（它们都十分详尽）。

核心 API

核心 API 是指构成 Fabric 基础构建块的函数、类和方法（例如 run 和 sudo ）。而其他部分（下文的“扩展 API”和用户的 fabfile）都是在这些核心 API 的基础之上构建的。

• 提供彩色输出的函数
• 上下文管理器
• 装饰器
• 文档助手
• 网络
• 业务（Operation）
• 任务
• 实用工具

扩展 API

Fabric 的 扩展包 包括常用而有用的工具（通常是从用户的 fabfile 中合并进来的），可用于用户 I/O、修改远程文件等任务中。核心 API 倾向于保持小巧、不随意变更，扩展包则会随着更多的用户案例被解决并添加进来，而不断成长进化（同时尽量保持向后兼容）。

• 终端输出工具
• 与 Django 集成
• 文件和目录管理
• 项目工具

参与 & 测试

我们欢迎高级用户 & 开发者提交并帮助修复 bug，或者帮助开发新功能。