TudouBaba.net

# Python 脚本的第一行代码

shebang.png

在 Python 脚本的第一行经常见到这样的注释: #!/usr/bin/env python3 或者 #!/usr/bin/python3

# 含义

在脚本中, 第一行以 #! 开头的代码, 在计算机行业中叫做 "shebang (opens new window)", 也叫做 sha-bang / hashbang / pound-bang / hash-pling, 其作用是"指定由哪个解释器来执行脚本".

# 为什么要指定解释器?

举个例子, 很多人在系统中同时安装了 Python2 和 Python3, 但是 2 和 3 是不兼容的, 所以执行脚本时必须指定解释器.

再比如说, Unix 系统中一般同时安装了多个版本的 Shell, 比如常用的 bash、sh 和 现代的 zsh, 但是这些 shell 的语法并不完全相同, 所以也需要指定解释器.

# 如何指定解释器?

一. 如果是通过命令行 (shell) 执行脚本:

  • 1. 在 "Unix -like 系统"中 (比如服务器常用的 CentOS, 或者苹果的 OS X)

    • 用命令行执行脚本时, 指定解释器: python3 ./my_script.py;

    • 也可以在脚本内, 通过 shebang 指定解释器. 比如想让 Python3 解释器来执行脚本, 那么, 在 Python 脚本的第一行写上 #!/usr/bin/python3 或者是 #!/usr/bin/env python3, 然后用命令行直接调用文件 -- ./my_script.py, shell 会检查脚本的第一行代码, 发现有 shebang, 会按其指定的解释器来执行;

    • 如果上面两种方式是冲突的, 比如在 shebang 中指定 python3, 但是命令行执行时指定 Python2 -- python2 ./my_script.py, 结果会如何? 结果是**"命令行指定"比 "shebang 指定"更优先**. 下面是试验:

      文件名为 diff_interpreter.py 的 Python 脚本, 其代码指定了 Python 3:

      #!/usr/bin/env python3
print(3/2)
      1
      2

      在命令行调用时, 分别指定 Python 2 和 Python 3, 执行结果如下: output_of_command.jpg

  • 2. 在"非 Unix-like 系统"中

二. 如果是在图形界面, 通过双击文件来执行脚本:

系统会根据该文件类型设定的软件打开. 比如 Windows, 会根据文件扩展名来决定打开方式. 如果你之前设置了 *.py 后缀的文件用 python3 的软件打开, 双击时就会用 python3 打开. 如果碰到 python 2.x 的脚本, 则需要右键更改"打开方式".

OS X 也是如此.

# 为什么选用 #! 作为 Shebang 的标志符?

因为大部分的编程语言把 # 开头的代码解释为注释.

即使某种语言不是以 # 作为注释的标志符, 由于 shebang 的流行, 其解释器对于首行以#!开头的内容, 也会识别出这是 shebang, 从而忽略这一行.

# 如何使用 Shebang 指定 Python 解释器?

可以在脚本第一行写上 #!/usr/bin/env python3 或者 #!/usr/bin/python3:

  • #!/usr/bin/python3 表示 python3 解释器所处的绝对路径就是 /usr/bin/python3, 路径被写死了, 类似于编程中的"硬编码". 之所以有这种写法, 是因为在类 Unix 系统中, python 解释器一般情况下都位于这个路径. 不过, 如果碰到 python 解释器不在该路径下的话, 脚本就无法执行了!
  • #!/usr/bin/env/ python3 表示从 "PATH 环境变量"中查找 python3 解释器的位置, 路径没有被写死, 而是在"环境变量"中寻找 python3 解释器的安装路径, 再调用该路径下的解释器来执行脚本.

显然, 采用 #!/usr/bin/env python3 的写法更灵活更具有通用性, 推荐使用这种写法.

# 如何使用 Shebang 指定 shell 解释器?

使用 shebang:

  • #!/bin/sh 表示用 Bourne shell 来执行. 如果系统中没有 sh, 会选择兼容的 shell 解释器
  • #!/bin/bash 表示用 Bash shell 来执行. 如果系统中没有 bash, 会选择兼容的 shell 解释器

# 注意

  • #!之后的空格是可选的, #!/usr/bin/env python3 和 #! /usr/bin/env python3 这两种写法都是允许的
  • 大部分 Python 文件不必写 Shebang, 只有被直接执行的文件才有必要加入 Shebang

# 题外

Python 脚本开头经常见到这样的代码:

#!/usr/bin/env python
#coding=utf-8
1
2

之所以写 #coding=utf-8 是为了指定字符编码.

为什么要指定字符编码?

因为 Python 2 默认使用的是 ASCII 编码 (不支持中文), Python 3 默认使用 UTF-8 编码 (万国码, 支持中文).

所以 Python 2 中为了支持中文, 都会在开头加入 #coding=utf-8 这个声明. 而 Python 3 默认支持 UTF-8 编码, 所以 Python 3 并不需要 #coding=utf-8 声明

注意: 常见的写法有: #coding=utf-8 和 #! -*- coding:utf-8 -*-, 都是合法有效的 但是, coding 和 =之间, 或者coding 和 :之间, 不能有空格!

关于编码问题, 可以参考我的另一篇文章 -- 《Python 的编码问题》 (opens new window)

# 参考文章

← 编程语言的注释 →