#!/usr/bin/env python
# cardinal_pythonlib/django/forms.py
"""
===============================================================================
Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).
This file is part of cardinal_pythonlib.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
===============================================================================
**Additional Django form types and associated cleaners/validators.**
"""
from typing import List
# noinspection PyUnresolvedReferences
from django import forms
from cardinal_pythonlib.nhs import is_valid_nhs_number
# =============================================================================
# Multiple values from a text area
# =============================================================================
[docs]def clean_int(x) -> int:
"""
Returns its parameter as an integer, or raises
``django.forms.ValidationError``.
"""
try:
return int(x)
except ValueError:
raise forms.ValidationError(f"Cannot convert to integer: {x!r}")
[docs]def clean_nhs_number(x) -> int:
"""
Returns its parameter as a valid integer NHS number, or raises
``django.forms.ValidationError``.
"""
try:
x = int(x)
if not is_valid_nhs_number(x):
raise ValueError
return x
except ValueError:
raise forms.ValidationError(f"Not a valid NHS number: {x!r}")
[docs]class MultipleIntAreaField(forms.Field):
"""
Django ``forms.Field`` to capture multiple integers.
"""
# See also https://stackoverflow.com/questions/29303902/django-form-with-list-of-integers # noqa
widget = forms.Textarea
[docs] def clean(self, value) -> List[int]:
return [clean_int(x) for x in value.split()]
[docs]class MultipleNhsNumberAreaField(forms.Field):
"""
Django ``forms.Field`` to capture multiple NHS numbers.
"""
widget = forms.Textarea
[docs] def clean(self, value) -> List[int]:
return [clean_nhs_number(x) for x in value.split()]
[docs]class MultipleWordAreaField(forms.Field):
"""
Django ``forms.Field`` to capture multiple words.
"""
widget = forms.Textarea
[docs] def clean(self, value) -> List[str]:
return value.split()
[docs]class SingleNhsNumberField(forms.IntegerField):
"""
Django ``forms.Field`` to capture a single NHS number.
"""
[docs] def clean(self, value) -> int:
return clean_nhs_number(value)