Package analysis :: Package output :: Module utils
[show private | hide private]
[frames | no frames]

Module analysis.output.utils

Utility functions for output.

Copyright (C) 2005 Paul Boddie <paul@boddie.org.uk>

This software is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this library; see the file LICENCE.txt If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Function Summary
  ensure_dir(directory)
Ensure the presence of 'directory' without any contents.
  generate(m, streams, visitor)
Generate output for the module 'm', sending program definitions to the given 'streams', using the given 'visitor' class.
  generate_doc(session, directory)
Using the given 'session', generate output, sending program definitions to the given 'directory'.
  generate_files(m, filenames, visitor)
Generate output for the module 'm', sending program definitions to the files with the given 'filenames', using the given 'visitor' class.
  generate_sources(session, directory, main_module_name, program_name, builtins_name)
Using the given 'session', generate output, sending program definitions to the given 'directory'.

Function Details

ensure_dir(directory)

Ensure the presence of 'directory' without any contents.

generate(m, streams, visitor)

Generate output for the module 'm', sending program definitions to the given 'streams', using the given 'visitor' class.

generate_doc(session, directory)

Using the given 'session', generate output, sending program definitions to the given 'directory'.

Return a list of generated filenames.

generate_files(m, filenames, visitor)

Generate output for the module 'm', sending program definitions to the files with the given 'filenames', using the given 'visitor' class.

generate_sources(session, directory, main_module_name, program_name='main', builtins_name='builtins')

Using the given 'session', generate output, sending program definitions to the given 'directory'. The 'main_module_name' indicates which of the Python modules shall be invoked directly in the final program, and the optional 'program_name' can be used to customise the name of the source file containing the invocation. The optional 'builtins_name' can be used to customise the name of the file containing built-in functions and classes.

Return a list of generated filenames.

Generated by Epydoc 2.1 on Tue Dec 20 00:05:45 2005 http://epydoc.sf.net