pyams/pyams_form: comparison src/pyams

equal deleted inserted replaced

-:ba372884335f
+:c435de184bda
 # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
 # FOR A PARTICULAR PURPOSE.
 #
+"""PyAMS_form.interfaces.form module
+This module provides all custom form-related interfaces.
+"""
 from pyramid.interfaces import IView
 from z3c.form import button
 from z3c.form.interfaces import IButtonWidget, IFormLayer as IBaseFormLayer, INPUT_MODE, \
 ISelectWidget, ISubForm, ISubmitWidget, ITextAreaWidget, ITextWidget, IWidget
 from pyams_viewlet.interfaces import IViewletManager
 __docformat__ = 'restructuredtext'
-from pyams_form import _
+from pyams_form import _  # pylint: disable=ungrouped-imports
 #
 # Form interfaces
 #
 """Get an iterator over all forms and subforms"""
 def get_widget_callback(self, widget):
 """Get submit callback associated with a given widget"""
-def update_content(self, object, data):
+def update_content(self, content, data):
-"""Update given object with form data"""
+"""Update given content with form data"""
-def get_submit_output(self, writer, changes):
-"""Get submit output"""
 class IAJAXForm(Interface):
 """AJAX form attributes"""
 """Form widgets group interface"""
 form = Object(title="Parent form",
 schema=IForm)
+# pylint: disable=invalid-name
 id = TextLine(title="Group ID",
 required=False)
 widgets = List(title="Group's widgets list",
 value_type=Object(schema=IWidget))
 schema=IWidget,
 required=False,
 readonly=True)
 checkbox_mode = Choice(title="Checkbox mode",
-description="""To indicate if fieldset content should be hidden or disabled """
+description="To indicate if fieldset content should be hidden or "
-"""when the checkbox if not checked""",
+"disabled when the checkbox if not checked",
 required=True,
 values=('disable', 'hide'),
 default='hide')
 display_mode = Choice(title="Group display mode",
-description="""If 'auto', a switchable group containing only """
+description="If 'auto', a switchable group containing only "
-"""widgets with default values is hidden; if 'always', group is always
+"widgets with default values is hidden; if 'always', group "
-visible; if 'never', group is always hidden""",
+"is always visible; if 'never', group is always hidden",
 values=('auto', 'never', 'always'),
 required=True,
 default='never')
 visible = Attribute("Visible group?")
 value_type=Object(IFormWidgetsGroup))
 def add_group(self, group):
 """Add given group to form groups"""
-def updateGroups(self):
+def updateGroups(self):  # pylint: disable=invalid-name
 """Update inner groups state"""
 class IViewletsBasedForm(IBaseForm):
 """Viewlets based form"""
 class ICustomUpdateSubForm(ISubForm):
 """SubForm interface with custom update method"""
-def update_content(self, object, data):
+def update_content(self, object, data):  # pylint: disable=redefined-builtin
 """Custom content update method"""
 class ISearchForm(Interface):
 """Default search form interface"""
 A form manager is an optional context/request/form multi-adapter which can be registered
 in some custom contexts to handle form custom settings.
 """
-def getFields(self):
+def getFields(self):  # pylint: disable=invalid-name
 """Get form fields"""
-def update(self):
+def update(self):  # pylint: disable=invalid-name
 """Update form"""
-def updateWidgets(self, prefix=None):
+def updateWidgets(self, prefix=None):  # pylint: disable=invalid-name
 """Update form widgets"""
-def updateActions(self):
+def updateActions(self):  # pylint: disable=invalid-name
 """Update form actions"""
-def updateGroups(self):
+def updateGroups(self):  # pylint: disable=invalid-name
 """Update form groups"""
 #
 # Form buttons
 return False
 for widget in form.widgets.values():
 if widget.mode == INPUT_MODE:
 return True
 if IForm.providedBy(form):
-for subform in (form.subforms + form.tabforms):
+for subform in form.subforms + form.tabforms:
 for widget in (subform.widgets or {}).values():
 if widget.mode == INPUT_MODE:
 return True
 return False
 @implementer(IFormObjectCreatedEvent)
 class FormObjectCreatedEvent(ObjectCreatedEvent):
 """Form object created event"""
-def __init__(self, object, form):
+def __init__(self, object, form):  # pylint: disable=redefined-builtin
 super(FormObjectCreatedEvent, self).__init__(object)
 self.form = form
 class IFormObjectModifiedEvent(IObjectModifiedEvent, IFormObjectEvent):
 @implementer(IFormObjectModifiedEvent)
 class FormObjectModifiedEvent(ObjectModifiedEvent):
 """Form object modified event"""
-def __init__(self, object, form, *descriptions):
+def __init__(self, object, form, *descriptions):  # pylint: disable=redefined-builtin
 ObjectModifiedEvent.__init__(self, object, *descriptions)
 self.form = form

changeset 204	c435de184bda
parent 199	9167bef4d803
child 208	db681bb0380b