Metadata-Version: 1.1
Name: lizard
Version: 1.7.9
Summary:  
A simple code complexity analyzer without caring about the C/C++ header files or Java imports.
It can deal with Java/C/C++/Objective C code. It counts the cyclomatic complexity number etc.
Home-page: https://github.com/terryyin/lizard
Author: Terry Yin
Author-email: terry.yinze@gmail.com
License: UNKNOWN
Description: Lizard
        ======
        Was hfcca, A Header Free Cyclomatic Complexity Analyzer.
        
        [![Build Status](https://travis-ci.org/terryyin/lizard.png?branch=master)](https://travis-ci.org/terryyin/lizard)
        
        lizard is a simple code complexity analyzer without caring about the C/C++ 
        header files or Java imports. It can deal with
        
        ``*`` Java
        ``*`` C/C++
        ``*`` Objective C.
        
        It counts 
        
        ``*`` the nloc (lines of code without comments), 
        ``*`` CCN (cyclomatic complexity number),
        ``*`` token count of functions.
        ``*`` parameter count of functions.
        
        You can set limitation for CCN (-C), the number of parameters (-a). Functions
        that exceed these limitations will generate warnings. The exit code of lizard
        will be none-Zero if there are warnings. 
        
        This tool actually calculates how complex the code 'looks' rather than how
        complex the code real 'is'. People will need this tool because it's often very
        hard to get all the included folders and files right when they are complicated.
        But we don't really need that kind of accuracy when come to cyclomatic
        complexity.
        
        It requires python2.6 or above (early versions are not verified).
        
        ##Installation
        
        lizard.py is only a single python file, and everything is in that single script. You can always use it without any installation.
        
        <pre>
        python lizard.py
        </pre>
        
        If you want a proper install:
        
        <pre>
        [sudo] pip install lizard
        </pre>
        
        Or if you've got the source:
        
        <pre>
        [sudo] python setup.py install
        </pre>
        
        ##Usage
        
        <pre>
        lizard [options] [PATH or FILE] [PATH] ... 
        </pre>
        Run for the code under current folder (recursively):
        <pre>
        lizard
        </pre>
        Exclude anything in the tests folder:
        
        lizard mySource/ -x"./tests/``*``"
        
        
        ### Options
        
        
          --version             show program's version number and exit
          -h, --help            show this help message and exit
          -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 this number 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, otherwize it will
                                generate error. Useful in makefile when improving
                                legacy code.
          -x EXCLUDE, --exclude=EXCLUDE
                                Exclude files that match this pattern. ``*`` matches
                                everything, ? matches any single characoter,
                                "./folder/``*``" exclude everything in the folder,
                                recursively. Multiple patterns can be specified. Don't
                                forget to add "" around the pattern.
          -X, --xml             Generate XML in cppncss style instead of the normal
                                tabular output. Useful to generate report in Jenkins
                                server
          -P, --no_preprocessor_count
                                By default, a #if will also increase the complexity.
                                Adding this option to ignore them
          -t WORKING_THREADS, --working_threads=WORKING_THREADS
                                number of working threads. The default value is 1.
          -d, --find_duplicates
                                Find and skip analysis for file duplicates.
        
        ##Example use
        ### Analyze a folder recursively: lizard mahjong_game/src
        <pre>
        ==============================================================
          NLOC    CCN  token  param    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 file analyzed.
        ==============================================================
        LOC    Avg.NLOC AvgCCN Avg.ttoken  function_cnt    file
        --------------------------------------------------------------
            191     15      3        51        12     ./html_game.c
            363     24      4        86        15     ./httpd.c
        
        ======================================
        !!!! Warnings (CCN > 15) !!!!
        ======================================
            66     19    247      1    accept_request@64@./httpd.c
        =================================================================================
        Total NLOC  Avg.NLOC  Avg CCN  Avg token  Fun Cnt  Warning cnt   Fun Rt   NLOC Rt  
        --------------------------------------------------------------------------------
               554        20     4.07      71.15       27            1      0.04    0.12
        </pre>
        ### Warnings only (in clang/gcc formation):lizard -w mahjong_game
        <pre>
        ./src/html_ui/httpd.c:64: warning: accept_request has 19 CCN and 1 params (66 NLOC, 247 tokens)
        ./src/mahjong_game/mj_table.c:109: warning: mj_table_update_state has 20 CCN and 1 params (72 NLOC, 255 tokens)
        </pre>
        
        ## Using lizard as Python module
        You can also use lizard as a Python module in your code:
        python
        >>> import lizard
        >>> i = lizard.analyze_file("../cpputest/tests/AllTests.cpp")
        >>> print i.__dict__
        {'nloc': 9, 'function_list': [<lizard.FunctionInfo object at 0x10bf7af10>], 'filename': '../cpputest/tests/AllTests.cpp'}
        >>> print i.function_list[0].__dict__
        {'cyclomatic_complexity': 1, 'token_count': 22, 'name': 'main', 'parameter_count': 2, 'nloc': 3, 'long_name': 'main( int ac , const char ``*`*`` av )', 'start_line': 30}
        
        You can also use source code string instead of file. But you need to provide a file name (to identify the language).
        python
        >>> i = lizard.analyze_file.analyze_source_code("AllTests.cpp", "int foo(){}")
        
        ## Whitelist
        If for some reason you would like to ignore the warnings, you can use the whitelist. Add 'whitelizard.txt' to the current folder, 
        then the functions defined in the file will be ignored. This is an example
        
        <pre>
        #whitelizard.txt
        #The file name can only be whitelizard.txt and put it in the current folder.
        #You may have commented lines begin with #.
        function_name1, function_name2 # list function names in mulitple lines or split with comma.
        filename:function1, function2  # you can also specify the filename
        </pre>
        
        ### Options in Comments
        You can use options in the comments of the source code to change the behavior of lizard.
        By putting "#lizard forgives" inside a function or before a function it will suppress the warning for that function.
        <pre>
        int foo() {
            // #lizard forgives the complexity
            ...
        }
        </pre>
        ## Wishlist (The features that will come in the near future)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: Freeware
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Programming Language :: C
Classifier: Programming Language :: C++
Classifier: Programming Language :: Java
Classifier: Programming Language :: Objective C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
