Merge pull request #26 from zopefoundation/list-form-controls

Add a way to list all form controls without using internals
zopefoundation · Feb 3, 2017 · 1591831 · 1591831
2 parents d6756c1 + 7d32967
commit 1591831
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -13,6 +13,8 @@ CHANGES
 
 - Fix passing a real file to ``add_file``.
 
+- Add `controls` property to Form class to list all form controls.
+
 
 5.1 (2017-01-31)
 ----------------

diff --git a/src/zope/testbrowser/browser.py b/src/zope/testbrowser/browser.py
@@ -1253,6 +1253,11 @@ def getControl(self, label=None, name=None, index=None):
         return disambiguate(intermediate, msg, index,
                             controlFormTupleRepr, available)
 
+    @property
+    def controls(self):
+        return list(self.browser._findAllControls(
+            [self._form], include_subcontrols=True))
+
 
 def disambiguate(intermediate, msg, index, choice_repr=None, available=None):
     if intermediate:

diff --git a/src/zope/testbrowser/tests/test_browser.py b/src/zope/testbrowser/tests/test_browser.py
@@ -696,6 +696,10 @@ def test_subcontrols_can_be_selected_by_value():
     GET /foo HTTP/1.1
     ...
 
+    >>> form_controls = browser.getForm(index=0).controls
+    >>> len(form_controls)
+    12
+
     >>> checkboxes = browser.getControl(name='foo')
     >>> checkboxes
     <ListControl name='foo' type='checkbox'>