??想了解更多關(guān)于開源的內(nèi)容，請訪問：??
??51CTO 開源基礎(chǔ)軟件社區(qū)??
??https://ost.51cto.com??
hb命令可以通過python pip包管理器進行安裝，應(yīng)該是OpenHarmony Build的縮寫，在python包名稱是ohos-build。hb作為編譯構(gòu)建子系統(tǒng)提供的命令行，用于編譯構(gòu)建產(chǎn)品、芯片廠商組件或者單個組件。本文，我們來學(xué)習(xí)hb的源碼。
1、hb的安裝、卸載與簡單介紹
在源碼根目錄下執(zhí)行下述命令可以進行安裝。
python3 -m pip install --user build/lite
執(zhí)行hb -h有相關(guān)幫助信息，有打印信息即表示安裝成功：
usage: -c [-h] [-v] {build,set,env,clean,tool} ...
OHOS Build System version 0.4.6
positional arguments:
{build,set,env,clean,tool}
build Build source code
set OHOS build settings
env Show OHOS build env
clean Clean output
tool Call the gn command through the hb tool
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit需要注意的是，需要在OpenHarmony的源代碼目錄下才能執(zhí)行hb命令，否則會提示：hb_error: Please call hb utilities inside source root directory。后文源碼分析時，會講述為啥要在源碼目錄下才能執(zhí)行該hb。
卸載方法，執(zhí)行下述命令即可：
python3 -m pip uninstall ohos-build
另外，需要了解的一個比較好用的命令，如下，可以查看安裝的python包的信息：
python3 -m pip show ohos-build
執(zhí)行后，輸出如下信息。比較關(guān)鍵的是，可以知道hb命令對應(yīng)源文件的安裝位置在...lib/python3.8/site-packages。。hb命令工具的位置可以通過which hb來查看。
zhushangyuan@DESKTOP-RPE9R4O:~$ python3 -m pip show ohos-build
Name: ohos-build
Version: 0.4.6
Summary: OHOS build command line tool
Home-page: https://gitee.com/openharmony/build_lite
Author: Huawei
Author-email: contact@openharmony.io
License: Apache 2.0
Location: /home/zhushangyuan/.local/lib/python3.8/site-packages
Requires: kconfiglib, prompt-toolkit, PyYAML, requests
Required-by:
在文件夾...lib/python3.8/site-packages/hb有3個文件，__init__.py是空文件表示python模塊，__main__.py是執(zhí)行入口文件，__entry__.py事實上并沒有使用到。這3個文件和目錄build/lite/hb下的文件是一模一樣的。
zhushangyuan@DESKTOP-RPE9R4O:~$ ll /home/zhushangyuan/.local/lib/python3.8/site-packages/hb/
total 20
drwxr-xr-x 3 zhushangyuan zhushangyuan 4096 Oct 25 20:36 ./
drwx------ 33 zhushangyuan zhushangyuan 4096 Oct 25 20:36 ../
-rw-r--r-- 1 zhushangyuan zhushangyuan 3629 Oct 25 20:56 __entry__.py
-rw-r--r-- 1 zhushangyuan zhushangyuan 0 Oct 25 20:36 __init__.py
-rw-r--r-- 1 zhushangyuan zhushangyuan 2204 Oct 25 20:36 __main__.py
2、hb源碼分析
通過which hb來查看hb命令工具的位置，我的環(huán)境上，位置為~/.local/bin/hb，該文件是通過pip安裝的，其實是個python文件。我們來查看其文件內(nèi)容。⑴處導(dǎo)入的main函數(shù)來自...lib/python3.8/site-packages/hb/__main__.py。⑵處sys.argv[0]指的是執(zhí)行的程序名稱，這里等于hb，該語句表示以-script.pyw或者.exe結(jié)尾的部分去除，例如，假設(shè)sys.argv[0]為test-script.pyw，則替換后的sys.argv[0]為test。使用pip安裝的包通常都是這樣的寫法。
zhushangyuan@DESKTOP-RPE9R4O:~/openharmony$ cat ~/.local/bin/hb
#!/usr/bin/python3
# -*- coding: utf-8 -*-
import re
import sys
⑴ from hb.__main__ import main
if __name__ == '__main__':
⑵ sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
sys.exit(main())
接下來，我們來分析下源文件...lib/python3.8/site-packages/hb/__main__.py。
zhushangyuan@DESKTOP-RPE9R4O:~/openharmony$ cat /home/zhushangyuan/.local/lib/python3.8/site-packages/hb/__main__.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (c) 2022 Huawei Device Co., Ltd.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import os
import sys
VERSION = "0.4.6"
# execv execution fragment
EXECV_FRAGMENT = """
import sys
import importlib
sys.path.append(sys.argv.pop())
entry = importlib.import_module("__entry__")
sys.exit(entry.main())
"""
def find_top():
cur_dir = os.getcwd()
while cur_dir != "/":
hb_internal = os.path.join(cur_dir, 'build/lite/hb_internal')
if os.path.exists(hb_internal):
return cur_dir
cur_dir = os.path.dirname(cur_dir)
raise Exception("Please call hb utilities inside source root directory")
def search(findir, target):
for root, dirs, files in os.walk(findir):
if target in files:
return root
def main():
try:
topdir = find_top()
except Exception as ex:
return print("hb_error: Please call hb utilities inside source root directory")
python_base_dir = os.path.join(topdir, 'prebuilts/python')
if os.path.exists(python_base_dir):
python_dir = search(python_base_dir, 'python3')
python_executable = os.path.join(python_dir, 'python3')
lite_dir = os.path.join(topdir, 'build/lite')
hb_dir = search(lite_dir, '__entry__.py')
param_list = ["python3", "-c", EXECV_FRAGMENT]
for arg in sys.argv[1:]:
param_list.append(arg)
param_list.append(hb_dir)
os.environ['PATH'] = python_dir + ":" + os.getenv('PATH')
os.execv(python_executable, param_list)
else:
print("please execute build/prebuilts_download.sh")
if __name__ == "__main__":
sys.exit(main())
（1）hb/main.py 動態(tài)執(zhí)行python代碼片段EXECV_FRAGMENT
python -c?命令可以直接在命令行中調(diào)用python代碼, 實際上-c?就是command?的意思，就是python -c?可以在命令行中執(zhí)行python代碼, 跟把代碼放置在.py文件中，然后運行這個文件是一樣的效果。
__main__.py?文件中會動態(tài)執(zhí)行python代碼片段如下，解釋下⑴處的代碼。當我們導(dǎo)入一個模塊時：import XXX，默認情況下python解釋器會搜索當前目錄、已安裝的內(nèi)置模塊和第三方模塊，如果都搜索不到，則會報錯。我們的搜索路徑存放在sys模塊中的path中，sys.path是當前路徑的一個列表。[即默認路徑可以通過sys.path來打印查看]。當我們要添加自己的引用模塊搜索目錄時，可以通過list的append方法。sys.argv.pop()表示參數(shù)列表中的最后一項，指的是?openharmony\build\lite\hb\目錄，下文會詳細解釋。
⑵處動態(tài)導(dǎo)入模塊對象，"entry"指的是openharmony\build\lite\hb\__entry__.py?。所以，我們只使用到了openharmony\build\lite\hb\__entry__.py?，而不是使用python3.8/site-packages/hb/__entry__.py.py。
EXECV_FRAGMENT = """
import sys
import importlib
⑴ sys.path.append(sys.argv.pop())
⑵ entry = importlib.import_module("__entry__")
sys.exit(entry.main())
"""
（2）hb/main.py find_top()函數(shù)
find_top()函數(shù)用于獲取OpenHarmony源代碼根目錄。⑴處先獲取當前工作目錄，hb命令在哪個目錄下執(zhí)行，就是當前的工作目錄。⑵處開始while循環(huán)，結(jié)束條件是遍歷到系統(tǒng)根目錄或者return返回。⑶處判斷是否存在目錄’build/lite/hb_internal’，如果存在，即可獲得OpenHarmony源碼根目錄。如果不存在，則執(zhí)行⑷獲取上一級目錄，繼續(xù)循環(huán)。遍歷的目錄不存在’build/lite/hb_internal’目錄，則拋出異常。從這些源碼可知，hb不能在非OpenHarmony源代碼目錄下執(zhí)行，但又可以在OpenHarmony源碼目錄下的任何一個目錄執(zhí)行。
def find_top():
⑴ cur_dir = os.getcwd()
⑵ while cur_dir != "/":
hb_internal = os.path.join(cur_dir, 'build/lite/hb_internal')
⑶ if os.path.exists(hb_internal):
return cur_dir
⑷ cur_dir = os.path.dirname(cur_dir)
raise Exception("Please call hb utilities inside source root directory")
（3）hb/main.py search()函數(shù)
search()函數(shù)從指定的目錄下查詢是否存在指定的文件，如果存在，則返回包含指定文件的目錄路徑。代碼如下，這代碼也容易被挑戰(zhàn)。對于不存在指定文件的情況下，就沒有return語句，這樣代碼不規(guī)范。
def search(findir, target):
for root, dirs, files in os.walk(findir):
if target in files:
return root
（4）hb/main.py main()函數(shù)
接下來，我們來看下main()函數(shù)。首先調(diào)用find_top()函數(shù)獲得OpenHarmony源碼根目錄。⑴處判斷是否存在文件’prebuilts/python’，如果不存在則打印，告知開發(fā)者需要"please execute build/prebuilts_download.sh"來完成環(huán)境準備。⑵處開始，獲取4個變量的值，如下表：
變量
| 值
| 說明
|
python_dir
| openharmony/prebuilts/python/linux-x86/3.9.2/bin
| 包含python3執(zhí)行文件的目錄
|
python_executable
| openharmony/prebuilts/python/linux-x86/3.9.2/bin/python3
| python3執(zhí)行文件路徑
|
lite_dir
| openharmony/build/lite
| build lite目錄
|
hb_dir
| openharmony/build/lite/hb
| __entry__.py所在的目錄
|
⑶處封裝要參數(shù)列表，要動態(tài)執(zhí)行的腳本EXECV_FRAGMENT，已經(jīng)在前文解釋。⑷處把命令行執(zhí)行hb命令時傳入的參數(shù)，添加到param_list變量，⑸處最后添加的參數(shù)是__entry__.py所在的目錄。在解釋動態(tài)執(zhí)行python代碼片段EXECV_FRAGMENT時，提到的sys.argv.pop()就是剛剛添加的這個目錄。接下來，⑹處的代碼設(shè)置環(huán)境變量，然后調(diào)用函數(shù)os.execv來執(zhí)行。后文再詳細分析__entry__.py。
def main():
try:
topdir = find_top()
except Exception as ex:
return print("hb_error: Please call hb utilities inside source root directory")
python_base_dir = os.path.join(topdir, 'prebuilts/python')
⑴ if os.path.exists(python_base_dir):
⑵ python_dir = search(python_base_dir, 'python3')
python_executable = os.path.join(python_dir, 'python3')
lite_dir = os.path.join(topdir, 'build/lite')
hb_dir = search(lite_dir, '__entry__.py')
⑶ param_list = ["python3", "-c", EXECV_FRAGMENT]
⑷ for arg in sys.argv[1:]:
param_list.append(arg)
⑸ param_list.append(hb_dir)
⑹ os.environ['PATH'] = python_dir + ":" + os.getenv('PATH')
os.execv(python_executable, param_list)
else:
print("please execute build/prebuilts_download.sh")
3、參考站點
4、小結(jié)
本文介紹了build lite 輕量級編譯構(gòu)建系統(tǒng)hb命令的源碼，主要分析了__main__.py文件
??想了解更多關(guān)于開源的內(nèi)容，請訪問：??
??51CTO 開源基礎(chǔ)軟件社區(qū)??
??https://ost.51cto.com??。
