├── README.md ├── example ├── README ├── demo.py ├── demo2.py └── app.py ├── .gitignore ├── find_unused.py └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # python-find-unused-func 2 | Small tool to find unused function for python code 3 | -------------------------------------------------------------------------------- /example/README: -------------------------------------------------------------------------------- 1 | Test the program with this command line: 2 | 3 | > python3 ./find_unused.py *.py 4 | -------------------------------------------------------------------------------- /example/demo.py: -------------------------------------------------------------------------------- 1 | from demo2 import used_func4 2 | 3 | def unused_func1(): 4 | print("unused 1") 5 | 6 | def used_func1(): 7 | print("used_func1") 8 | used_func4() 9 | -------------------------------------------------------------------------------- /example/demo2.py: -------------------------------------------------------------------------------- 1 | def unused_func2(): 2 | print("unused 2") 3 | 4 | def unused_func3(): 5 | print("unused 2") 6 | 7 | def unused_func4(): 8 | print("unused 2") 9 | 10 | def used_func3(): 11 | print("used_func3") 12 | 13 | def used_func4(): 14 | print("used_func4") 15 | 16 | def used_func2(): 17 | used_func3() 18 | print("used_func2") 19 | 20 | -------------------------------------------------------------------------------- /example/app.py: -------------------------------------------------------------------------------- 1 | import sys # deliberate unused import 2 | import json # deliberate unused import 3 | 4 | import demo 5 | import demo2 6 | from demo2 import used_func2, used_func3 7 | 8 | def main(): 9 | demo.used_func1() 10 | for i in range(10): 11 | used_func2() 12 | used_func3() 13 | 14 | def unused_func0(): 15 | pass 16 | 17 | # Limitation: unused recursive functions are not detected 18 | def unuesd_recursive(): 19 | unuesd_recursive() 20 | 21 | if __name__ == '__main__': 22 | main() 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | -------------------------------------------------------------------------------- /find_unused.py: -------------------------------------------------------------------------------- 1 | import ast 2 | import sys 3 | from collections import defaultdict 4 | 5 | class Method: 6 | def __init__(self, name): 7 | self.name = name 8 | self.defined_in_files = set() 9 | self.used_in_files = set() 10 | 11 | 12 | def find_symbols(py_file): 13 | used_symbols = defaultdict(int) 14 | defined_funcs = [] 15 | with open(py_file) as f: 16 | src = f.read() 17 | tree = ast.parse(src, py_file) 18 | for node in ast.walk(tree): 19 | if isinstance(node, ast.FunctionDef): 20 | # print(ast.dump(node)) 21 | defined_funcs.append(node.name) 22 | elif isinstance(node, ast.Attribute): 23 | used_symbols[node.attr] += 1 24 | elif isinstance(node, ast.Name): 25 | used_symbols[node.id] += 1 26 | return defined_funcs, used_symbols 27 | 28 | 29 | def main(): 30 | # find method names and where they are defined_in_files 31 | methods = {} 32 | # load all used symbols in the whole source tree into memory 33 | if len(sys.argv) < 2: 34 | print('please specify python files to scan') 35 | sys.exit(1) 36 | 37 | sources = [] 38 | for py_file in sys.argv[1:]: 39 | defined_funcs, used_symbols = find_symbols(py_file) 40 | for name in defined_funcs: 41 | if name in methods: 42 | method = methods[name] 43 | else: 44 | method = Method(name) 45 | methods[name] = method 46 | method.defined_in_files.add(py_file) 47 | 48 | sources.append((py_file, used_symbols)) 49 | 50 | # scan usage of each method 51 | for name, method in methods.items(): 52 | for py_file, used_symbols in sources: 53 | if name in used_symbols: 54 | method.used_in_files.add(py_file) 55 | 56 | # print results (list by filename) 57 | unused_methods = defaultdict(list) 58 | for name, method in methods.items(): 59 | if not method.used_in_files: 60 | for py_file in method.defined_in_files: 61 | unused_methods[py_file].append(name) 62 | 63 | print('-' * 80) 64 | 65 | for py_file in sorted(unused_methods.keys()): 66 | methods = unused_methods[py_file] 67 | print(py_file) 68 | for name in methods: 69 | print('\t', name) 70 | 71 | 72 | if __name__ == '__main__': 73 | main() 74 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------