script to report deprecated functions of text and their age in days.
[blender.git] / source / tests / check_deprecated.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 import os
22 from os.path import splitext
23
24 DEPRECATE_DAYS = 120
25
26 SKIP_DIRS = ("extern",
27              "scons",
28              os.path.join("source", "tests"),  # not this dir
29              )
30
31 def is_c_header(filename):
32     ext = splitext(filename)[1]
33     return (ext in (".h", ".hpp", ".hxx"))
34
35
36 def is_c(filename):
37     ext = splitext(filename)[1]
38     return (ext in (".c", ".cpp", ".cxx", ".m", ".mm", ".rc"))
39
40
41 def is_c_any(filename):
42     return is_c(filename) or is_c_header(filename)
43
44 def is_py(filename):
45     ext = splitext(filename)[1]
46     return (ext == ".py")
47
48 def is_source_any(filename):
49     return is_c_any(filename) or is_py(filename)
50
51 def source_list(path, filename_check=None):
52     for dirpath, dirnames, filenames in os.walk(path):
53
54         # skip '.svn'
55         if dirpath.startswith("."):
56             continue
57
58         for filename in filenames:
59             if filename_check is None or filename_check(filename):
60                 yield os.path.join(dirpath, filename)
61
62
63 def deprecations():
64     """
65     Searches out source code for lines like
66
67     /* *DEPRECATED* 2011/7/17 bgl.Buffer.list info text */
68
69     Or...
70     
71     # *DEPRECATED* 2010/12/22 some.py.func more info */
72
73     """
74     import datetime
75     SOURCE_DIR = os.path.normpath(os.path.abspath(os.path.normpath(os.path.join(os.path.dirname(__file__), "..", ".."))))
76
77     SKIP_DIRS_ABS = [os.path.join(SOURCE_DIR, p) for p in SKIP_DIRS]
78
79     deprecations_ls = []
80
81     scan_tot = 0
82
83     print("scanning in %r for '*DEPRECATED* YYYY/MM/DD info'" % SOURCE_DIR)
84
85     for fn in source_list(SOURCE_DIR, is_source_any):
86         # print(fn)
87         skip = False
88         for p in SKIP_DIRS_ABS:
89             if fn.startswith(p):
90                 skip = True
91                 break
92         if skip:
93             continue
94
95         file = open(fn, 'r', encoding="utf8")
96         for i, l in enumerate(file):
97             # logic for deprecation warnings
98             if '*DEPRECATED*' in l:
99                 try:
100                     l = l.strip()
101                     data = l.split('*DEPRECATED*', 1)[-1].strip().strip()
102                     data = [w.strip() for w in data.split('/', 2)]
103                     data[-1], info = data[-1].split(' ', 1)
104                     info = info.split("*/", 1)[0]
105                     if len(data) != 3:
106                         print("    poorly formatting line:\n"
107                               "    %r:%d\n"
108                               "    %s"%
109                               (fn, i + 1, l)
110                               )
111                     else:
112                         data = datetime.datetime(*tuple([int(w) for w in data]))
113                         
114                         deprecations_ls.append((data, (fn, i + 1), info))
115                 except:
116                     print("Error file - %r:%d" % (fn, i + 1))
117                     import traceback
118                     traceback.print_exc()
119
120         scan_tot += 1
121
122     print("    scanned %d files" % scan_tot)
123
124     return deprecations_ls
125
126 def main():
127     import datetime
128     now = datetime.datetime.now()\
129     
130     deps = deprecations()
131
132     print("\nAll deprecations...")
133     for data, fileinfo, info in deps:
134         days_old = (now - data).days
135         if days_old > DEPRECATE_DAYS:
136             info = "*** REMOVE! *** " + info
137         print("   %r, days-old(%.2d), %s:%d - %s" % (data, days_old, fileinfo[0], fileinfo[1], info))
138     if deps:
139         print("\ndone!")
140     else:
141         print("\nnone found!")
142
143 if __name__ == '__main__':
144     main()