[Happydoc-checkins] CVS: HappyDoc3/happydoclib appclass.py,1.5,1.6
Brought to you by:
doughellmann,
krlosaqp
|
From: Doug H. <dou...@pr...> - 2002-11-18 13:41:16
|
Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv5317/happydoclib
Modified Files:
appclass.py
Log Message:
Eliminating formatter modules, they will be combined with the docset
now.
Moving the writing logic down into the docset base class.
Index: appclass.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/appclass.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** appclass.py 17 Nov 2002 16:26:49 -0000 1.5
--- appclass.py 18 Nov 2002 13:41:12 -0000 1.6
***************
*** 107,118 ****
#
- # Define the output formats supported
- #
- ## supported_formats = happydoclib.formatter.FormatterLoader()
-
- #
# Define the documentation set types supported
#
! ## supported_docset_types = happydoclib.docset.DocSetLoader()
##
--- 107,113 ----
#
# Define the documentation set types supported
#
! supported_docset_types = happydoclib.docset.DocSetLoader()
##
***************
*** 124,129 ****
self._app_version = happydoclib.cvsProductVersion()
! ## self.set_docset_type('MultiFile')
! ## self.set_format('HTMLTable')
self._ignore_dir_patterns = []
--- 119,123 ----
self._app_version = happydoclib.cvsProductVersion()
! self.set_docset_type('MultiHTMLFile')
self._ignore_dir_patterns = []
***************
*** 140,154 ****
return
- def set_format(self, format):
- "Set the formatter to be used."
- self.format = format
- try:
- self.formatter_factory = self.supported_formats[format]
- except KeyError:
- raise ValueError('format must be one of %s' \
- % self.supported_formats.keys(),
- format)
- return
-
def set_docset_type(self, docset_type):
"Set the docset to be used."
--- 134,137 ----
***************
*** 177,181 ****
def showVerboseSyntaxHelp(self):
! "Overloaded to show supported docset and format types."
happydoclib.CommandLineApp.CommandLineApp.showVerboseSyntaxHelp(self)
--- 160,164 ----
def showVerboseSyntaxHelp(self):
! "Overloaded to show supported docset types."
happydoclib.CommandLineApp.CommandLineApp.showVerboseSyntaxHelp(self)
***************
*** 183,194 ****
self._showOptionItemsDescription('SYNTAX TYPE', self.docstring_syntaxes.items())
- print
- print 'SUPPORTED FORMATS for -F Option:\n'
- self._showOptionItemsDescription(
- 'FORMATTER TYPE', self.supported_formats.items())
-
print 'SUPPORTED DOCSET TYPES for -T Option:'
print
! print ' %s' % happydoclib.happydocset.DocSet.__doc__
print
self._showOptionItemsDescription(
--- 166,172 ----
self._showOptionItemsDescription('SYNTAX TYPE', self.docstring_syntaxes.items())
print 'SUPPORTED DOCSET TYPES for -T Option:'
print
! print ' %s' % happydoclib.docset.base.DocSet.__doc__
print
self._showOptionItemsDescription(
***************
*** 239,249 ****
return
- def optionHandler_F(self, format):
- """Specify the output format.
-
- Defaults to 'HTMLTable'."""
- self.set_format(format)
- return
-
def optionHandler_i(self, ignoreDirectory):
"""Specify a directory basename to be ignored.
--- 217,220 ----
***************
*** 363,371 ****
self.statusMessage('Importing preformatted file: %s' % filename)
! f = open(filename, 'rt')
! body = f.read()
! f.close()
! packageTreeNode.preformatted_text = body
trace.outof()
--- 334,342 ----
self.statusMessage('Importing preformatted file: %s' % filename)
! #f = open(filename, 'rt')
! #body = f.read()
! #f.close()
! #packageTreeNode.preformatted_text = body
trace.outof()
***************
*** 419,476 ****
return
- def writeOutputsCB(self, packageTreeNode):
- trace.into('HappyDoc', 'writeOutputsCB',
- packageTreeNode=packageTreeNode,
- )
- node_name = packageTreeNode.getName()
- node_path = packageTreeNode.getPath()
- canonical_path = packageTreeNode.getPath(1)
- filename = apply(os.path.join, node_path)
- canonical_filename = apply(os.path.join, canonical_path)
-
- extension = os.path.splitext(node_name)[1]
-
- if extension == '.py':
- #
- # Filename ends in .py, so it is a Python file.
- #
- self.statusMessage('Documenting: "%s"\n to: "%s"' % (
- canonical_filename,
- 'unknown',
- ))
-
- elif extension in ('.txt', '.stx'):
- #
- # Filename ends in .txt or .stx so it is
- # a text file.
- #
- self.statusMessage('Translating: "%s"\n to: "%s"' % (
- canonical_filename,
- 'unknown',
- ))
-
- elif packageTreeNode.values():
- #
- # Directory node.
- #
- pass
-
- elif not packageTreeNode.values():
- #
- # Leaf node we are skipping.
- #
- pass
-
- trace.outof()
- return
-
- def writeOutputs(self, scanner):
- package_trees = scanner.getPackageTrees()
-
- for package_tree in package_trees:
- package_tree.walk(self.writeOutputsCB)
-
- return
-
def getParameterGroupsFromArguments(self, args):
#
--- 390,393 ----
***************
*** 500,513 ****
self.statusMessage('DEBUG: \t%s:%s' % (p,v), 4)
! #
! # Find Formatter parameters
! #
! self.statusMessage('Looking for formatter parameters', 2)
! args, formatter_params = happydoclib.optiontools.getParameters('formatter', args)
! self.statusMessage('DEBUG: Formatter parameters:', 4)
! for p, v in formatter_params.items():
! self.statusMessage('DEBUG: \t%s:%s' % (p,v), 4)
!
! return (args, parser_params, docset_params, formatter_params)
def main(self, *args):
--- 417,421 ----
self.statusMessage('DEBUG: \t%s:%s' % (p,v), 4)
! return (args, parser_params, docset_params)
def main(self, *args):
***************
*** 517,521 ****
parsed_args = self.getParameterGroupsFromArguments(args)
! (args, parser_params, docset_params, formatter_params) = parsed_args
self.parser_params = parser_params
--- 425,429 ----
parsed_args = self.getParameterGroupsFromArguments(args)
! (args, parser_params, docset_params) = parsed_args
self.parser_params = parser_params
***************
*** 552,559 ****
#
# Generate some output
#
! self.writeOutputs(scanner)
!
return
--- 460,480 ----
#
+ # Create the docset
+ #
+ docset = self.docset_factory(
+ scanner=scanner,
+ title='Title',
+ outputDirectory=self.output_directory,
+ includeComments=self.include_comments,
+ includePrivateNames=self.include_private_names,
+ statusMessageFunc=self.statusMessage,
+ extraParameters=docset_params,
+ )
+
+ #
# Generate some output
#
! docset.write()
!
return
|