Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
ba39592b
Commit
ba39592b
authored
Nov 12, 2001
by
Thomas Heller
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
No need to preprocess the header files - use ctags -I flag instead to
remove DL_IMPORT.
parent
92e78f79
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
27 deletions
+15
-27
Doc/tools/undoc_symbols.py
Doc/tools/undoc_symbols.py
+15
-27
No files found.
Doc/tools/undoc_symbols.py
View file @
ba39592b
"""This script prints out a list of undocumented symbols found in
Python include files, prefixed by their tag kind.
First, a temporary file is written which contains all Python include
files, with DL_IMPORT simply removed. This file is passed to ctags,
and the output is parsed into a dictionary mapping symbol names to tag
kinds.
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.
...
...
@@ -16,12 +14,14 @@ output, prefixed with their tag kind.
TAG_KINDS
=
"dpt"
# 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
PREFIX
=
"Py"
INCLUDEPATTERN
=
"*.h"
# end of customization section
...
...
@@ -58,40 +58,28 @@ def findnames(file, prefix=""):
names
[
name
]
=
tag
return
names
def
print_undoc_symbols
(
prefix
):
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
()
def
print_undoc_symbols
(
prefix
,
docdir
,
incdir
):
docs
=
[]
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
=
"
\
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
)
names
=
dict
.
keys
()
names
.
sort
()
for
name
in
names
:
if
docs
.
find
(
name
)
==
-
1
:
print
dict
[
name
],
name
os
.
remove
(
incfile
)
if
__name__
==
'__main__'
:
global
INCDIR
global
DOCDIR
SRCDIR
=
os
.
path
.
dirname
(
sys
.
argv
[
0
])
INCDIR
=
os
.
path
.
normpath
(
os
.
path
.
join
(
SRCDIR
,
"../../Include"
))
DOCDIR
=
os
.
path
.
normpath
(
os
.
path
.
join
(
SRCDIR
,
".."
))
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
(
PREFIX
)
print_undoc_symbols
(
PREFIX
,
docdir
,
incdir
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment