Commit d099fe40 authored by Valentin Samir's avatar Valentin Samir

Document cas_server/templatetags

parent ba590607
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License version 3 for
# more details.
#
# You should have received a copy of the GNU General Public License version 3
# along with this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# (c) 2015-2016 Valentin Samir
"""template tags for the app"""
from django import template from django import template
from django import forms from django import forms
...@@ -6,9 +17,23 @@ register = template.Library() ...@@ -6,9 +17,23 @@ register = template.Library()
@register.filter(name='is_checkbox') @register.filter(name='is_checkbox')
def is_checkbox(field): def is_checkbox(field):
"""
check is a form bound field is a checkbox
:param django.forms.boundfield.BoundField field: A bound field
:return: ``True`` if the field is a checkbox, ``False`` otherwise.
:rtype: bool
"""
return isinstance(field.field.widget, forms.CheckboxInput) return isinstance(field.field.widget, forms.CheckboxInput)
@register.filter(name='is_hidden') @register.filter(name='is_hidden')
def is_hidden(field): def is_hidden(field):
"""
check is a form bound field is hidden
:param django.forms.boundfield.BoundField field: A bound field
:return: ``True`` if the field is hidden, ``False`` otherwise.
:rtype: bool
"""
return isinstance(field.field.widget, forms.HiddenInput) return isinstance(field.field.widget, forms.HiddenInput)
cas_server package cas_server package
================== ==================
Subpackages
-----------
.. toctree::
cas_server.templatetags
Submodules Submodules
---------- ----------
......
cas_server.templatetags.cas_server module
=========================================
.. automodule:: cas_server.templatetags.cas_server
:members:
:undoc-members:
:show-inheritance:
cas_server.templatetags package
===============================
Submodules
----------
.. toctree::
cas_server.templatetags.cas_server
Module contents
---------------
.. automodule:: cas_server.templatetags
:members:
:undoc-members:
:show-inheritance:
cas_server.urls module
======================
.. automodule:: cas_server.urls
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment