build: update build systems and lint

Author: EduardoJM

.github/workflows/lint.yml

@@ -0,0 +1,13 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

.github/workflows/test.yml

@@ -50,9 +50,8 @@ jobs:
     - name: Install Dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install .[test]
         pip install psycopg2
-        pip install playwright
         pip install django==${{ matrix.django-version }}
         
     - name: Ensure browsers are installed

.gitignore

@@ -5,3 +5,4 @@ __pycache__
 media/
 build
 *.egg-info
+dist

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.3.0
+    hooks:
+    - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort

image_uploader_widget/admin.py

@@ -1,8 +1,9 @@
 from django import forms
 from django.contrib import admin
 
+
 class ImageUploaderInline(admin.StackedInline):
-    template = 'admin/edit_inline/image_uploader.html'
+    template = "admin/edit_inline/image_uploader.html"
     extra = 0
     add_image_text = ""
     drop_text = ""
@@ -17,19 +18,19 @@ def get_add_image_text(self):
 
     def get_drop_text(self):
         return self.drop_text
-    
+
     def get_empty_text(self):
         return self.empty_text
 
     def get_empty_icon(self):
         return self.empty_icon
-    
+
     def get_drop_icon(self):
         return self.drop_icon
 
     def get_add_icon(self):
         return self.add_icon
-    
+
     def get_accept(self):
         return self.accept
 
@@ -47,26 +48,29 @@ def get_formset(self, request, obj=None, **kwargs):
     @property
     def media(self):
         return forms.Media(
-            js = [
-                'admin/js/image-uploader-modal.js',
-                'admin/js/image-uploader-inline.js',
+            js=[
+                "admin/js/image-uploader-modal.js",
+                "admin/js/image-uploader-inline.js",
             ],
-            css = {
-                'screen': [
-                    'admin/css/image-uploader-inline.css',
+            css={
+                "screen": [
+                    "admin/css/image-uploader-inline.css",
                 ]
-            }
+            },
         )
 
+
 class OrderedImageUploaderInline(ImageUploaderInline):
-    template = 'admin/edit_inline/ordered_image_uploader.html'
+    template = "admin/edit_inline/ordered_image_uploader.html"
     order_field = "order"
 
     def get_order_field(self, request):
         return self.order_field
-    
+
     def get_formset(self, request, obj=None, **kwargs):
-        item = super(OrderedImageUploaderInline, self).get_formset(request, obj, **kwargs)
+        item = super(OrderedImageUploaderInline, self).get_formset(
+            request, obj, **kwargs
+        )
         item.order_field = self.get_order_field(request)
         return item
 

image_uploader_widget/postgres/fields.py

@@ -1,29 +1,32 @@
+import datetime
 import os
 import pathlib
-import datetime
-from typing import Optional
 import posixpath
+from typing import Optional
+
+from django.contrib.postgres.fields import ArrayField
 from django.core.exceptions import SuspiciousFileOperation
+from django.core.files.storage import Storage, default_storage
 from django.db.models import ImageField
-from django.contrib.postgres.fields import ArrayField
 from django.db.models.fields.files import FieldFile
-from django.core.files.storage import default_storage, Storage
+
 from .forms import ImageListFormField
 
+
 def validate_file_name(name, allow_relative_path=False):
     # TODO: when drop support for django 3.2, remove this function
     # and import from django
-    
+
     # Remove potentially dangerous names
-    if os.path.basename(name) in {'', '.', '..'}:
+    if os.path.basename(name) in {"", ".", ".."}:
         raise SuspiciousFileOperation("Could not derive file name from '%s'" % name)
 
     if allow_relative_path:
         # Use PurePosixPath() because this branch is checked only in
         # FileField.generate_filename() where all file paths are expected to be
         # Unix style (with forward slashes).
         path = pathlib.PurePosixPath(name)
-        if path.is_absolute() or '..' in path.parts:
+        if path.is_absolute() or ".." in path.parts:
             raise SuspiciousFileOperation(
                 "Detected path traversal attempt in '%s'" % name
             )
@@ -40,12 +43,14 @@ def __init__(
         max_length: int = 150,
         storage: Optional[Storage] = None,
         upload_to: str = "",
-        **kwargs
+        **kwargs,
     ):
         self.max_length = max_length or 150
         self.storage = storage or default_storage
         self.upload_to = upload_to or ""
-        kwargs['base_field'] = ImageField(max_length=self.max_length, upload_to=upload_to)
+        kwargs["base_field"] = ImageField(
+            max_length=self.max_length, upload_to=upload_to
+        )
         super().__init__(
             *args,
             **kwargs,
@@ -63,7 +68,7 @@ def deconstruct(self):
             }
         )
         return name, path, args, kwargs
-    
+
     def generate_filename(self, instance, filename):
         """
         Apply (if callable) or prepend (if a string) upload_to to the filename,
@@ -78,11 +83,11 @@ def generate_filename(self, instance, filename):
             filename = posixpath.join(dirname, filename)
         filename = validate_file_name(filename, allow_relative_path=True)
         return self.storage.generate_filename(filename)
-    
+
     def _get_file(self, instance, file):
         if isinstance(file, str):
             return FieldFile(instance, self, file)
-        
+
         field_file = FieldFile(instance, self, file.name)
         field_file.file = file
         field_file._committed = False
@@ -97,7 +102,7 @@ def pre_save(self, model_instance, add):
                 file.save(file.name, file.file, save=False)
 
         return value
-    
+
     def save_form_data(self, instance, data):
         if not data:
             data = []

image_uploader_widget/postgres/forms.py

@@ -1,18 +1,21 @@
 from itertools import chain
+
 from django import forms
-from django.core.exceptions import ValidationError
 from django.contrib.postgres.utils import prefix_validation_error
+from django.core.exceptions import ValidationError
 from django.utils.translation import gettext_lazy as _
+
 from .widget import ImageUploaderArrayWidget
 
+
 class ImageListFormField(forms.Field):
     default_error_messages = {
         "item_invalid": _("Item %(name)s in the array did not validate:"),
     }
-    
+
     def __init__(self, **kwargs):
-        kwargs.pop('base_field')
-        self.max_length = kwargs.pop('max_length') or 150
+        kwargs.pop("base_field")
+        self.max_length = kwargs.pop("max_length") or 150
 
         self.required = False
         self.base_field = forms.ImageField(max_length=self.max_length)
@@ -45,7 +48,7 @@ def clean(self, value):
                         error,
                         self.error_messages["item_invalid"],
                         code="item_invalid",
-                        params={ "name": file_name },
+                        params={"name": file_name},
                     )
                 )
                 cleaned_data.append(None)
@@ -66,4 +69,3 @@ def has_changed(self, initial, data):
             if initial in self.empty_values and data in self.empty_values:
                 return False
         return super().has_changed(initial, data)
-

image_uploader_widget/postgres/widget.py

@@ -1,9 +1,11 @@
 import json
 from typing import Any, List
+
 from django import forms
 from django.contrib.postgres.forms import SplitArrayWidget
-from django.core.files.uploadedfile import InMemoryUploadedFile
 from django.core.files.storage import default_storage
+from django.core.files.uploadedfile import InMemoryUploadedFile
+
 
 class ImageUploaderArrayWidget(SplitArrayWidget):
     template_name = "postgres/widgets/image_array.html"
@@ -14,23 +16,18 @@ class ImageUploaderArrayWidget(SplitArrayWidget):
 
     def get_drop_text(self):
         return self.drop_text
-    
+
     def get_empty_text(self):
         return self.empty_text
 
     def get_empty_icon(self):
         return self.empty_icon
-    
+
     def get_drop_icon(self):
         return self.drop_icon
 
     def __init__(
-        self,
-        drop_text = "",
-        empty_text = "",
-        empty_icon = "",
-        drop_icon = "",
-        **kwargs
+        self, drop_text="", empty_text="", empty_icon="", drop_icon="", **kwargs
     ):
         self.drop_text = drop_text
         self.empty_text = empty_text
@@ -48,48 +45,49 @@ def _get_image(self, path):
     def get_files_from_value(self, value: Any) -> List[str]:
         return [self._get_image(name) for name in value]
 
-    def get_context(self, name, value, attrs = None):
+    def get_context(self, name, value, attrs=None):
         value_raw = value or []
         value = list(filter(None, self.get_files_from_value([*value_raw])))
         self.size = len(value)
-        
+
         context = super(ImageUploaderArrayWidget, self).get_context(name, value, attrs)
         if not context:
             context = {}
 
         for i in range(0, len(value)):
-            context['widget']['subwidgets'][i]['value'] = value[i]
-            context['widget']['subwidgets'][i]['value_raw'] = value_raw[i]
-
+            context["widget"]["subwidgets"][i]["value"] = value[i]
+            context["widget"]["subwidgets"][i]["value_raw"] = value_raw[i]
 
         return {
             **context,
-            'inline_admin_formset': {
-                'inline_formset_data': json.dumps({
-                    'name': context['widget']['name'],
-                    'options': {
-                        'prefix': context['widget']['name'],
+            "inline_admin_formset": {
+                "inline_formset_data": json.dumps(
+                    {
+                        "name": context["widget"]["name"],
+                        "options": {
+                            "prefix": context["widget"]["name"],
+                        },
                     }
-                }),
-                'formset': {
-                    'prefix': context['widget']['name'],
+                ),
+                "formset": {
+                    "prefix": context["widget"]["name"],
                 },
             },
             "custom": {
                 "drop_text": self.get_drop_text(),
                 "empty_text": self.get_empty_text(),
                 "empty_icon": self.get_empty_icon(),
                 "drop_icon": self.get_drop_icon(),
-            }
+            },
         }
-    
+
     def value_from_datadict(self, data, files, name):
-        total_forms = int(data.get('images-TOTAL_FORMS'))
+        total_forms = int(data.get("images-TOTAL_FORMS"))
         result = []
         for i in range(0, total_forms):
-            image_file = files.get(f'images-{i}-image')
-            image_raw = data.get(f'images-{i}-RAW')
-            image_delete = data.get(f'images-{i}-DELETE')
+            image_file = files.get(f"images-{i}-image")
+            image_raw = data.get(f"images-{i}-RAW")
+            image_delete = data.get(f"images-{i}-DELETE")
             if image_delete:
                 continue
 
@@ -103,17 +101,15 @@ def value_from_datadict(self, data, files, name):
     @property
     def needs_multipart_form(self):
         return True
-    
+
     @property
     def media(self):
         return forms.Media(
             js=(
-                'admin/js/image-uploader-modal.js',
-                'admin/js/image-uploader-inline.js',
+                "admin/js/image-uploader-modal.js",
+                "admin/js/image-uploader-inline.js",
             ),
             css={
-                'screen': (
-                    'admin/css/image-uploader-inline.css',
-                ),
+                "screen": ("admin/css/image-uploader-inline.css",),
             },
-        )
+        )