Package: drf-extra-fields
DRF-EXTRA-FIELDSExtra Fields for Django Rest FrameworkLatest Changesv3.7.0psycopg(psycopg 3) is now supported and it's used automatically instead ofpsycopg2if available.v3.6.0File objects without an actual file-system path can now be used inBase64ImageField,Base64FileFieldandHybridImageFieldv3.5.0Development environment fixes & improvements.SincePython 3.6support is ended, the codebase is refactored/modernized forPython 3.7.WebPis added to defaultALLOWED_TYPESof theBase64ImageField.Deprecatedimghdrlibrary is replaced withfiletype.UnintendedPillowdependency is removed.v3.4.0:warning:BACKWARD INCOMPATIBLE:warning:Support forDjango 3.0andDjango 3.1is ended.Django 4.0is now supported.v3.3.0:warning:BACKWARD INCOMPATIBLE:warning:Support forPython 3.6is ended.v3.2.1A typo in thepython_requiresargument ofsetup.pythat prevents installation forPython 3.6is fixed.v3.2.0:warning:BACKWARD INCOMPATIBLE:warning:Support forPython 3.5is ended.Python 3.9andPython 3.10are now supported.Django 3.2is now supported.v3.1.1psycopg2dependency is made optional.v3.1.0Possible Breaking Change:In this version we have changed file class used inBase64FileFieldfromContentFiletoSimpleUploadedFile(you may see the changehere).child_attrsproperty is added toRangeFields.UsageInstall the packagepipinstalldrf-extra-fieldsNote:This package renamed as "drf-extra-fields", earlier it was named as django-extra-fields.Install version 0.1 for Django Rest Framework 2.*Install version 0.3 or greater for Django Rest Framework 3.*Fields:Base64ImageFieldAn image representation for Base64ImageFieldInherited fromImageFieldSignature:Base64ImageField()It takes a base64 image as a string.A base64 image:data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7Base64ImageField accepts the entire string or just the part after base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7It takes the optional parameterrepresent_in_base64(Falseby default), if set toTrueit will allow for base64-encoded downloads of anImageField.You can inherit theBase64ImageFieldclass and set allowed extensions (ALLOWED_TYPESlist), or customize the validation messages (INVALID_FILE_MESSAGE,INVALID_TYPE_MESSAGE)Example:# serializerfromdrf_extra_fields.fieldsimportBase64ImageFieldclassUploadedBase64ImageSerializer(serializers.Serializer):file=Base64ImageField(required=False)created=serializers.DateTimeField()# use the serializerfile='R0lGODlhAQABAIAAAP///////yH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='serializer=UploadedBase64ImageSerializer(data={'created':now,'file':file})Base64FileFieldA file representation for Base64FileFieldInherited fromFileFieldSignature:Base64FileField()It takes a base64 file as a string.Other options like forBase64ImageFieldYou have to provide your own full implementation of this class. You have to implement file validation inget_file_extensionmethod and setALLOWED_TYPESlist.Example:classPDFBase64File(Base64FileField):ALLOWED_TYPES=['pdf']defget_file_extension(self,filename,decoded_file):try:PyPDF2.PdfFileReader(io.BytesIO(decoded_file))exceptPyPDF2.utils.PdfReadErrorase:logger.warning(e)else:return'pdf'PointFieldPoint field for GeoDjangoSignature:PointField()It takes a dictionary contains latitude and longitude keys like below{
"latitude": 49.8782482189424,
"longitude": 24.452545489
}It takes the optional parameterstr_points(False by default), if set to True it serializes the longitude/latitude
values as stringsIt takes the optional parametersrid(None by default), if set the Point created object will have its srid attribute set to the same value.Example:# serializerfromdrf_extra_fields.geo_fieldsimportPointFieldclassPointFieldSerializer(serializers.Serializer):point=PointField(required=False)created=serializers.DateTimeField()# use the serializerpoint={"latitude":49.8782482189424,"longitude":24.452545489}serializer=PointFieldSerializer(data={'created':now,'point':point})RangeFieldThe Range Fields map to Django's PostgreSQL specificRange Fields.Each accepts an optional parameterchild_attrs, which allows passing parameters to the child field.For example, callingIntegerRangeField(child_attrs={"allow_null": True})allows deserializing data with a null value forlowerand/orupper:fromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportIntegerRangeFieldclassRangeSerializer(serializers.Serializer):ranges=IntegerRangeField(child_attrs={"allow_null":True})serializer=RangeSerializer(data={'ranges':{'lower':0,'upper':None}})IntegerRangeFieldfromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportIntegerRangeFieldclassRangeSerializer(serializers.Serializer):ranges=IntegerRangeField()serializer=RangeSerializer(data={'ranges':{'lower':0,'upper':1}})FloatRangeFieldfromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportFloatRangeFieldclassRangeSerializer(serializers.Serializer):ranges=FloatRangeField()serializer=RangeSerializer(data={'ranges':{'lower':0.,'upper':1.}})DecimalRangeFieldfromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportDecimalRangeFieldclassRangeSerializer(serializers.Serializer):ranges=DecimalRangeField()serializer=RangeSerializer(data={'ranges':{'lower':0.,'upper':1.}},)DateRangeFieldimportdatetimefromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportDateRangeFieldclassRangeSerializer(serializers.Serializer):ranges=DateRangeField()serializer=RangeSerializer(data={'ranges':{'lower':datetime.date(2015,1,1),'upper':datetime.date(2015,2,1)}})DateTimeRangeFieldimportdatetimefromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportDateTimeRangeFieldclassRangeSerializer(serializers.Serializer):ranges=DateTimeRangeField()serializer=RangeSerializer(data={'ranges':{'lower':datetime.datetime(2015,1,1,0),'upper':datetime.datetime(2015,2,1,0)}})PresentablePrimaryKeyRelatedFieldRepresents related object with a serializer.presentation_serializercould also be a string that represents a dotted path of a serializer, this is useful when you want to represent a related field with the same serializer.fromdrf_extra_fields.relationsimportPresentablePrimaryKeyRelatedFieldclassUserSerializer(serializers.ModelSerializer):classMeta:model=Userfields=('id',"username",)classPostSerializer(serializers.ModelSerializer):user=PresentablePrimaryKeyRelatedField(queryset=User.objects.all(),presentation_serializer=UserSerializer,presentation_serializer_kwargs={'example':['of','passing','kwargs','to','serializer',]},read_source=None)classMeta:model=Postfields=("id","title","user",)Serializer data:{
    "user": 1,
    "title": "test"
}Serialized data with PrimaryKeyRelatedField:{
    "id":1,
    "user": 1,
    "title": "test"
}Serialized data with PresentablePrimaryKeyRelatedField:{
    "id":1,
    "user": {
        "id": 1,
        "username": "test"
    },
    "title": "test"
}PresentableSlugRelatedFieldRepresents related object retrieved using slug with a serializer.fromdrf_extra_fields.relationsimportPresentableSlugRelatedFieldclassCategorySerializer(serializers.ModelSerializer):classMeta:model=Categoryfields=("id","slug","name")classProductSerializer(serializers.ModelSerializer):category=PresentableSlugRelatedField(slug_field="slug",queryset=Category.objects.all(),presentation_serializer=CategorySerializer,presentation_serializer_kwargs={'example':['of','passing','kwargs','to','serializer',]},read_source=None)classMeta:model=Productfields=("id","name","category",)Serializer data:{
    "category": "vegetables",
    "name": "Tomato"
}Serialized data with SlugRelatedField:{
    "id": 1,
    "name": "Tomato",
    "category": "vegetables"
}Serialized data with PresentableSlugRelatedField:{
    "id": 1,
    "name": "Tomato",
    "category": {
        "id": 1,
        "slug": "vegetables",
        "name": "Vegetables"
    }
}read_source parameterThis parameter allows you to use differentsourcefor read operations and doesn't change field name for write operations. This is only used while representing the data.HybridImageFieldA django-rest-framework field for handling image-uploads through raw post data, with a fallback to multipart form data.It first tries Base64ImageField. if it fails then tries ImageField.fromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportHybridImageFieldclassHybridImageSerializer(serializers.Serializer):image=HybridImageField()drf-yasg fix for BASE64 Fields:Thedrf-yasgproject seems to generate wrong documentation on Base64ImageField or Base64FileField. It marks those fields as readonly. Here is the workaround code for correct the generated document. (More detail on issue#66)classPDFBase64FileField(Base64FileField):ALLOWED_TYPES=['pdf']classMeta:swagger_schema_fields={'type':'string','title':'File Content','description':'Content of the file base64 encoded','read_only':False# <-- FIX}defget_file_extension(self,filename,decoded_file):try:PyPDF2.PdfFileReader(io.BytesIO(decoded_file))exceptPyPDF2.utils.PdfReadErrorase:logger.warning(e)else:return'pdf'LowercaseEmailFieldAn enhancement over django-rest-framework's EmailField to allow case-insensitive serialization and deserialization of e-mail addresses.fromrest_frameworkimportserializersfromdrf_extra_fields.fieldsimportLowercaseEmailFieldclassEmailSerializer(serializers.Serializer):email=LowercaseEmailField()CONTRIBUTIONTESTSMake sure that you add the test for contributed field to test/test_fields.py
and run with command before sending a pull request:$pipinstalltox# if not already installed$toxOr, if you prefer using Docker (recommended):tools/run_development.sh
toxREADMEMake sure that you add the documentation for the field added to README.mdLICENSECopyright DRF EXTRA FIELDS HIPOLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.