extract_docstrings.py

Go to the documentation of this file.

#-------------------------------------------------------------------------------
#  Author: Enric Tejedor <enric.tejedor.saavedra@cern.ch> CERN
#-------------------------------------------------------------------------------
 
################################################################################
# Copyright (C) 1995-2020, Rene Brun and Fons Rademakers.                      #
# All rights reserved.                                                         #
#                                                                              #
# For the licensing terms see $ROOTSYS/LICENSE.                                #
# For the list of contributors see $ROOTSYS/README/CREDITS.                    #
################################################################################
 
# Code that extracts the docstrings from pythonization files and stores them
# in .pyzdoc files, so that doxygen can process them later to merge the
# documentation they contain with that of C++ files
 
import ast
import sys
from os import path, walk
 
if len(sys.argv) < 2:
    print("Please provide the directory where documented .py files are.")
    exit(1)
 
pyz_dir = sys.argv[1]
 
(_, _, filenames) = next(walk(pyz_dir))
 
# Iterate over pythonization files
for pyz_file in filenames:
    if not pyz_file.endswith('.py'):
        continue
 
    pyz_file_path = pyz_dir + path.sep + pyz_file
    with open(pyz_file_path) as fd:
        file_contents = fd.read()
 
    # Docs for pythonizations are provided as a module-level docstring
    module = ast.parse(file_contents)
    ds = ast.get_docstring(module)
    if ds is not None:
        with open(pyz_file_path + '.pyzdoc', 'w') as pyz_doc_file:
            pyz_doc_file.write(ds)