引言
Abstract Syntax Trees即抽象語法樹。 Ast是python原始碼到字節碼的一種中間產物，借助ast模組可以從語法樹的角度分析原始碼結構。
此外，我們不但可以修改和執行語法樹，還可以將Source產生的語法樹unparse成python原始碼。因此ast為python原始碼檢查、語法分析、修改程式碼以及程式碼調試等留下了足夠的發揮空間。
1. AST簡介
Python官方提供的CPython解釋器對python原始碼的處理過程如下：
Parse source code into a parse tree (Parser/ pgen.c)
Transform parse tree into an Abstract Syntax Tree (Python/ast.c)
Transform AST into a Control Flow Graph (Python/compile.c)
Emit bytecode based on the Control Flow Graph (Python/compile.c)
即實際python程式碼的處理過程如下：
原始程式碼解析--> 語法樹- -> 抽象語法樹(AST) --> 控制流程圖--> 字節碼
上述流程在python2.5之後被應用。 python原始碼首先被解析成語法樹，隨後又轉換成抽象語法樹。在抽象語法樹中我們可以看到原始碼檔案中的python的語法結構。
大部分時間程式設計可能不需要用到抽象語法樹，但是在特定的條件和需求的情況下，AST又有其特殊的方便性。
下面是一個抽象語法的簡單實例。
Module(body=[
Print(
dest=None,
values=[BinOp( left=Num(n=1),op=Add(),right=Num(n=2))],
nl=True,
)])登入後複製
2. 建立AST
2.1 Compile函數
#先簡單了解compile函數。
compile(source, filename, mode[, flags[, dont_inherit]])
source -- 字串或AST（Abstract Syntax Trees）物件。一般可將整個py檔案內容file.read()傳入。
filename -- 程式碼檔案名稱，如果不是從檔案讀取程式碼則傳遞一些可辨識的值。
mode -- 指定編譯程式碼的種類。可以指定為 exec, eval, single。
flags -- 變數作用域，局部命名空間，如果被提供，可以是任何映射物件。
flags和dont_inherit是用來控制編譯原始碼時的標誌。
func_def = \
"""
def add(x, y):
return x + y
print add(3, 5)
"""登入後複製
使用Compile編譯並執行：
>>> cm = compile(func_def, '<string>', 'exec')
>>> exec cm
>>> 8
登入後複製
上面func_def經過compile編譯得到字節碼，cm即code對象，
# True == isinstance(cm, types.CodeType)。
compile(source, filename, mode, ast.PyCF_ONLY_AST) <==> ast.parse(source, filename='', mode='exec' )
2.2 產生ast
使用上面的func_def產生ast.
r_node = ast.parse(func_def)
print astunparse.dump(r_node) # print ast.dump(r_node)
登入後複製
下面是func_def對應的ast結構：
Module(body=[
FunctionDef(
name='add',
args=arguments(
args=[Name(id='x',ctx=Param()),Name(id='y',ctx=Param())],
vararg=None,
kwarg=None,
defaults=[]),
body=[Return(value=BinOp(
left=Name(id='x',ctx=Load()),
op=Add(),
right=Name(id='y',ctx=Load())))],
decorator_list=[]),
Print(
dest=None,
values=[Call(
func=Name(id='add',ctx=Load()),
args=[Num(n=3),Num(n=5)],
keywords=[],
starargs=None,
kwargs=None)],
nl=True)
])登入後複製
除了ast .dump，有許多dump ast的第三方函式庫，如astunparse, codegen, unparse等。這些第三方函式庫不僅能夠以更好的方式展示出ast結構，還能夠將ast反向導出python source程式碼。
module Python version "$Revision$"
{
mod = Module(stmt* body)| Expression(expr body)
stmt = FunctionDef(identifier name, arguments args, stmt* body, expr* decorator_list)
| ClassDef(identifier name, expr* bases, stmt* body, expr* decorator_list)
| Return(expr? value)
| Print(expr? dest, expr* values, bool nl)| For(expr target, expr iter, stmt* body, stmt* orelse)
expr = BoolOp(boolop op, expr* values)
| BinOp(expr left, operator op, expr right)| Lambda(arguments args, expr body)| Dict(expr* keys, expr* values)| Num(object n) -- a number as a PyObject.
| Str(string s) -- need to specify raw, unicode, etc?| Name(identifier id, expr_context ctx)
| List(expr* elts, expr_context ctx)
-- col_offset is the byte offset in the utf8 string the parser uses
attributes (int lineno, int col_offset)
expr_context = Load | Store | Del | AugLoad | AugStore | Param
boolop = And | Or
operator = Add | Sub | Mult | Div | Mod | Pow | LShift | RShift | BitOr | BitXor | BitAnd | FloorDiv
arguments = (expr* args, identifier? vararg, identifier? kwarg, expr* defaults)
}登入後複製
上面是部分摘自官網的 Abstract Grammar，實際遍歷ast Node過程中根據Node的類型存取其屬性。
3. 遍歷AST
python提供了兩種方式來遍歷整個抽象語法樹。
3.1 ast.NodeTransfer
將func_def中的add函數中的加法運算改為減法，同時為函數實作新增呼叫日誌。
class CodeVisitor(ast.NodeVisitor):
def visit_BinOp(self, node):
if isinstance(node.op, ast.Add):
node.op = ast.Sub()
self.generic_visit(node)
def visit_FunctionDef(self, node):
print 'Function Name:%s'% node.name
self.generic_visit(node)
func_log_stmt = ast.Print(
dest = None,
values = [ast.Str(s = 'calling func: %s' % node.name, lineno = 0, col_offset = 0)],
nl = True,
lineno = 0,
col_offset = 0,
)
node.body.insert(0, func_log_stmt)
r_node = ast.parse(func_def)
visitor = CodeVisitor()
visitor.visit(r_node)
# print astunparse.dump(r_node)
print astunparse.unparse(r_node)
exec compile(r_node, '<string>', 'exec')登入後複製
運行結果：
Function Name:add
def add(x, y):
print 'calling func: add'
return (x - y)
print add(3, 5)
calling func: add
-2登入後複製
3.2 ast.NodeTransformer
使用NodeVisitor主要是透過修改語法樹上節點的方式改變AST結構，NodeTransformer主要是替換ast中的節點。
既然func_def中定義的add已經被改成一個減函數了，那麼我們就徹底一點，把函數名和參數以及被調用的函數都在ast中改掉，並且將添加的函數調用log寫的更加複雜一些，爭取改的面目全非：-）
class CodeTransformer(ast.NodeTransformer):
def visit_BinOp(self, node):
if isinstance(node.op, ast.Add):
node.op = ast.Sub()
self.generic_visit(node)
return node
def visit_FunctionDef(self, node):
self.generic_visit(node)
if node.name == 'add':
node.name = 'sub'
args_num = len(node.args.args)
args = tuple([arg.id for arg in node.args.args])
func_log_stmt = ''.join(["print 'calling func: %s', " % node.name, "'args:'", ", %s" * args_num % args])
node.body.insert(0, ast.parse(func_log_stmt))
return node
def visit_Name(self, node):
replace = {'add': 'sub', 'x': 'a', 'y': 'b'}
re_id = replace.get(node.id, None)
node.id = re_id or node.id
self.generic_visit(node)
return node
r_node = ast.parse(func_def)
transformer = CodeTransformer()
r_node = transformer.visit(r_node)
# print astunparse.dump(r_node)
source = astunparse.unparse(r_node)
print source
# exec compile(r_node, '<string>', 'exec') # 新加入的node func_log_stmt 缺少lineno和col_offset属性
exec compile(source, '<string>', 'exec')
exec compile(ast.parse(source), '<string>', 'exec')登入後複製
結果：
def sub(a, b):
print 'calling func: sub', 'args:', a, b
return (a - b)
print sub(3, 5)
calling func: sub args: 3 5
-2
calling func: sub args: 3 5
-2登入後複製
程式碼中能夠清楚的看到兩者的差異。這裡不再贅述。
4.AST應用
AST模組實際程式設計中很少用到，但是作為一種原始碼輔助檢查手段是非常有意義的；語法檢查，調試錯誤，特殊字段檢測等。
上面透過為函數加入呼叫日誌的資訊是一種調試python原始碼的一種方式，不過實際中我們是透過parse整個python檔案的方式遍歷修改原始碼。
4.1 漢字偵測
下面是中日韓字元的unicode編碼範圍
CJK Unified Ideographs
#Range : 4E00— 9FFF
Number of characters: 20992
Languages: chinese, japanese, korean, vietnamese
使用unicode 範圍ff##u4fffff 來判別漢字，注意這個範圍並不包含中文字符(e.g. u'；' == u'\uff1b') .
下面是一個判斷字串中是否包含中文字符的一個類CNCheckHelper：
class CNCheckHelper(object):
# 待检测文本可能的编码方式列表
VALID_ENCODING = ('utf-8', 'gbk')
def _get_unicode_imp(self, value, idx = 0):
if idx < len(self.VALID_ENCODING):
try:
return value.decode(self.VALID_ENCODING[idx])
except:
return self._get_unicode_imp(value, idx + 1)
def _get_unicode(self, from_str):
if isinstance(from_str, unicode):
return None
return self._get_unicode_imp(from_str)
def is_any_chinese(self, check_str, is_strict = True):
unicode_str = self._get_unicode(check_str)
if unicode_str:
c_func = any if is_strict else all
return c_func(u'\u4e00' <= char <= u'\u9fff' for char in unicode_str)
return False登入後複製
介面is_any_chinese有兩種判斷模式，嚴格偵測只要包含中文字串就可以檢查出，非嚴格必須全部包含中文。
下面我们利用ast来遍历源文件的抽象语法树，并检测其中字符串是否包含中文字符。
class CodeCheck(ast.NodeVisitor):
def __init__(self):
self.cn_checker = CNCheckHelper()
def visit_Str(self, node):
self.generic_visit(node)
# if node.s and any(u'\u4e00' <= char <= u'\u9fff' for char in node.s.decode('utf-8')):
if self.cn_checker.is_any_chinese(node.s, True):
print 'line no: %d, column offset: %d, CN_Str: %s' % (node.lineno, node.col_offset, node.s)
project_dir = './your_project/script'
for root, dirs, files in os.walk(project_dir):
print root, dirs, files
py_files = filter(lambda file: file.endswith('.py'), files)
checker = CodeCheck()
for file in py_files:
file_path = os.path.join(root, file)
print 'Checking: %s' % file_path
with open(file_path, 'r') as f:
root_node = ast.parse(f.read())
checker.visit(root_node)登入後複製
上面这个例子比较的简单，但大概就是这个意思。
关于CPython解释器执行源码的过程可以参考官网描述：PEP 339
4.2 Closure 检查
一个函数中定义的函数或者lambda中引用了父函数中的local variable，并且当做返回值返回。特定场景下闭包是非常有用的，但是也很容易被误用。
关于python闭包的概念可以参考我的另一篇文章：理解Python闭包概念
这里简单介绍一下如何借助ast来检测lambda中闭包的引用。代码如下：
class LambdaCheck(ast.NodeVisitor):
def __init__(self):
self.illegal_args_list = []
self._cur_file = None
self._cur_lambda_args = []
def set_cur_file(self, cur_file):
assert os.path.isfile(cur_file)， cur_file
self._cur_file = os.path.realpath(cur_file)
def visit_Lambda(self, node):
"""
lambda 闭包检查原则：
只需检测lambda expr body中args是否引用了lambda args list之外的参数
"""
self._cur_lambda_args =[a.id for a in node.args.args]
print astunparse.unparse(node)
# print astunparse.dump(node)
self.get_lambda_body_args(node.body)
self.generic_visit(node)
def record_args(self, name_node):
if isinstance(name_node, ast.Name) and name_node.id not in self._cur_lambda_args:
self.illegal_args_list.append((self._cur_file, 'line no:%s' % name_node.lineno, 'var:%s' % name_node.id))
def _is_args(self, node):
if isinstance(node, ast.Name):
self.record_args(node)
return True
if isinstance(node, ast.Call):
map(self.record_args, node.args)
return True
return False
def get_lambda_body_args(self, node):
if self._is_args(node): return
# for cnode in ast.walk(node):
for cnode in ast.iter_child_nodes(node):
if not self._is_args(cnode):
self.get_lambda_body_args(cnode)登入後複製
遍历工程文件：
project_dir = './your project/script'
for root, dirs, files in os.walk(project_dir):
py_files = filter(lambda file: file.endswith('.py'), files)
checker = LambdaCheck()
for file in py_files:
file_path = os.path.join(root, file)
checker.set_cur_file(file_path)
with open(file_path, 'r') as f:
root_node = ast.parse(f.read())
checker.visit(root_node)
res = '\n'.join([' ## '.join(info) for info in checker.illegal_args_list])
print res登入後複製
由于Lambda(arguments args, expr body)中的body expression可能非常复杂，上面的例子中仅仅处理了比较简单的body expr。可根据自己工程特点修改和扩展检查规则。为了更加一般化可以单独写一个visitor类来遍历lambda节点。
以上是Python Ast抽象語法樹該如何使用？的詳細內容。更多資訊請關注PHP中文網其他相關文章！
