Debian Codegraph @

tests/unit/test_autointerface.py

raw
1 import unittest
2
3 from docutils.statemachine import ViewList
4 from sphinx.ext.autodoc import ALL
5 from zope import interface
6
7 from repoze.sphinx import autointerface
8 from .util import SphinxTestApp
9
10 class IPlumbusMaker(interface.Interface):
11
12 grumbo = interface.Attribute("The dinglebop is fed through here")
13 fleeb = interface.Attribute("The dinglebop is polished with this")
14
15 def smoothTheDinglebop(schleem):
16 """Smooth it out
17
18 The schleem is then repurposed.
19 """
20
21 class Options(dict):
22 inherited_members = False
23 undoc_members = False
24 private_members = False
25 special_members = False
26 imported_members = False
27 show_inheritance = False
28 noindex = False
29 no_index = False # FBO Sphinx 8.x
30 no_index_entry = False # FBO Sphinx 9.x
31 annotation = None
32 synopsis = ''
33 platform = ''
34 deprecated = False
35 members = ()
36 member_order = 'alphabetic'
37 exclude_members = ()
38
39 def __init__(self):
40 super(Options, self).__init__()
41 self.exclude_members = set()
42 self.members = []
43 self.__dict__ = self
44
45 class Settings(object):
46
47 tab_width = 4
48
49
50 class Document(object):
51
52 def __init__(self, settings):
53 self.settings = settings
54
55
56 class State(object):
57
58 def __init__(self, document):
59 self.document = document
60
61
62 class Directive(object):
63 env = None
64 genopt = None
65 result = None
66 record_dependencies = None
67
68 def __init__(self):
69 self._warnings = []
70 self.filename_set = set()
71 self.result = ViewList()
72 self.record_dependencies = set()
73 self.state = State(Document(Settings()))
74
75 def warn(self, msg):
76 self._warnings.append(msg)
77
78 class AutoInterfaceTests(unittest.TestCase):
79
80 def setUp(self):
81 app = self.app = SphinxTestApp()
82 app.builder.env.temp_data['docname'] = 'dummy'
83
84 autointerface.setup(app)
85
86 opt = self.options = Options()
87 d = self.directive = Directive()
88 d.env = app.builder.env
89 d.genopt = opt
90
91 def tearDown(self):
92 self.app.cleanup()
93 self.app = None
94
95 def assertResultContains(
96 self,
97 item,
98 objtype='interface',
99 name='tests.unit.test_autointerface.IPlumbusMaker',
100 **kw,
101 ):
102 directive = self.directive
103 inst = self.app.registry.documenters['interface'](directive, name)
104 inst.generate(**kw)
105 # print '\n'.join(directive.result)
106 self.assertEqual([], directive._warnings)
107 self.assertIn(item, directive.result)
108 results = directive.result[:]
109 del directive.result[:]
110 return '\n'.join(results)
111
112 def test_restricted_members(self):
113 self.options.members = ['smoothTheDinglebop']
114 all_results = self.assertResultContains(
115 ' .. method:: smoothTheDinglebop(schleem)'
116 )
117 self.assertNotIn('grumbo', all_results)
118
119 def test_all_members(self):
120 self.options.members = ALL
121 all_results = self.assertResultContains(
122 ' .. method:: smoothTheDinglebop(schleem)'
123 )
124 self.assertIn('grumbo', all_results)
125 self.assertIn('fleeb', all_results)