2 # -*- coding: utf-8 -*-
3 # Copyright (C) 2012-2015 CEA/DEN, EDF R&D, OPEN CASCADE
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License, or (at your option) any later version.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #################################################################################
24 # File: collect_geom_methods.py
25 # Author: Roman NIKOLAEV, Open CASCADE S.A.S (roman.nikolaev@opencascade.com)
27 #################################################################################
29 # Extraction of the methods dynamically added by the Geometry
30 # module plug-in(s) to the geomBuilder class.
32 # This script is intended for internal usage - only
33 # for generatation of the extra developer documentation for
34 # the Geometry module plug-in(s).
37 # collect_geom_methods.py <plugin_name>
39 # <plugin_name> is a name of the plug-in module
42 # - the script is supposed to be run in correct environment
43 # i.e. PYTHONPATH, GEOM_PluginsList and other important
44 # variables are set properly; otherwise the script will fail.
46 ################################################################################
51 def generate(plugin_name, output):
52 plugin_module_name = plugin_name + "Builder"
53 plugin_module = "salome.%s.%s" % (plugin_name, plugin_module_name)
54 import_str = "from salome.%s import %s" % (plugin_name, plugin_module_name)
56 exec( "import %s" % plugin_module )
57 exec( "mod = %s" % plugin_module )
59 for attr in dir( mod ):
60 if attr.startswith( '_' ): continue # skip an internal methods
61 item = getattr( mod, attr )
62 if type( item ).__name__ == 'function':
63 if item not in functions:
64 functions.append( item )
69 for function in functions:
70 comments = inspect.getcomments(function)
72 comments = comments.strip().split("\n")
73 comments = "\t" + "\n\t".join(comments)
74 output.append(comments)
76 sources = inspect.getsource(function)
77 if sources is not None:
78 sources_list = sources.split("\n")
81 for item in sources_list:
92 sources_new_list.append(item)
95 sources = "\n".join(sources_new_list)
96 sources = "\t" + sources.replace("\n", "\n\t")
97 output.append(sources)
103 if __name__ == "__main__":
105 parser = optparse.OptionParser(usage="%prog [options] plugin")
106 h = "Output file (geomBuilder.py by default)"
107 parser.add_option("-o", "--output", dest="output",
108 action="store", default=None, metavar="file",
110 h = "If this option is True, dummy help for geomBuiler class is added. "
111 h += "This option should be False (default) when building documentation for Geometry module "
112 h += "and True when building documentation for Geometry module plug-ins."
113 parser.add_option("-d", "--dummy-geom-help", dest="dummygeomhelp",
114 action="store_true", default=False,
116 (options, args) = parser.parse_args()
117 if len( args ) < 1: sys.exit("Plugin name is not specified")
119 f = open(options.output, "w")
122 if options.dummygeomhelp:
123 output.append( "## @package geomBuilder" )
124 output.append( "# Documentation of the methods dynamically added by the " + plugin_name + " Geometry plug-in to the geomBuilder class." )
125 # Add dummy Geometry help
126 # This is supposed to be done when generating documentation for Geometry module plug-ins
127 output.append( "# @note The documentation below does not provide complete description of class @b %geomBuilder" )
128 output.append( "# from @b geomBuilder package. This documentation provides only information about" )
129 output.append( "# the methods dynamically added to the %geomBuilder class by the " + plugin_name + " plugin" )
130 output.append( "# For more details on the %geomBuilder class, please refer to the SALOME %Geometry module" )
131 output.append( "# documentation." )
134 # Extend documentation for geomBuilder class with information about dynamically added methods.
135 # This is supposed to be done only when building documentation for Geometry module
136 output.append( "## @package geomBuilder" )
137 output.append( "# @note Some methods are dynamically added to the @b %geomBuilder class in runtime by the" )
138 output.append( "# plug-in modules. If you fail to find help on some methods in the documentation of Geometry module, " )
139 output.append( "# try to look into the documentation for the Geometry module plug-ins." )
141 output.append("class geomBuilder():")
144 generate( arg, output )
147 for line in output: f.write( line + "\n" )