mirror of
https://github.com/python/cpython.git
synced 2025-07-29 22:24:49 +00:00
ea4d2c0241
- Change PREFIX to PREFIXES, which contains a sequence of prefix strings. This is useful since we want to look for both Py and PY. - Wrap a long line. - Collect struct tags as well as typedef names. Since we generally only use one of the other, that improves coverage. - Make the script executable on Unix. This could use a better approach to determine if a symbol is documented, and could easily avoid keeping the massive string in memory. That would take time to actually write more code, though, so we'll bail on that for now.
94 lines
2.5 KiB
Python
94 lines
2.5 KiB
Python
#! /usr/bin/env python
|
|
|
|
"""\
|
|
This script prints out a list of undocumented symbols found in
|
|
Python include files, prefixed by their tag kind.
|
|
|
|
Pass Python's include files to ctags, parse the output into a
|
|
dictionary mapping symbol names to tag kinds.
|
|
|
|
Then, the .tex files from Python docs are read into a giant string.
|
|
|
|
Finally all symbols not found in the docs are written to standard
|
|
output, prefixed with their tag kind.
|
|
"""
|
|
|
|
# Which kind of tags do we need?
|
|
TAG_KINDS = "dpst"
|
|
|
|
# Doc sections to use
|
|
DOCSECTIONS = ["api"]# ["api", "ext"]
|
|
|
|
# Only print symbols starting with this prefix,
|
|
# to get all symbols, use an empty string
|
|
PREFIXES = ("Py", "PY")
|
|
|
|
INCLUDEPATTERN = "*.h"
|
|
|
|
# end of customization section
|
|
|
|
|
|
# Tested with EXUBERANT CTAGS
|
|
# see http://ctags.sourceforge.net
|
|
#
|
|
# ctags fields are separated by tabs.
|
|
# The first field is the name, the last field the type:
|
|
# d macro definitions (and #undef names)
|
|
# e enumerators
|
|
# f function definitions
|
|
# g enumeration names
|
|
# m class, struct, or union members
|
|
# n namespaces
|
|
# p function prototypes and declarations
|
|
# s structure names
|
|
# t typedefs
|
|
# u union names
|
|
# v variable definitions
|
|
# x extern and forward variable declarations
|
|
|
|
import os, glob, re, sys, tempfile
|
|
|
|
def findnames(file, prefixes=()):
|
|
names = {}
|
|
for line in file.xreadlines():
|
|
if line[0] == '!':
|
|
continue
|
|
fields = line.split()
|
|
name, tag = fields[0], fields[-1]
|
|
if tag == 'd' and name.endswith('_H'):
|
|
continue
|
|
if prefixes:
|
|
sw = name.startswith
|
|
for prefix in prefixes:
|
|
if sw(prefix):
|
|
names[name] = tag
|
|
else:
|
|
names[name] = tag
|
|
return names
|
|
|
|
def print_undoc_symbols(prefix, docdir, incdir):
|
|
docs = []
|
|
|
|
for sect in DOCSECTIONS:
|
|
for file in glob.glob(os.path.join(docdir, sect, "*.tex")):
|
|
docs.append(open(file).read())
|
|
|
|
docs = "\n".join(docs)
|
|
|
|
incfiles = os.path.join(incdir, INCLUDEPATTERN)
|
|
|
|
fp = os.popen("ctags -IDL_IMPORT --c-types=%s -f - %s"
|
|
% (TAG_KINDS, incfiles))
|
|
dict = findnames(fp, prefix)
|
|
names = dict.keys()
|
|
names.sort()
|
|
for name in names:
|
|
if docs.find(name) == -1:
|
|
print dict[name], name
|
|
|
|
if __name__ == '__main__':
|
|
srcdir = os.path.dirname(sys.argv[0])
|
|
incdir = os.path.normpath(os.path.join(srcdir, "../../Include"))
|
|
docdir = os.path.normpath(os.path.join(srcdir, ".."))
|
|
|
|
print_undoc_symbols(PREFIXES, docdir, incdir)
|