IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some exception guards for strange objects.

Browse Source
This commit is contained in:
Georg Brandl 2009-07-02 20:32:15 +02:00
parent f2b4f9a43a
commit 3e4599a4a1
1 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
sphinx/ext/autodoc.py
View File

@ -194,10 +194,21 @@ def between(marker, what=None, keepempty=False):
return process return process
def safe_getattr(obj, name, *defargs):
try:
return getattr(obj, name, *defargs)
except Exception:
# this is a catch-all for all the weird things that some modules do
# with attribute access
if defargs:
return defargs[0]
raise AttributeError
def isdescriptor(x): def isdescriptor(x):
"""Check if the object is some kind of descriptor.""" """Check if the object is some kind of descriptor."""
for item in '__get__', '__set__', '__delete__': for item in '__get__', '__set__', '__delete__':
if hasattr(getattr(x, item, None), '__call__'): if hasattr(safe_getattr(x, item, None), '__call__'):
return True return True
return False return False
@ -235,7 +246,7 @@ class Documenter(object):
for typ, func in AutoDirective._special_attrgetters.iteritems(): for typ, func in AutoDirective._special_attrgetters.iteritems():
if isinstance(obj, typ): if isinstance(obj, typ):
return func(obj, name, *defargs) return func(obj, name, *defargs)
return getattr(obj, name, *defargs) return safe_getattr(obj, name, *defargs)
@classmethod @classmethod
def can_document_member(cls, member, membername, isattr, parent): def can_document_member(cls, member, membername, isattr, parent):
@ -725,11 +736,12 @@ class ModuleDocumenter(Documenter):
ret = [] ret = []
for mname in memberlist: for mname in memberlist:
try: try:
ret.append((mname, getattr(self.object, mname))) ret.append((mname, safe_getattr(self.object, mname)))
except AttributeError: except AttributeError:
self.directive.warn('missing attribute mentioned in :members: ' self.directive.warn(
'or __all__: module %s, attribute %s' % 'missing attribute mentioned in :members: or __all__: '
(self.object.__name__, mname)) 'module %s, attribute %s' % (
safe_getattr(self.object, '__name__', '???'), mname))
return False, ret return False, ret
@ -916,9 +928,12 @@ class ClassDocumenter(ModuleLevelDocumenter):
def add_content(self, more_content, no_docstring=False): def add_content(self, more_content, no_docstring=False):
if self.doc_as_attr: if self.doc_as_attr:
content = ViewList( classname = safe_getattr(self.object, '__name__', None)
[_('alias of :class:`%s`') % self.object.__name__], source='') if classname:
ModuleLevelDocumenter.add_content(self, content, no_docstring=True) content = ViewList(
[_('alias of :class:`%s`') % classname], source='')
ModuleLevelDocumenter.add_content(self, content,
no_docstring=True)
else: else:
ModuleLevelDocumenter.add_content(self, more_content) ModuleLevelDocumenter.add_content(self, more_content)