Merge pull request #202 from hartungstenio/psycopg3

Add compatibility with Psycopg 3

drf_extra_fields/compat.py

@@ -1,4 +1,18 @@
+import django
+
 try:
-    from django.contrib.postgres.fields import FloatRangeField
+    from django.contrib.postgres import fields as postgres_fields
+
+    if django.VERSION >= (4, 2):
+        try:
+            from psycopg.types.range import DateRange, NumericRange
+            from psycopg.types.range import TimestamptzRange as DateTimeTZRange
+        except ImportError:
+            from psycopg2.extras import DateRange, DateTimeTZRange, NumericRange
+    else:
+        from psycopg2.extras import DateRange, DateTimeTZRange, NumericRange
 except ImportError:
-    FloatRangeField = None
+    postgres_fields = None
+    DateRange = None
+    DateTimeTZRange = None
+    NumericRange = None

drf_extra_fields/fields.py

@@ -1,36 +1,28 @@
 import base64
 import binascii
-import filetype
 import io
 import uuid
 
+import filetype
 from django.core.exceptions import ValidationError
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.utils.translation import gettext_lazy as _
 from rest_framework.fields import (
     DateField,
     DateTimeField,
+    DecimalField,
     DictField,
     EmailField,
     FileField,
     FloatField,
     ImageField,
     IntegerField,
-    DecimalField,
 )
 from rest_framework.serializers import ModelSerializer
 from rest_framework.utils import html
-from drf_extra_fields import compat
-
-try:
-    from django.contrib.postgres import fields as postgres_fields
-    from psycopg2.extras import DateRange, DateTimeTZRange, NumericRange
-except ImportError:
-    postgres_fields = None
-    DateRange = None
-    DateTimeTZRange = None
-    NumericRange = None
 
+from drf_extra_fields import compat
+from drf_extra_fields.compat import DateRange, DateTimeTZRange, NumericRange
 
 DEFAULT_CONTENT_TYPE = "application/octet-stream"
 
@@ -195,8 +187,8 @@ class RangeField(DictField):
     })
 
     def __init__(self, **kwargs):
-        if postgres_fields is None:
-            assert False, "'psgl2' is required to use {name}. Please install the  'psycopg2' library from 'pip'".format(
+        if compat.postgres_fields is None:
+            assert False, "'psycopg' is required to use {name}. Please install the 'psycopg2' (or 'psycopg' if you are using Django>=4.2) library from 'pip'".format(
                 name=self.__class__.__name__
             )
 
@@ -301,15 +293,15 @@ class DateRangeField(RangeField):
     range_type = DateRange
 
 
-if postgres_fields:
+if compat.postgres_fields:
     # monkey patch modelserializer to map Native django Range fields to
     # drf_extra_fiels's Range fields.
-    ModelSerializer.serializer_field_mapping[postgres_fields.DateTimeRangeField] = DateTimeRangeField
-    ModelSerializer.serializer_field_mapping[postgres_fields.DateRangeField] = DateRangeField
-    ModelSerializer.serializer_field_mapping[postgres_fields.IntegerRangeField] = IntegerRangeField
-    ModelSerializer.serializer_field_mapping[postgres_fields.DecimalRangeField] = DecimalRangeField
-    if compat.FloatRangeField:
-        ModelSerializer.serializer_field_mapping[compat.FloatRangeField] = FloatRangeField
+    ModelSerializer.serializer_field_mapping[compat.postgres_fields.DateTimeRangeField] = DateTimeRangeField
+    ModelSerializer.serializer_field_mapping[compat.postgres_fields.DateRangeField] = DateRangeField
+    ModelSerializer.serializer_field_mapping[compat.postgres_fields.IntegerRangeField] = IntegerRangeField
+    ModelSerializer.serializer_field_mapping[compat.postgres_fields.DecimalRangeField] = DecimalRangeField
+    if hasattr(compat.postgres_fields, "FloatRangeField"):
+        ModelSerializer.serializer_field_mapping[compat.postgres_fields.FloatRangeField] = FloatRangeField
 
 
 class LowercaseEmailField(EmailField):

requirements_dev.txt

@@ -1,5 +1,4 @@
 Pillow >= 6.2.1
 pytest-django
 pytest-cov
-psycopg2-binary
 flake8

tests/test_fields.py

@@ -1,32 +1,32 @@
 import base64
 import copy
 import datetime
-import django
 import os
 from decimal import Decimal
+from unittest.mock import patch
 
+import django
 import pytest
 import pytz
 from django.core.exceptions import ValidationError
 from django.test import TestCase, override_settings
-from unittest.mock import patch
-from psycopg2._range import NumericRange, DateTimeTZRange, DateRange
 from rest_framework import serializers
 from rest_framework.fields import DecimalField
 
+from drf_extra_fields import compat
+from drf_extra_fields.compat import DateRange, DateTimeTZRange, NumericRange
 from drf_extra_fields.fields import (
-    Base64ImageField,
     Base64FileField,
+    Base64ImageField,
     DateRangeField,
     DateTimeRangeField,
+    DecimalRangeField,
     FloatRangeField,
     HybridImageField,
     IntegerRangeField,
     LowercaseEmailField,
-    DecimalRangeField,
 )
 from drf_extra_fields.geo_fields import PointField
-from drf_extra_fields import compat
 
 
 class UploadedBase64Image:
@@ -417,7 +417,7 @@ class DateTimeRangeSerializer(serializers.Serializer):
 
 class DateRangeSerializer(serializers.Serializer):
 
-    range = DateRangeField(initial=DateRange(None, None))
+    range = DateRangeField(initial=DateRange(None, None, '()'))
 
 
 class DateRangeWithAllowEmptyFalseSerializer(serializers.Serializer):
@@ -504,7 +504,7 @@ class TestIntegerRangeField(FieldValues):
         (NumericRange(**{'lower': '1', 'upper': '2'}),
          {'lower': 1, 'upper': 2, 'bounds': '[)'}),
         (NumericRange(**{'empty': True}), {'empty': True}),
-        (NumericRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (NumericRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': '1', 'upper': 2, 'bounds': '[)'},
          {'lower': 1, 'upper': 2, 'bounds': '[)'}),
         ({'lower': 1, 'upper': 2},
@@ -557,7 +557,7 @@ class TestIntegerRangeChildAllowNullField(FieldValues):
         (NumericRange(**{'lower': '1', 'upper': '2'}),
          {'lower': 1, 'upper': 2, 'bounds': '[)'}),
         (NumericRange(**{'empty': True}), {'empty': True}),
-        (NumericRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (NumericRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': '1', 'upper': 2, 'bounds': '[)'},
          {'lower': 1, 'upper': 2, 'bounds': '[)'}),
         ({'lower': 1, 'upper': 2},
@@ -596,7 +596,7 @@ class TestDecimalRangeField(FieldValues):
         (NumericRange(**{'lower': '1.1', 'upper': '2'}),
          {'lower': '1.1', 'upper': '2', 'bounds': '[)'}),
         (NumericRange(**{'empty': True}), {'empty': True}),
-        (NumericRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (NumericRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': Decimal('1.1'), 'upper': "2.3", 'bounds': '[)'},
          {'lower': "1.1", 'upper': "2.3", 'bounds': '[)'}),
         ({'lower': Decimal('1.1'), 'upper': "2.3"},
@@ -647,7 +647,7 @@ class TestDecimalRangeFieldWithChildAttribute(FieldValues):
         (NumericRange(**{'lower': '1.1', 'upper': '2'}),
          {'lower': '1.10', 'upper': '2.00', 'bounds': '[)'}),
         (NumericRange(**{'empty': True}), {'empty': True}),
-        (NumericRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (NumericRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': Decimal('1.1'), 'upper': "2.3", 'bounds': '[)'},
          {'lower': "1.10", 'upper': "2.30", 'bounds': '[)'}),
         ({'lower': Decimal('1.1'), 'upper': "2.3"},
@@ -660,7 +660,7 @@ class TestDecimalRangeFieldWithChildAttribute(FieldValues):
     ]
 
 
-@pytest.mark.skipif(django.VERSION >= (3, 1) or compat.FloatRangeField is None,
+@pytest.mark.skipif(django.VERSION >= (3, 1) or not hasattr(compat.postgres_fields, "FloatRangeField"),
                     reason='FloatRangeField deprecated on django 3.1 ')
 class TestFloatRangeField(FieldValues):
     """
@@ -690,7 +690,7 @@ class TestFloatRangeField(FieldValues):
         (NumericRange(**{'lower': '1.1', 'upper': '2'}),
          {'lower': 1.1, 'upper': 2, 'bounds': '[)'}),
         (NumericRange(**{'empty': True}), {'empty': True}),
-        (NumericRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (NumericRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': '1', 'upper': 2., 'bounds': '[)'},
          {'lower': 1., 'upper': 2., 'bounds': '[)'}),
         ({'lower': 1., 'upper': 2.},
@@ -760,8 +760,8 @@ class TestDateTimeRangeField(TestCase, FieldValues):
              'bounds': '[)'}),
         (DateTimeTZRange(**{'empty': True}),
          {'empty': True}),
-        (DateTimeTZRange(),
-         {'bounds': '[)', 'lower': None, 'upper': None}),
+        (DateTimeTZRange(bounds='()'),
+         {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': '2001-01-01T13:00:00Z',
           'upper': '2001-02-02T13:00:00Z',
           'bounds': '[)'},
@@ -838,7 +838,7 @@ class TestDateRangeField(FieldValues):
              'bounds': '[)'}),
         (DateRange(**{'empty': True}),
          {'empty': True}),
-        (DateRange(), {'bounds': '[)', 'lower': None, 'upper': None}),
+        (DateRange(bounds='()'), {'bounds': '()', 'lower': None, 'upper': None}),
         ({'lower': '2001-01-01',
           'upper': '2001-02-02',
           'bounds': '[)'},
@@ -870,7 +870,7 @@ def test_no_source_on_child(self):
 
     def test_initial_value_of_field(self):
         serializer = DateRangeSerializer()
-        assert serializer.data['range'] == {'lower': None, 'upper': None, 'bounds': '[)'}
+        assert serializer.data['range'] == {'lower': None, 'upper': None, 'bounds': '()'}
 
     def test_allow_empty(self):
         serializer = DateRangeWithAllowEmptyFalseSerializer(data={"range": {}})

tests/test_model_serializer.py

@@ -27,13 +27,13 @@ class Meta:
         app_label = 'tests'
 
 
-@pytest.mark.skipif(django.VERSION >= (3, 1) or compat.FloatRangeField is None,
+@pytest.mark.skipif(django.VERSION >= (3, 1) or not hasattr(compat.postgres_fields, "FloatRangeField"),
                     reason='FloatRangeField deprecated on django 3.1 ')
 class TestFloatRangeFieldMapping(TestCase):
 
     def test_float_range_field(self):
         class FloatRangeFieldModel(models.Model):
-            float_range_field = compat.FloatRangeField()
+            float_range_field = compat.postgres_fields.FloatRangeField()
 
             class Meta:
                 app_label = 'tests'

tox.ini

@@ -9,9 +9,10 @@ python =
 [tox]
 envlist =
     flake8,
-    py{37,38,39,310}-drf3-django{22,32}
-    py{38,39,310}-drf3-django40
-    py{38,39,310,311}-drf3-django{41,42}
+    py{37,38,39,310}-drf3-django{22,32}-psycopg2
+    py{38,39,310}-drf3-django40-psycopg2
+    py{38,39,310,311}-drf3-django{41,42}-psycopg2
+    py{38,39,310,311}-drf3-django42-psycopg3
 
 [testenv]
 deps =
@@ -21,6 +22,8 @@ deps =
     django41: Django>=4.1,<4.2
     django42: Django>=4.2,<4.3
     drf3: djangorestframework>=3
+    psycopg2: psycopg2-binary
+    psycopg3: psycopg[binary]
     -r requirements_dev.txt
 commands =
     py.test {posargs} --cov-report=xml --cov