Update of /cvsroot/happydoc/HappyDoc3/happydoclib/parsers
In directory sc8-pr-cvs1:/tmp/cvs-serv14016/happydoclib/parsers
Added Files:
parsers_text.py parsers_structuredtext.py parsers_python.py
parsers_directory.py parsers_default.py base.py __init__.py
Log Message:
New parsers plugin set for handling files based on mimetypes. The
base class defines the API for the plugin, and __call__ is expected to
return something that acts like (is a subclass of) a PackageTree.
--- NEW FILE: parsers_text.py ---
#!/usr/bin/env python
#
# $Id: parsers_text.py,v 1.1 2003/01/18 20:01:50 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Plain text parser.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: parsers_text.py,v $',
'rcs_id' : '$Id: parsers_text.py,v 1.1 2003/01/18 20:01:50 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:28:46 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:50 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
from parsers_structuredtext import StructuredTextFileParser
#
# Module
#
class PlainTextFileParser(StructuredTextFileParser):
"""Plain text file parser.
"""
def entryPoint():
return { 'mimetype':'text/plain',
'factory':PlainTextFileParser,
}
--- NEW FILE: parsers_structuredtext.py ---
#!/usr/bin/env python
#
# $Id: parsers_structuredtext.py,v 1.1 2003/01/18 20:01:51 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Structured text file parser.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: parsers_structuredtext.py,v $',
'rcs_id' : '$Id: parsers_structuredtext.py,v 1.1 2003/01/18 20:01:51 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:07:52 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:51 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
import re
#
# Import Local modules
#
from base import ParserBase
import happydoclib
from happydoclib.packagetree import PackageTree
from happydoclib.status import statusMessage
from happydoclib.trace import trace
from happydoclib.utils import extractSummary
#
# Module
#
TRACE_LEVEL = 2
class StructuredTextFile(PackageTree):
"""Structured text file node.
"""
TEXT_FORMAT = 'StructuredText'
def __init__(self, parent, name):
trace.into('StructuredTextFile', '__init__',
outputLevel=TRACE_LEVEL)
PackageTree.__init__(self, parent, name)
#
# Derive the filename for this module.
#
filename = self.getInputFilename()
statusMessage('Importing %s file: %s' % (self.TEXT_FORMAT,
filename)
)
self.readme_text = open(filename, 'rt').read()
self.format = self.TEXT_FORMAT
self.summary = extractSummary(self.readme_text)
trace.outof(outputLevel=TRACE_LEVEL)
return
def getDocStringAndFormat(self):
"""Returns a tuple containing the actual documentation string
and the format of that docstring as understood by the
docstring converters plugins.
"""
return (self.readme_text, self.format)
def getSummaryAndFormat(self):
"""Returns a tuple containing a one line summary of the
documentation for the node and the format of that
string as understood by the docstring converter plugins.
"""
return (self.summary, self.format)
class StructuredTextFileParser(ParserBase):
def __call__(self, parent, name):
return StructuredTextFile(parent, name)
def entryPoint():
return { 'mimetype':'text/x-structured',
'factory':StructuredTextFileParser,
}
--- NEW FILE: parsers_python.py ---
#!/usr/bin/env python
#
# $Id: parsers_python.py,v 1.1 2003/01/18 20:01:51 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Python source file parser.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: parsers_python.py,v $',
'rcs_id' : '$Id: parsers_python.py,v 1.1 2003/01/18 20:01:51 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:07:52 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:51 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
from base import ParserBase
import happydoclib
from happydoclib.packagetree import PackageTree, ClassTree, FunctionTree
from happydoclib.status import statusMessage
from happydoclib.trace import trace
#
# Module
#
TRACE_LEVEL = 2
class PythonModule(PackageTree):
def __init__(self, parent, name):
trace.into('PythonModule', '__init__',
outputLevel=TRACE_LEVEL)
PackageTree.__init__(self, parent, name)
#
# Derive the filename for this module.
#
statusMessage('Parsing: %s' % name)
#
# Figure out if there is a parent node for the
# documentation suite.
#
if parent and hasattr(parent, 'module_info'):
docs_parent = parent.module_info
else:
docs_parent = None
trace.writeVar(docs_parent=docs_parent,
outputLevel=TRACE_LEVEL)
docs = happydoclib.parseinfo.getDocs(
parent=docs_parent,
fileName=name,
)
self.module_info = docs
#
# Add classes to the tree
#
for class_name in self.module_info.getClassNames():
class_tree = ClassTree(self, class_name)
#
# Add functions to the tree
#
for function_name in self.module_info.getFunctionNames():
function_tree = FunctionTree(self, function_name)
trace.outof(outputLevel=TRACE_LEVEL)
return
def _unquoteString(self, str):
"Remove surrounding quotes from a string."
str = str.strip()
while ( str
and
(str[0] == str[-1])
and
str[0] in ('"', "'")
):
str = str[1:-1]
return str
def getDocStringAndFormat(self):
"""Returns a tuple containing the actual documentation string
and the format of that docstring as understood by the
docstring converters plugins.
"""
docstring = self.module_info.getDocString()
docstring = self._unquoteString(docstring)
format = self.module_info.getDocStringFormat()
return (docstring, format)
def getSummaryAndFormat(self):
"""Returns a tuple containing a one line summary of the
documentation for the node and the format of that
string as understood by the docstring converter plugins.
"""
return self.module_info.getSummaryAndFormat()
class PythonModuleParser(ParserBase):
def __call__(self, parent, name):
return PythonModule(parent, name)
def entryPoint():
return { 'mimetype':'text/x-python',
'factory':PythonModuleParser,
}
--- NEW FILE: parsers_directory.py ---
#!/usr/bin/env python
#
# $Id: parsers_directory.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Directory "parser".
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: parsers_directory.py,v $',
'rcs_id' : '$Id: parsers_directory.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:03:15 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:52 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
from base import ParserBase
from happydoclib.packagetree import PackageTree
from happydoclib.trace import trace
from happydoclib.utils import extractSummary
#
# Module
#
TRACE_LEVEL=3
class Directory(PackageTree):
"""Directory node for directories and folders.
"""
DOCSTRING_SOURCES = ('__init__.py', 'README.txt', 'README.stx')
def getDocStringAndFormat(self):
"""Returns a tuple containing the actual documentation string
and the format of that docstring as understood by the
docstring converters plugins.
"""
docstring = ''
format = 'StructuredText'
if hasattr(self, '_docstring'):
docstring, format = self._docstring
return (docstring, format)
for name in self.DOCSTRING_SOURCES:
trace.write('looking for %s' % name, outputLevel=TRACE_LEVEL)
node = self.get(name)
if node is not None:
docstring, format = node.getDocStringAndFormat()
self._docstring_source = node
break
self._docstring = (docstring, format)
return (docstring, format)
def getSummaryAndFormat(self):
"""Returns a tuple containing a one line summary of the
documentation for the node and the format of that
string as understood by the docstring converter plugins.
"""
if hasattr(self, '_docstring_source'):
return self._docstring_source.getSummaryAndFormat()
elif hasattr(self, '_summary'):
return (self._summary, self._docstring[1])
docstring, format = self.getDocStringAndFormat()
summary = extractSummary(docstring)
self._summary = summary
return (summary, format)
class DirectoryParser(ParserBase):
"""Parser for directories.
"""
def __call__(self, parent, name):
return Directory(parent, name)
def entryPoint():
return { 'mimetype':'application/x-directory',
'factory':DirectoryParser,
}
--- NEW FILE: parsers_default.py ---
#!/usr/bin/env python
#
# $Id: parsers_default.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Null parser.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: parsers_default.py,v $',
'rcs_id' : '$Id: parsers_default.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:03:15 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:52 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
from happydoclib.packagetree import PackageTree
from base import ParserBase
#
# Module
#
class Null(PackageTree):
"""Null node for unknown mimetypes.
"""
def getDocStringAndFormat(self):
"""Returns a tuple containing the actual documentation string
and the format of that docstring as understood by the
docstring converters plugins.
"""
return ('', 'StructuredText')
def getSummaryAndFormat(self):
"""Returns a tuple containing a one line summary of the
documentation for the node and the format of that
string as understood by the docstring converter plugins.
"""
return ('', 'StructuredText')
class NullParser(ParserBase):
"""Parser for unknown files.
"""
def __call__(self, parent, name):
return Null(parent, name)
def entryPoint():
return { 'mimetype':'application/octet-stream',
'factory':NullParser,
}
--- NEW FILE: base.py ---
#!/usr/bin/env python
#
# $Id: base.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Base class for parsers.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: base.py,v $',
'rcs_id' : '$Id: base.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 12:03:15 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:52 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
#
# Module
#
class ParserBase:
"""Base class for parsers.
"""
def __init__(self):
"""Initialize the parser.
"""
return
def __call__(self, parent, filename):
raise NotImplementedError('%s.__call__' % self.__class__.__name__)
--- NEW FILE: __init__.py ---
#!/usr/bin/env python
#
# $Id: __init__.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Parser plugins.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: __init__.py,v $',
'rcs_id' : '$Id: __init__.py,v 1.1 2003/01/18 20:01:52 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 11:53:33 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 20:01:52 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
import happydoclib
#
# Module
#
class ParserLoader(happydoclib.pluginloader.PluginLoader):
"""Load parsers.
"""
def __init__(self):
happydoclib.pluginloader.PluginLoader.__init__(
self,
__name__,
__path__[0],
'happydoclib',
)
return
def addEntryPoint(self, infoDict):
"Add the information about the parser to our lookup table."
factory = infoDict['factory']
mimetype = infoDict['mimetype']
self[mimetype] = factory
return
|
