- Fixed: Proper manipulation with
BaseStrategyinstances during population
- Added:
AliasStrategyfor overriding property name on target object duringsetattr() - Changed:
field_strategynow can be also an instance ofBaseStrategy - Fixed: Fixed calling population methods when declared in form
- Added: Introduced extra optional arguments when creating
Frominstance
- Added:
GeoJSONfield introduced - Changed: Default clean method
Form.cleanis only called when there are no errors.
CI/CD fixies and project settings. There was no application change.
Release by @paimvictor
- Added: Introduced
RRuleFieldto represent Recurrence Rule objects
- Added: Introduced defining a form field for the dictionary key in
DictionaryField - Changed:
value_fieldinDictionaryFieldis forced keyword arguments - Changed: Replaced
RuntimeErrorwithApiFormException
- Fixed: Fixed missing validation errors
- Changed:
Form.add_error()now takes onlyTupleas afieldargument
- Fixed: Removed validation of non-required fields if they are not present in the request
- Fixed: Fixed "weird" behaviour with missing
clean_datavalues if usingListField
This release has been inspired by Problem Details for HTTP APIs - RFC7807 and blog post Structuring validation errors in REST APIs written by @k3nn7.
The main idea has been to simplify validation process on the client side by flattening errors output. To achieve such a goal, the whole validation process has been rewritten (and luckily for us, much simplified).
- Changed: Positional validation errors for lists
- Changed:
ImageFieldandFileFieldrequires Data URI (issue Raise ValidationError in invalid Data URI by default) - Removed:
Form.fill()method replaced byForm.populate() - Removed:
fill_methods replaced by population strategies
- Changed: Raw base64 payload in
FileFieldandImageFieldfiresDeprecationWarning. Use Data URI instead.
- Added: Introduced
mapping - Added: Override strategies using
field_type_strategyandfield_strategy
- Fixed:
DictionaryFieldwas unable to raise validation errors for keys
Anniversary release 🥳
- Added: Population strategies introduced
- Added:
fillmethod is deprecated and replaced bypopulate - Added:
Settingsobject introduced (form.settings) - Added: Pluggable content-type parsers using
DJANGO_API_FORMS_PARSERSsetting
- Changed:
mimeargument inFileFieldis supposed to be atuple
- Added:
FieldListandFormFieldListnow supports optional min/max constrains usingmin_length/max_length
- Added:
ModelFormclass introduced (experimental, initial support - not recommended for production)
- Added:
fill_methodintroduced
- Fixed: Pillow image object have to be reopened after
Image.verify()call inImageField::to_python
- Fixed:
ApiFormException('No clean data provided! Try to call is_valid() first.')was incorrectly raised if request payload was empty duringForm::fillmethod call - Changed:
clean_dataproperty is by defaultNoneinstead of empty dictionary
- Fixed: Fixed issue with
clean_methods returning values resolved as False (False,None,'')
- Fixed: Ignore
ModelMultipleChoiceFieldinForm::fill()
One more step to get rid of pytest in project (we don't need it)
- Changed: Correctly resolve key postfix if
ModelChoiceFieldis used inForm::fill() - Changed:
DjangoApiFormsConfigis created
- Added:
FileField.content_typeintroduced (contains mime)
- Added:
FileFieldandImageFieldintroduced - Added: Defined extras in
setup.pyfor optionalPillowandmsgpackdependencies - Added: Working
Form::fill()method for primitive data types. IntroducedIgnoreFillMixin
- Added:
BaseForm._requestproperty introduced (now it's possible to use request inclean_methods)
- Fixed: Fixed
Content-Typehandling ifcharsetorboundaryis present
- Fixed: Do not call resolvers methods, if property is not required and not present in request
- Changed: Non specified non-required fields will no longer be available in the cleaned_data form attribute.
- Changed: All package exceptions inherits from
ApiFormException. - Fixed: Specifying encoding while opening files in
setup.py(failing on Windows OS).
- Changed: Moved field error messages to default_error_messages for easier overriding and testing.
- Fixed: Fix KeyError when invalid values are sent to FieldList.
- Fixed: Removed unnecessary error checking in FieldList.
- Added: Tests for fields
- Changed: Remove DeclarativeFieldsMetaclass and import from Django instead.
- Changed: Msgpack dependency is no longer required.
- Changed: Empty values passed into a FormField now return {} rather than None.
- Fixed: Throw a more user friendly error when passing non-Enums or invalid values to EnumField.
- Changed Use poetry instead of pipenv
- Changed: Library renamed from
django_api_formstodjango-api-forms(cosmetic change without effect)
- Changed: Library renamed from
django_request_formattertodjango_api_forms - Changed: Imports in main module
django_api_forms
- Added:
BooleanFieldintroduced
- Fixed: Pass
Invalid valueasValidationErrornot as astring
- Fixed: Introduced generic
Invalid valueerror message, if there isAttributeError,TypeError,ValueError
- Fixed: Fixing issue from version
0.5.5but this time for real - Changed: Renamed version file from
__version__.pytoversion.py
- Fixed: Check instance only if there is a value in
FieldListandFormFieldList
- Fixed: Added missing
msgpack`` dependency tosetup.py`
- Added: Introduced generic
AnyField
- Fixed: Skip processing of the
FormFieldif value is not required and empty
- Fixed: Process
EnumFieldeven if it's not marked as required
- Changed: Use native
django.form.fieldsif possible - Changed: Removed
kwargspropagation from release0.3.0 - Changed: Changed syntax back to
django.formscompatible (e.g.form.validate_{key}()->form.clean_{key}()) - Changed:
FieldListraisesValidationErrorinstead ofRuntimeExceptionif there is a type in validation - Changed: Use private properties for internal data in field objects
- Fixed:
FieldListreturns values instead ofNone - Fixed: Fixed validation in
DictionaryField - Added: Basic unit tests
- Fixed: Fixed
Formhas no attributeself._data
- Fixed: If payload is empty, create empty dictionary to avoid
NoneTypeerror
- Added: Introduced
UUIDField
- Added: Introduced
DictionaryField
- Added: Propagate
kwargsfromForm.is_valid()toForm.validate()andForm.validate_{key}()methods
- Fixed: Fixed
to_python()in FormFieldList
- Changed:
Form.validate()replaced byForm.is_valid() - Added:
Form.validate()is now used as a last step of form validation and it's aimed to be overwritten if needed - Added: Unit tests initialization
- Fixed: Non-required EnumField is now working
- Added: WIP: Initial method for filling objects
Form::fill()
- Fixed: Assign errors to form before raising
ValidationError
- Fixed: Do not return empty error records in
Form:errors
- Fixed: Use custom
DeclarativeFieldsMetaclassbecause of customFieldclass - Fixed: Do not return untouched fields in
Form::payload - Fixed: Fix for None
default_validatorsinField
- Added: Support for
validation_{field}methods inForm(initial support)
- Added:
EnumField
- Added: First version of
Formclass - Added:
CharField - Added:
IntegerField - Added:
FloatField - Added:
DecimalField - Added:
DateField - Added:
TimeField - Added:
DateTimeField - Added:
DurationField - Added:
RegexField - Added:
EmailField - Added:
BooleanField - Added:
RegexField - Added:
FieldList - Added:
FormField - Added:
FormFieldList