feat: Switch to ruff formatter

Author: last-partizan

.github/workflows/test.yml

@@ -50,5 +50,5 @@ jobs:
       - name: Run tests
         run: |
           poetry run ruff .
-          poetry run black --check .
+          poetry run ruff format --check .
           poetry run python -m pytest

django_mongoengine/__init__.py

@@ -14,6 +14,6 @@
     from django import VERSION as _django_version
 
     if _django_version < (3, 2):
-        default_app_config = 'django_mongoengine.apps.DjangoMongoEngineConfig'
+        default_app_config = "django_mongoengine.apps.DjangoMongoEngineConfig"
 except ImportError:
     pass

django_mongoengine/apps.py

@@ -7,11 +7,11 @@
 class DjangoMongoEngineConfig(AppConfig):
     """Simple AppConfig which does not do automatic discovery."""
 
-    name = 'django_mongoengine'
+    name = "django_mongoengine"
     verbose_name = "Django-MongoEngine"
 
     def ready(self):
-        if not hasattr(settings, 'MONGODB_DATABASES'):
+        if not hasattr(settings, "MONGODB_DATABASES"):
             raise ImproperlyConfigured("Missing `MONGODB_DATABASES` in settings.py")
 
         for alias, conn_settings in settings.MONGODB_DATABASES.items():

django_mongoengine/document.py

@@ -35,15 +35,15 @@ def __new__(cls, name, bases, attrs):
             else:
                 new_bases = ()
                 for b in bases:
-                    if getattr(b, 'swap_base', False):
+                    if getattr(b, "swap_base", False):
                         new_bases += top_bases
                     else:
                         new_bases += (b,)
             new_cls = meta.__new__(cls, name, new_bases, attrs)
             new_cls._meta = DocumentMetaWrapper(new_cls)
             return new_cls
 
-    return type.__new__(metaclass, 'temporary_meta', (), {})
+    return type.__new__(metaclass, "temporary_meta", (), {})
 
 
 class DjangoFlavor:

django_mongoengine/fields/djangoflavor.py

@@ -57,7 +57,7 @@ def __init__(self, *args, **kwargs):
         self.blank = not self.required
 
     def _get_verbose_name(self):
-        return self._verbose_name or self.db_field.replace('_', ' ')
+        return self._verbose_name or self.db_field.replace("_", " ")
 
     def _set_verbose_name(self, val):
         self._verbose_name = val
@@ -70,23 +70,23 @@ def formfield(self, form_class=None, choices_form_class=None, **kwargs):
         """
 
         defaults = {
-            'required': self.required,
-            'label': capfirst(self.verbose_name),
-            'help_text': self.help_text,
+            "required": self.required,
+            "label": capfirst(self.verbose_name),
+            "help_text": self.help_text,
         }
         if self.default:
             if callable(self.default):
-                defaults['initial'] = self.default
-                defaults['show_hidden_initial'] = True
+                defaults["initial"] = self.default
+                defaults["show_hidden_initial"] = True
             else:
-                defaults['initial'] = self.default
+                defaults["initial"] = self.default
         if self.choices:
             # Fields with choices get special treatment.
-            include_blank = self.blank or not (self.default or 'initial' in kwargs)
-            defaults['choices'] = self.get_choices(include_blank=include_blank)
-            defaults['coerce'] = self.to_python
+            include_blank = self.blank or not (self.default or "initial" in kwargs)
+            defaults["choices"] = self.get_choices(include_blank=include_blank)
+            defaults["coerce"] = self.to_python
             if self.null:
-                defaults['empty_value'] = None
+                defaults["empty_value"] = None
             if choices_form_class is not None:
                 form_class = choices_form_class
             else:
@@ -96,16 +96,16 @@ def formfield(self, form_class=None, choices_form_class=None, **kwargs):
             # the values that TypedChoiceField will understand.
             for k in list(kwargs):
                 if k not in (
-                    'coerce',
-                    'empty_value',
-                    'choices',
-                    'required',
-                    'widget',
-                    'label',
-                    'initial',
-                    'help_text',
-                    'error_messages',
-                    'show_hidden_initial',
+                    "coerce",
+                    "empty_value",
+                    "choices",
+                    "required",
+                    "widget",
+                    "label",
+                    "initial",
+                    "help_text",
+                    "error_messages",
+                    "show_hidden_initial",
                 ):
                     del kwargs[k]
         defaults.update(kwargs)
@@ -150,13 +150,13 @@ def formfield(self, form_class=forms.CharField, choices_form_class=None, **kwarg
         defaults = {}
 
         if self.max_length and not self.choices:
-            defaults['max_length'] = self.max_length
+            defaults["max_length"] = self.max_length
 
         if self.max_length is None and not self.choices:
-            defaults['widget'] = forms.Textarea
+            defaults["widget"] = forms.Textarea
 
         if self.regex:
-            defaults['regex'] = self.regex
+            defaults["regex"] = self.regex
 
         defaults.update(kwargs)
         return super().formfield(form_class, choices_form_class, **defaults)
@@ -165,12 +165,12 @@ def formfield(self, form_class=forms.CharField, choices_form_class=None, **kwarg
 class EmailField(StringField):
     def __init__(self, *args, **kwargs):
         # max_length=254 to be compliant with RFCs 3696 and 5321
-        kwargs['max_length'] = kwargs.get('max_length', 254)
+        kwargs["max_length"] = kwargs.get("max_length", 254)
         super().__init__(*args, **kwargs)
 
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': forms.EmailField,
+            "form_class": forms.EmailField,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -179,7 +179,7 @@ def formfield(self, **kwargs):
 class URLField(StringField):
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': forms.URLField,
+            "form_class": forms.URLField,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -188,8 +188,8 @@ def formfield(self, **kwargs):
 class MinMaxMixin:
     def formfield(self, **kwargs):
         defaults = {
-            'min_value': self.min_value,
-            'max_value': self.max_value,
+            "min_value": self.min_value,
+            "max_value": self.max_value,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -198,7 +198,7 @@ def formfield(self, **kwargs):
 class IntField(MinMaxMixin, DjangoField):
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': forms.IntegerField,
+            "form_class": forms.IntegerField,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -207,7 +207,7 @@ def formfield(self, **kwargs):
 class FloatField(MinMaxMixin, DjangoField):
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': forms.FloatField,
+            "form_class": forms.FloatField,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -216,9 +216,9 @@ def formfield(self, **kwargs):
 class DecimalField(MinMaxMixin, DjangoField):
     def formfield(self, **kwargs):
         defaults = {
-            'max_digits': self.max_digits,
-            'decimal_places': self.precision,
-            'form_class': forms.DecimalField,
+            "max_digits": self.max_digits,
+            "decimal_places": self.precision,
+            "form_class": forms.DecimalField,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -229,34 +229,34 @@ def formfield(self, **kwargs):
 
 class BooleanField(DjangoField):
     def __init__(self, *args, **kwargs):
-        kwargs['blank'] = True
+        kwargs["blank"] = True
 
         super().__init__(*args, **kwargs)
 
     def formfield(self, **kwargs):
         # Unlike most fields, BooleanField figures out include_blank from
         # self.null instead of self.blank.
         if self.choices:
-            include_blank = not (self.default or 'initial' in kwargs)
-            defaults = {'choices': self.get_choices(include_blank=include_blank)}
+            include_blank = not (self.default or "initial" in kwargs)
+            defaults = {"choices": self.get_choices(include_blank=include_blank)}
         else:
-            defaults = {'form_class': forms.BooleanField}
+            defaults = {"form_class": forms.BooleanField}
         defaults.update(kwargs)
         return super().formfield(**defaults)
 
 
 class DateTimeField(DjangoField):
     def formfield(self, **kwargs):
-        defaults = {'form_class': forms.DateTimeField}
+        defaults = {"form_class": forms.DateTimeField}
         defaults.update(kwargs)
         return super().formfield(**defaults)
 
 
 class ReferenceField(DjangoField):
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': formfields.ReferenceField,
-            'queryset': self.document_type.objects,
+            "form_class": formfields.ReferenceField,
+            "queryset": self.document_type.objects,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)
@@ -267,14 +267,14 @@ class ListField(DjangoField):
     def formfield(self, **kwargs):
         if self.field.choices:
             defaults = {
-                'choices': self.field.choices,
-                'widget': forms.CheckboxSelectMultiple,
-                'form_class': forms.MultipleChoiceField,
+                "choices": self.field.choices,
+                "widget": forms.CheckboxSelectMultiple,
+                "form_class": forms.MultipleChoiceField,
             }
         elif isinstance(self.field, fields.ReferenceField):
             defaults = {
-                'form_class': formfields.DocumentMultipleChoiceField,
-                'queryset': self.field.document_type.objects,  # type: ignore
+                "form_class": formfields.DocumentMultipleChoiceField,
+                "queryset": self.field.document_type.objects,  # type: ignore
             }
         else:
             defaults = {}
@@ -285,25 +285,25 @@ def formfield(self, **kwargs):
 
 class FileField(DjangoField):
     def __init__(self, *args, **kwargs):
-        kwargs['max_length'] = kwargs.get('max_length', 100)
+        kwargs["max_length"] = kwargs.get("max_length", 100)
         super().__init__(*args, **kwargs)
 
     def formfield(self, **kwargs):
-        defaults = {'form_class': forms.FileField, 'max_length': self.max_length}
+        defaults = {"form_class": forms.FileField, "max_length": self.max_length}
         # If a file has been provided previously, then the form doesn't require
         # that a new file is provided this time.
         # The code to mark the form field as not required is used by
         # form_for_instance, but can probably be removed once form_for_instance
         # is gone. ModelForm uses a different method to check for an existing file.
-        if 'initial' in kwargs:
-            defaults['required'] = False
+        if "initial" in kwargs:
+            defaults["required"] = False
         defaults.update(kwargs)
         return super().formfield(**defaults)
 
 
 class ImageField(FileField):
     def formfield(self, **kwargs):
-        defaults = {'form_class': forms.ImageField}
+        defaults = {"form_class": forms.ImageField}
         defaults.update(kwargs)
         return super().formfield(**defaults)
 
@@ -313,14 +313,14 @@ def formfield(self, **kwargs):
         # remove Mongo reserved words
         validators = [
             RegexValidator(
-                regex='^[^$_]',
+                regex="^[^$_]",
                 message='Ensure the keys do not begin with : ["$","_"].',
-                code='invalid_start',
+                code="invalid_start",
             )
         ]
         defaults = {
-            'validators': validators,
-            'form_class': formfields.DictField,
+            "validators": validators,
+            "form_class": formfields.DictField,
         }
         return super().formfield(**defaults)
 
@@ -330,8 +330,8 @@ def formfield(self, **kwargs):
         from django_mongoengine.forms.documents import documentform_factory
 
         defaults = {
-            'label': self.label,
-            'help_text': self.help_text,
+            "label": self.label,
+            "help_text": self.help_text,
         }
         form_class = EmbeddedDocumentField
         defaults.update(kwargs)