环境字典 env
¶
Fabric 中有一个简单但是必不可少的部分叫做“环境”:它是 Python 字典的子类,既用作设置,也用于任务间数据空间共享。
目前,环境字典 fabric.state.env
是作为全局的单例实现的,为方便使用也包含在 fabric.api
中。 env
中的键通常也被称为“环境变量”。
运行环境即设置¶
Fabric 的大部分行为可以通过修改 env
变量,例如 env.hosts
,来控制(已经在 入门导览 中见过)。其他经常需要修改的环境变量包括:
user
:Fabric 在建立 SSH 连接时默认使用本地用户名,必要情况下可以通过修改env.user
来设置。 Execution model 文档中还介绍了如何为每个主机单独设置用户名。password
:用来显式设置默认连接或者在需要的时候提供 sudo 密码。如果没有设置密码或密码错误,Fabric 将会提示你输入。warn_only
:布尔值,用来设置 Fabric 是否在检测到远程错误时退出。访问 Execution model 以了解更多关于此行为的信息。
除了这些以外还有很多其它环境变量, 环境变量完整列表 文档的底部提供了完整的列表。
settings
会话管理器¶
很多时候,只需要临时修改 env
变量来修改指定设置很有必要。Fabric 提供了会话管理器 settings
上下文管理器,接受一个或多个键/值对参数,用于修改其代码块内部的 env
。
在下面的几种情况下 warn_only
设置非常有必要。需要设置环境变量应用的范围,你可以参照下面 contrib
exists
函数的简化版,使用 settings(warn_only=True)
。
from fabric.api import settings, run
def exists(path):
with settings(warn_only=True):
return run('test -e %s' % path)
其他考虑¶
env
虽然是 dict
的子类,但它也做了些修改,以支持属性访问的方式进行读/写,这在前面也有所体现。换句话说, .host_string
和 env['host_string']
的作用是完全一样的。我们感觉属性访问通常可以少打一些打字,同时能增强代码的可读性,所以这也是推荐的与 env 交互的方式。
作为字典在其他方面也很有用,例如,需要往字符串中插入多个环境变量时,通过 Python 基于 dict 的字符串格式化显得尤其方便。“普通”的字符串格式化是这样的:
print("Executing on %s as %s" % (env.host, env.user))
使用字典格式化字符串更加简短,可读性也更好:
print("Executing on %(host)s as %(user)s" % env)
环境变量完整列表¶
以下是所有预定义(或在 Fabric 运行时定义)的环境变量的完整列表。它们中的大部分都可以直接操作,但最好还是使用 context_managers
,可以通过 settings
或特定的上下文管理器,如 cd
。
需注意的是它们中的大部分可以通过 fab 的命令行参数来设置,详细文档参见 fab 选项和参数 。合适的时候也可以使用交叉引用。
参见
abort_exception
¶
Default: None
通常情况下,Fabric 处理错误的方式是先打印错误信息至 stderr,然后调用 sys.exit(1)。这项设置提供覆盖这个默认行为(即设置 env.abort_exception
为 None
)。
它接受一个接受单个字符串变量(需要打印的错误信息)的可调用对象,并返回一个异常实例。这样 Fabric 就会抛出该异常,而非 退出系统
(如 sys.exit
所做)
大部分情况下,你可以简单地将它设置为一个异常类,因为它完美地符合了上面的要求(可调用、接受一个字符串、返回一个异常实例)。例如: env.abort_exception = MyExceptionClass
。
abort_on_prompts
¶
Default: False
当这个值为 True
时,Fabric 将以非交互模式运行。此模式下,任何需要提示用户输入(如提示输入密码、询问连接到哪个主机、fabfile 中触发的 prompt
等等)时,都会调用 abort
。这就保证 Fabric 会话总是明确地中止,而不是在某些意外的情况下傻傻地等待用户输入。
1.1 新版功能.
always_use_pty
¶
Default: True
设置为 False
时, ~fabric.operations.run`/`~fabric.operations.sudo` 的行为会和使用 ``pty=False
参数调用一样。
参见
1.0 新版功能.
combine_stderr
¶
Default: True
使 SSH 层合并远程程序的 stdout 和 stderr 流输出,以避免它们在打印时混在一起。查看 合并 stdout 和 stderr 来了解为什么需要这个功能,以及它的实际效果。
1.0 新版功能.
command
¶
Default: None
fab
设置的正在执行的命令名称(例如,执行 $ fab task1 task2
命令,当执行 task1 时, env.command
会被设置为 “task1”
,然后设置为 “task2”
)。仅供显示。
dedupe_hosts
¶
Default: True
去除合并后的主机列表中的重复项,以保证一个主机只会出现一次。(例如,在同时使用 @hosts
和 @roles
,或 -H 和 -R 的时候。)
设置为 False 时不会去除重复项,这将允许用户显式地在同一台主机上将一个任务(并行地,当然也支持串行)运行多次。
1.5 新版功能.
disable_known_hosts
¶
Default: False
如果为 True
,SSH 层将不会加载用户的 know-hosts 文件。这样可以有效地避免当一个“已知主机”改变了 key、但仍然有效时(比如 EC2 这样的云服务器中)的异常。
eagerly_disconnect
¶
Default: False
设置为 True 时, fab
会在每个独立任务完成后关闭连接,而不是在整个运行结束后。这有助于避免大量无用的网络会话堆积,或因每个进程可打开的文件限制,或网络硬件的限制而引发问题。
注解
激活时,断开连接地信息会贯穿你的输出信息始终,而非最后。这一点可能会在以后的版本中得到改进。
fabfile
¶
Default: fabfile.py
fab
在加载 fabfile 时查找的文件名。要指定特定的 fabfile 文件,需要使用该文件的完整路径。显然,这个参数不可能在 fabfile 中设置,但可以将它设置在 .fabricrc 文件中,或者通过命令行参数来设置。
gateway
¶
Default: None
允许通过指定主机创建 SSH 驱动的网关。它的值应该是一个普通的 Fabric 主机串,和 env.host_string 中使用的一样。当它被设置时,新创建的连接将会通过这个远程 SSH 连接到最终的目的地。
1.5 新版功能.
参见
host_string
¶
Default: None
指定 Fabric 在执行 run
、 put
等命令时使用的用户/主机/端口。 fab
在与已设置的主机列表交互时设置这个值,将 Fabric 作为库使用时也可以手动设置它。
keepalive
¶
默认值: 0
(不保持连接)
用于指定 SSH keepalive 间隔的数字,基本上对应 SSH 设置参数 ServerAliveInterval
。如果有多事的网络硬件或者其它因素导致连接超时时会很有帮助。
参见
1.1 新版功能.
linewise
¶
Default: False
强制以行为缓冲区单位,以替换字符/比特,通常用在并行模式下。可以使用 --linewise
参数来激活。env.parallel 模式隐含了这项设置——即使 linewise
为 False,parallel
如果为 True 就会引发行级输出。
1.3 新版功能.
local_user
¶
一个包含本地系统用户名的只读值。该值即 user 的初始值,不过 user 可以通过 CLI 参数、Python 代码或者指定 host 字符串的方式覆盖,local_user 则会一直保持不变。
no_keys
¶
Default: False
如为 True
则告诉 SSH 层不从 $HOME/.ssh/
目录加载密钥。(当然,你可以显示地使用 fab -i
来指定密钥。)
0.9.1 新版功能.
参见
passwords
¶
Default: {}
这个字典主要用于内部使用,and is filled automatically as a per-host-string password cache。键是 host strings 全称,值为密码(字符串格式)。
警告
如果你手动生成该字典,就必须使用完整的主机登录字符,包括用户和登录信息。查看上面的链接以获取主机字符串 API 的详细信息。
1.0 新版功能.
path
¶
Default: ''
用于执行 run
/sudo
/local
等命令时设置 shell 环境变量 $PATH
。推荐使用上下文管理器 path
来管理该值,不建议手动设置。
1.0 新版功能.
remote_interrupt
¶
Default: None
用于设置 Ctrl-C 是用于终止远程命令还是在本地捕获。使用如下:
None
(默认值):只有open_shell
会向远程发送终止命令,run
/sudo
会在本地捕获。False
:即使open_shell
也只在本地捕获。True
:所有函数都可以向远程发送终止命令。
1.6 新版功能.
shell
¶
Default: /bin/bash -l -c
在使用 run
等命令时会使用到,作为 shell 包裹在程序外。该值会像这样使用 <env.shell> "<command goes here>"
——比如默认的 Bash -c
选项可以接受命令字符串作为其参数。
sudo_prefix
¶
Default: "sudo -S -p '%(sudo_prompt)s' " % env
sudo
命令调用时的 sudo
命令前缀。如果用户在远程主机默认 $PATH``上没有 ``sudo
,或者需要一些其它设置时(比如应用无密码的 sudo 时删除 -p
参数),会需要它。
参见
user
¶
Default: 用户的默认用户名
SSH 层连接远程服务器时用到的用户名,可以设置为全局,在不显式指定的情况下都会被应用于主机连接字符串。不过,如果显式指定了,它将被临时覆盖为该值——例如,它可以永远是连接时使用的用户。
下面我们使用一个 fabfile 来模拟一下:
from fabric.api import env, run
env.user = 'implicit_user'
env.hosts = ['host1', 'explicit_user@host2', 'host3']
def print_user():
with hide('running'):
run('echo "%(user)s"' % env)
用于:
$ fab print_user
[host1] out: implicit_user
[explicit_user@host2] out: explicit_user
[host3] out: implicit_user
Done.
Disconnecting from host1... done.
Disconnecting from host2... done.
Disconnecting from host3... done.
如你所见,在 host2
上运行时 env.user
被设置为了 "explicit_user"
,但是之后又重新设置为原来的值("implicit_user"
)。
注解
``env.user``的使用有点让人困惑(它同时用于设置 和 信息展示目的),因此未来可能会对其进行修改——信息展示可能会另外采取一个新的 env 变量。