Menu for the Class Documentation Module.
The menu allows for looking for classes by partial names. See findClasses() for the simple search implementation.
There are no implemented interfaces.
There are no attributes in this class.
findAllClasses()
Find all classes
>>> from zope.component import getUtility >>> from zope.app.apidoc.codemodule.class_ import Class >>> from zope.app.apidoc.interfaces import IDocumentationModule
>>> cm = getUtility(IDocumentationModule, 'Code') >>> mod = cm['zope']['app']['apidoc']['codemodule']['browser']
Setup a couple of classes and register them.
>>> class Foo(object): ... pass >>> mod._children['Foo'] = Class(mod, 'Foo', Foo) >>> class Foo2(object): ... pass >>> mod._children['Foo2'] = Class(mod, 'Foo2', Foo2) >>> class Blah(object): ... pass >>> mod._children['Blah'] = Class(mod, 'Blah', Blah)
Setup the view.
>>> from zope.app.apidoc.codemodule.browser.menu import Menu >>> from zope.publisher.browser import TestRequest >>> menu = Menu() >>> menu.context = None
Testing the method with various inputs.
>>> menu.request = TestRequest(form={'path': 'Foo'}) >>> info = menu.findAllClasses()
>>> len(info) > 3 True
findClasses()
Find the classes that match a partial path.
>>> from zope.component import getUtility >>> from zope.app.apidoc.codemodule.class_ import Class >>> from zope.app.apidoc.interfaces import IDocumentationModule
>>> cm = getUtility(IDocumentationModule, 'Code') >>> mod = cm['zope']['app']['apidoc']['codemodule']['browser']
Setup a couple of classes and register them.
>>> class Foo(object): ... pass >>> mod._children['Foo'] = Class(mod, 'Foo', Foo) >>> class Foo2(object): ... pass >>> mod._children['Foo2'] = Class(mod, 'Foo2', Foo2) >>> class Blah(object): ... pass >>> mod._children['Blah'] = Class(mod, 'Blah', Blah)
Setup the view.
>>> from zope.app.apidoc.codemodule.browser.menu import Menu >>> from zope.publisher.browser import TestRequest >>> menu = Menu() >>> menu.context = None
Testing the method with various inputs.
>>> menu.request = TestRequest(form={'path': 'Foo'}) >>> info = menu.findClasses()
>>> pprint(info) [{'path': 'zope.app.apidoc.codemodule.browser.Foo', 'url': 'http://127.0.0.1/zope/app/apidoc/codemodule/browser/Foo/'}, {'path': 'zope.app.apidoc.codemodule.browser.Foo2', 'url': 'http://127.0.0.1/zope/app/apidoc/codemodule/browser/Foo2/'}, {'path': 'zope.testing.doctest.UnusedFootnoteWarning', 'url': 'http://127.0.0.1/zope/testing/doctest/UnusedFootnoteWarning/'}]
>>> menu.request = TestRequest(form={'path': 'o2'}) >>> info = menu.findClasses() >>> pprint(info) [{'path': 'zope.app.apidoc.codemodule.browser.Foo2', 'url': 'http://127.0.0.1/zope/app/apidoc/codemodule/browser/Foo2/'}]
>>> menu.request = TestRequest(form={'path': 'Blah'}) >>> info = menu.findClasses() >>> pprint(info) [{'path': 'zope.app.apidoc.codemodule.browser.Blah', 'url': 'http://127.0.0.1/zope/app/apidoc/codemodule/browser/Blah/'}]
There are no known subclasses.