【Python CI】圈复杂度 lizard

绝地灬酷狼 2023-02-17 11:26 7阅读 0赞

## 1. 圈复杂度 ##

#### 1.1 什么是圈复杂度？ ####

> 引用\[1\]  
> 圈复杂度是 Thomas J. McCabe 在 1976年开创的软件指标，用来判断程序的复杂度。这个指标度量源代码中线性独立的路径或分支的数量。根据 McCabe 所说，一个方法的复杂度最好保持在10 以下。这是因为对人类记忆力的研究表明，人的短期记忆只能存储 7 件事（偏差为正负 2）。
> 
> 如果开发人员编写的代码有 50 个线性独立的路径，那么为了在头脑中描绘出方法中发生的情况，需要的记忆力大约超过短期记忆容量的 5倍。简单的方法不会超过人的短期记忆力的极限，因此更容易应付，事实证明它们的错误更少。Enerjy 在 2008年所做的研究表明，在圈复杂度与错误数量之间有很强的相关性。复杂度为 11 的类的出错概率为 0.28，而复杂度为 74的类的出错概率会上升到 0.98。

#### 1.2 计算原理 ####

TODO

## 2. lizard ##

**Git源码链接** [https://github.com/terryyin/lizard][https_github.com_terryyin_lizard]

*  默认递归分析文件夹
 *  支持15中开发语言： C/C++ (works with C++14)； Java； C\# (C Sharp)； JavaScript (With ES6 and JSX)； Objective-C； Swift； `Python`； Ruby； TTCN-3； PHP； Scala； GDScript；Golang； Lua； Rust

#### 2.1 依赖安装 ####

**方式一 pip安装**

pip install lizard

**方式二 源码安装**

python setup.py install --install-dir=/path/to/installation/directory/

**方式三 直接运行**  
直接将`lizard.py`及依赖的目录移动到待检测的文件目录中， 直接在命令行中运行以下命令，控制台数据结果表格

python lizard.py

#### 2.2 使用 ####

**命令行使用**

lizard [options] [PATH or FILE] [PATH] ...
    # 示例 检测某目录下 除 tests目录下 Python文件
    lizard mySource/ -x"./tests/*" -l python
    
    -h, --help            显示帮助并退出
    --version             显示当前lizard版本并退出
    -l LANGUAGES, --languages LANGUAGES
                          开发语言列表， 检测支持的开发语言 例如：lizard -l cpp -l java
                          支持语言：cpp, csharp, java, javascript, objectivec, php, python, ruby, swift, ttcn
    -V, --verbose         Output in verbose mode (long function name)
    -C CCN, --CCN CCN     Threshold for cyclomatic complexity number warning.
                          The default value is 15. Functions with CCN bigger
                          than it will generate warning
    -L LENGTH, --length LENGTH
                          Threshold for maximum function length warning. The
                          default value is 1000. Functions length bigger than it
                          will generate warning
    -a ARGUMENTS, --arguments ARGUMENTS
                          Limit for number of parameters
    -w, --warnings_only   Show warnings only, using clang/gcc's warning format for printing warnings. http://clang.llvm.org/docs/UsersManual.html#cmdoption- fdiagnostics-format -i NUMBER, --ignore_warnings NUMBER If the number of warnings is equal or less than the number, the tool will exit normally, otherwise it will generate error. Useful in makefile for legacy code. -x EXCLUDE, --exclude EXCLUDE 不检测文件 Exclude files that match this pattern. * matches everything, ? matches any single character, "./folder/*" exclude everything in the folder recursively. Multiple patterns can be specified. Don't
                          forget to add "" around the pattern.
    --csv                 Generate CSV output as a transform of the default
                          output
    -X, --xml             Generate XML in cppncss style instead of the tabular
                          output. Useful to generate report in Jenkins server
    -t WORKING_THREADS, --working_threads WORKING_THREADS
                          number of working threads. The default value is 1.
                          Using a bigger number can fully utilize the CPU and
                          often faster.
    -m, --modified        Calculate modified cyclomatic complexity number,
                          which count a switch/case with multiple cases as
                          one CCN.
    -E EXTENSIONS, --extension EXTENSIONS
                          User the extensions. The available extensions are:
                          -Ecpre: it will ignore code in the #else branch.
                          -Ewordcount: count word frequencies and generate tag
                          cloud. -Eoutside: include the global code as one
                          function.
    -s SORTING, --sort SORTING
                          Sort the warning with field. The field can be nloc,
                          cyclomatic_complexity, token_count, parameter_count,
                          etc. Or an customized file.
    -W WHITELIST, --whitelist WHITELIST  白名单
                          The path and file name to the whitelist file. It's './whitelizard.txt' by default.

#### 结果解读 ####

NLOC    the nloc (lines of code without comments),
    CCN     cyclomatic complexity number
    token   token count of functions.
    param   parameter count of functions.

**结果样例**

================================================== ============
      NLOC CCN令牌参数function @ line @ file
    -------------------------------------------------- ------------
        10 2 29 2 start_new_player @ 26 @。/ html_game.c
       ...
         6 1 3 0 set_shutdown_flag @ 449 @。/ httpd.c
        24 3 61 1 server_main @ 454 @。/ httpd.c
    -------------------------------------------------- ------------
    2文件分析。
    ================================================== ============
    LOC Avg.NLOC AvgCCN Avg.ttoken function_cnt文件
    -------------------------------------------------- ------------
        191 15 3 51 12 ./html_game.c
        363 24 4 86 15 ./httpd.c
    
    =====================================
    !!!! 警告（CCN> 15）!!!!
    =====================================
        66 19 247 1 accept_request @ 64 @。/ httpd.c
    ================================================== ==============================
    NLOC平均总NLOC平均CCN平均代币Fun Cnt警告cnt Fun Rt NLOC Rt
    -------------------------------------------------- ------------------------------
           554 20 4.07 71.15 27 1 0.04 0.12

#### 更多用法： ####

*  白名单设置
 *  CNN阈值设置
 *  重复代码检测

#### 2.\* Jenkins中配置 ####

TODO

## 3. PyCmetrics ##

TODO

## 4.pygenie ##

TODO

## 5. 圈复杂度优化建议 ##

*  尽量少用 if …else … ，等分支语句
 *  每个函数要有明确的功能实现，不要为了追求行数少而合并功能实现
 *  模型数据的赋值、校验最好放在 model 自己里面
 *  逻辑模块和数据模块要区分开编写

## 引用 ##

\[1\] [用 Python 编写干净、可测试、高质量的代码][Python]

[https_github.com_terryyin_lizard]: https://github.com/terryyin/lizard
[Python]: https://www.ibm.com/developerworks/cn/aix/library/au-cleancode/#artrelatedtopics