mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

No need to preprocess the header files - use ctags -I flag instead to 

remove DL_IMPORT.
This commit is contained in:
Thomas Heller 2001-11-12 12:52:01 +00:00
parent bfeeeee851
commit 64cdb48c80
1 changed files with 15 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Doc/tools/undoc_symbols.py
View File

@ -1,10 +1,8 @@
"""This script prints out a list of undocumented symbols found in """This script prints out a list of undocumented symbols found in
Python include files, prefixed by their tag kind. Python include files, prefixed by their tag kind.
First, a temporary file is written which contains all Python include Pass Python's include files to ctags, parse the output into a
files, with DL_IMPORT simply removed. This file is passed to ctags, dictionary mapping symbol names to tag kinds.
and the output is parsed into a dictionary mapping symbol names to tag
kinds.
Then, the .tex files from Python docs are read into a giant string. Then, the .tex files from Python docs are read into a giant string.
@ -16,12 +14,14 @@
TAG_KINDS = "dpt" TAG_KINDS = "dpt"
# Doc sections to use # Doc sections to use
DOCSECTIONS = ["api", "ext"] DOCSECTIONS = ["api"]# ["api", "ext"]
# Only print symbols starting with this prefix # Only print symbols starting with this prefix,
# to get all symbols, use an empty string # to get all symbols, use an empty string
PREFIX = "Py" PREFIX = "Py"
INCLUDEPATTERN = "*.h"
# end of customization section # end of customization section
@ -58,40 +58,28 @@ def findnames(file, prefix=""):
names[name] = tag names[name] = tag
return names return names
def print_undoc_symbols(prefix): def print_undoc_symbols(prefix, docdir, incdir):
incfile = tempfile.mktemp(".h")
fp = open(incfile, "w")
for file in glob.glob(os.path.join(INCDIR, "*.h")):
text = open(file).read()
# remove all DL_IMPORT, they will confuse ctags
text = re.sub("DL_IMPORT", "", text)
fp.write(text)
fp.close()
docs = [] docs = []
for sect in DOCSECTIONS: for sect in DOCSECTIONS:
for file in glob.glob(os.path.join(DOCDIR, sect, "*.tex")): for file in glob.glob(os.path.join(docdir, sect, "*.tex")):
docs.append(open(file).read()) docs.append(open(file).read())
docs = "\n".join(docs) docs = "\n".join(docs)
fp = os.popen("ctags --c-types=%s -f - %s" % (TAG_KINDS, incfile)) incfiles = os.path.join(incdir, INCLUDEPATTERN)
fp = os.popen("ctags -IDL_IMPORT --c-types=%s -f - %s" % (TAG_KINDS, incfiles))
dict = findnames(fp, prefix) dict = findnames(fp, prefix)
names = dict.keys() names = dict.keys()
names.sort() names.sort()
for name in names: for name in names:
if docs.find(name) == -1: if docs.find(name) == -1:
print dict[name], name print dict[name], name
os.remove(incfile)
if __name__ == '__main__': if __name__ == '__main__':
global INCDIR srcdir = os.path.dirname(sys.argv[0])
global DOCDIR incdir = os.path.normpath(os.path.join(srcdir, "../../Include"))
SRCDIR = os.path.dirname(sys.argv[0]) docdir = os.path.normpath(os.path.join(srcdir, ".."))
INCDIR = os.path.normpath(os.path.join(SRCDIR, "../../Include"))
DOCDIR = os.path.normpath(os.path.join(SRCDIR, ".."))
print_undoc_symbols(PREFIX) print_undoc_symbols(PREFIX, docdir, incdir)