Replace flake8 and black with ruff

Author: mattiagiupponi

.github/workflows/flake8.yml .github/workflows/ruff.yml.github/workflows/flake8.yml renamed to .github/workflows/ruff.yml

@@ -2,10 +2,10 @@ name: "Code formatting"
 
 on:
   push:
-    branches: [ master, 4.* ]
+    branches: [ master, 5.* ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master, 4.* ]
+    branches: [ master, 5.* ]
 
 jobs:
   validate:
@@ -27,15 +27,10 @@ jobs:
       with:
         python-version: ${{matrix.python-version}}
 
-    - name: Install flake8 & black
-      run: pip install $(grep -E '"(flake8|black)==[^"]+"' pyproject.toml | sed -E 's/^[^"]*"//; s/".*$//; s/,//')
+    - name: Install ruff
+      run: pip install $(grep "ruff==" pyproject.toml | sed -E 's/^[^"]*"//; s/".*$//; s/,//')
 
-    - name: "Check: flake8"
+    - name: "Check: ruff"
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 geonode --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 geonode --count --statistics
-
-    - name: "Check: black"
-      run: black --check geonode
+        ruff check

create-envfile.py

@@ -74,25 +74,47 @@ def _get_vals_to_replace(args):
             with open(args.file) as _json_file:
                 _jsfile = json.load(_json_file)
 
-        _vals_to_replace = {key: _jsfile.get(key, val) for key, val in vars(args).items() if key not in _config}
-        tcp = "https" if ast.literal_eval(f"{_jsfile.get('https', args.https)}".capitalize()) else "http"
+        _vals_to_replace = {
+            key: _jsfile.get(key, val)
+            for key, val in vars(args).items()
+            if key not in _config
+        }
+        tcp = (
+            "https"
+            if ast.literal_eval(f"{_jsfile.get('https', args.https)}".capitalize())
+            else "http"
+        )
 
         _vals_to_replace["public_port"] = (
-            "443" if ast.literal_eval(f"{_jsfile.get('https', args.https)}".capitalize()) else "80"
+            "443"
+            if ast.literal_eval(f"{_jsfile.get('https', args.https)}".capitalize())
+            else "80"
+        )
+        _vals_to_replace["http_host"] = (
+            _jsfile.get("hostname", args.hostname) if tcp == "http" else ""
+        )
+        _vals_to_replace["https_host"] = (
+            _jsfile.get("hostname", args.hostname) if tcp == "https" else ""
         )
-        _vals_to_replace["http_host"] = _jsfile.get("hostname", args.hostname) if tcp == "http" else ""
-        _vals_to_replace["https_host"] = _jsfile.get("hostname", args.hostname) if tcp == "https" else ""
 
-        _vals_to_replace["siteurl"] = f"{tcp}://{_jsfile.get('hostname', args.hostname)}"
-        _vals_to_replace["secret_key"] = _jsfile.get("secret_key", args.secret_key) or "".join(
-            random.choice(_strong_chars) for _ in range(50)
+        _vals_to_replace["siteurl"] = (
+            f"{tcp}://{_jsfile.get('hostname', args.hostname)}"
         )
+        _vals_to_replace["secret_key"] = _jsfile.get(
+            "secret_key", args.secret_key
+        ) or "".join(random.choice(_strong_chars) for _ in range(50))
         _vals_to_replace["letsencrypt_mode"] = (
             "disabled"
             if not _vals_to_replace.get("https_host")
-            else "staging" if _jsfile.get("env_type", args.env_type) in ["test"] else "production"
+            else "staging"
+            if _jsfile.get("env_type", args.env_type) in ["test"]
+            else "production"
+        )
+        _vals_to_replace["debug"] = (
+            False
+            if _jsfile.get("env_type", args.env_type) in ["prod", "test"]
+            else True
         )
-        _vals_to_replace["debug"] = False if _jsfile.get("env_type", args.env_type) in ["prod", "test"] else True
         _vals_to_replace["email"] = _jsfile.get("email", args.email)
 
         if tcp == "https" and not _vals_to_replace["email"]:
@@ -149,9 +171,13 @@ def _get_vals_to_replace(args):
         help="absolute path of the file with the configuration. Note: we expect that the keys of the dictionary have the same name as the CLI params",
     )
     # booleans
-    parser.add_argument("--https", action="store_true", default=False, help="If provided, https is used")
+    parser.add_argument(
+        "--https", action="store_true", default=False, help="If provided, https is used"
+    )
     # strings
-    parser.add_argument("--email", help="Admin email, this field is required if https is enabled")
+    parser.add_argument(
+        "--email", help="Admin email, this field is required if https is enabled"
+    )
 
     parser.add_argument("--geonodepwd", help="GeoNode admin password")
     parser.add_argument("--geoserverpwd", help="Geoserver admin password")
@@ -174,7 +200,9 @@ def _get_vals_to_replace(args):
     if not args.confirmation:
         generate_env_file(args)
     else:
-        overwrite_env = input("This action will overwrite any existing .env file. Do you wish to continue? (y/n)")
+        overwrite_env = input(
+            "This action will overwrite any existing .env file. Do you wish to continue? (y/n)"
+        )
         if overwrite_env not in ["y", "n"]:
             logger.error("Please enter a valid response")
         if overwrite_env == "y":

geonode/api/api.py

@@ -96,7 +96,11 @@ def get_resources_counts(self, options):
                         if hasattr(app, "default_model"):
                             _model = apps.get_model(label, app.default_model)
                             if issubclass(_model, _type_filter):
-                                subtypes.append(resources.filter(polymorphic_ctype__model=_model.__name__.lower()))
+                                subtypes.append(
+                                    resources.filter(
+                                        polymorphic_ctype__model=_model.__name__.lower()
+                                    )
+                                )
 
                 if not isinstance(_type_filter, str):
                     _type_filter = _type_filter.__name__.lower()
@@ -105,9 +109,19 @@ def get_resources_counts(self, options):
         counts = list()
         if subtypes:
             for subtype in subtypes:
-                counts.extend(list(subtype.values(options["count_type"]).annotate(count=Count(options["count_type"]))))
+                counts.extend(
+                    list(
+                        subtype.values(options["count_type"]).annotate(
+                            count=Count(options["count_type"])
+                        )
+                    )
+                )
         else:
-            counts = list(resources.values(options["count_type"]).annotate(count=Count(options["count_type"])))
+            counts = list(
+                resources.values(options["count_type"]).annotate(
+                    count=Count(options["count_type"])
+                )
+            )
 
         _counts = {}
         for c in counts:
@@ -222,7 +236,9 @@ def dehydrate_thesaurus_identifier(self, bundle):
 
     def dehydrate(self, bundle):
         lang = get_language()
-        label = ThesaurusKeywordLabel.objects.filter(keyword=bundle.data["id"]).filter(lang=lang)
+        label = ThesaurusKeywordLabel.objects.filter(keyword=bundle.data["id"]).filter(
+            lang=lang
+        )
         if label.exists():
             bundle.data["label_id"] = label.get().id
             bundle.data["label"] = label.get().label
@@ -233,7 +249,11 @@ def dehydrate(self, bundle):
         return bundle
 
     class Meta:
-        queryset = ThesaurusKeyword.objects.all().order_by("alt_label").select_related("thesaurus")
+        queryset = (
+            ThesaurusKeyword.objects.all()
+            .order_by("alt_label")
+            .select_related("thesaurus")
+        )
 
         resource_name = "thesaurus/keywords"
         allowed_methods = ["get"]
@@ -276,10 +296,12 @@ class TopicCategoryResource(TypeFilteredResource):
 
     def dehydrate_datasets_count(self, bundle):
         request = bundle.request
-        obj_with_perms = get_objects_for_user(request.user, "base.view_resourcebase").filter(
-            polymorphic_ctype__model="dataset"
-        )
-        filter_set = bundle.obj.resourcebase_set.filter(id__in=obj_with_perms.values("id")).filter(metadata_only=False)
+        obj_with_perms = get_objects_for_user(
+            request.user, "base.view_resourcebase"
+        ).filter(polymorphic_ctype__model="dataset")
+        filter_set = bundle.obj.resourcebase_set.filter(
+            id__in=obj_with_perms.values("id")
+        ).filter(metadata_only=False)
 
         if not settings.SKIP_PERMS_FILTER:
             filter_set = get_visible_resources(
@@ -345,7 +367,8 @@ def dehydrate(self, bundle):
         """Provide additional resource counts"""
         request = bundle.request
         counts = _get_resource_counts(
-            request, resourcebase_filter_kwargs={"group__groupprofile__categories": bundle.obj}
+            request,
+            resourcebase_filter_kwargs={"group__groupprofile__categories": bundle.obj},
         )
         bundle.data.update(resource_counts=counts)
         return bundle
@@ -390,7 +413,9 @@ def dehydrate_logo_url(self, bundle):
 
 
 class GroupResource(ModelResource):
-    group_profile = fields.ToOneField(GroupProfileResource, "groupprofile", full=True, null=True, blank=True)
+    group_profile = fields.ToOneField(
+        GroupProfileResource, "groupprofile", full=True, null=True, blank=True
+    )
     resource_counts = fields.CharField()
 
     class Meta:
@@ -408,7 +433,10 @@ class Meta:
     def dehydrate(self, bundle):
         """Provide additional resource counts"""
         request = bundle.request
-        counts = _get_resource_counts(request, resourcebase_filter_kwargs={"group": bundle.obj, "metadata_only": False})
+        counts = _get_resource_counts(
+            request,
+            resourcebase_filter_kwargs={"group": bundle.obj, "metadata_only": False},
+        )
 
         bundle.data.update(resource_counts=counts)
         return bundle
@@ -477,9 +505,9 @@ def dehydrate_email(self, bundle):
         return email
 
     def dehydrate_datasets_count(self, bundle):
-        obj_with_perms = get_objects_for_user(bundle.request.user, "base.view_resourcebase").filter(
-            polymorphic_ctype__model="dataset"
-        )
+        obj_with_perms = get_objects_for_user(
+            bundle.request.user, "base.view_resourcebase"
+        ).filter(polymorphic_ctype__model="dataset")
         return (
             bundle.obj.resourcebase_set.filter(id__in=obj_with_perms.values("id"))
             .filter(metadata_only=False)
@@ -488,9 +516,9 @@ def dehydrate_datasets_count(self, bundle):
         )
 
     def dehydrate_maps_count(self, bundle):
-        obj_with_perms = get_objects_for_user(bundle.request.user, "base.view_resourcebase").filter(
-            polymorphic_ctype__model="map"
-        )
+        obj_with_perms = get_objects_for_user(
+            bundle.request.user, "base.view_resourcebase"
+        ).filter(polymorphic_ctype__model="map")
         return (
             bundle.obj.resourcebase_set.filter(id__in=obj_with_perms.values("id"))
             .filter(metadata_only=False)
@@ -499,9 +527,9 @@ def dehydrate_maps_count(self, bundle):
         )
 
     def dehydrate_documents_count(self, bundle):
-        obj_with_perms = get_objects_for_user(bundle.request.user, "base.view_resourcebase").filter(
-            polymorphic_ctype__model="document"
-        )
+        obj_with_perms = get_objects_for_user(
+            bundle.request.user, "base.view_resourcebase"
+        ).filter(polymorphic_ctype__model="document")
         return (
             bundle.obj.resourcebase_set.filter(id__in=obj_with_perms.values("id"))
             .filter(metadata_only=False)
@@ -521,7 +549,10 @@ def dehydrate_current_user(self, bundle):
     def dehydrate_activity_stream_url(self, bundle):
         return reverse(
             "actstream_actor",
-            kwargs={"content_type_id": ContentType.objects.get_for_model(bundle.obj).pk, "object_id": bundle.obj.pk},
+            kwargs={
+                "content_type_id": ContentType.objects.get_for_model(bundle.obj).pk,
+                "object_id": bundle.obj.pk,
+            },
         )
 
     def dehydrate(self, bundle):
@@ -556,11 +587,20 @@ def serialize(self, request, data, format, options=None):
         return super().serialize(request, data, format, options)
 
     class Meta:
-        queryset = get_user_model().objects.exclude(Q(username="AnonymousUser") | Q(is_active=False))
+        queryset = get_user_model().objects.exclude(
+            Q(username="AnonymousUser") | Q(is_active=False)
+        )
         resource_name = "profiles"
         allowed_methods = ["get"]
         ordering = ["username", "date_joined"]
-        excludes = ["is_staff", "password", "is_superuser", "is_active", "last_login", "extra_data"]
+        excludes = [
+            "is_staff",
+            "password",
+            "is_superuser",
+            "is_active",
+            "last_login",
+            "extra_data",
+        ]
 
         filtering = {
             "username": ALL,
@@ -615,7 +655,14 @@ class Meta:
         resource_name = "owners"
         allowed_methods = ["get"]
         ordering = ["username", "date_joined"]
-        excludes = ["is_staff", "password", "is_superuser", "is_active", "last_login", "extra_data"]
+        excludes = [
+            "is_staff",
+            "password",
+            "is_superuser",
+            "is_active",
+            "last_login",
+            "extra_data",
+        ]
 
         filtering = {
             "username": ALL,
@@ -633,7 +680,9 @@ class GeoserverStyleResource(ModelResource):
     # dataset_default_style is polymorphic, so it will have many to many
     # relation
     layer = fields.ManyToManyField(
-        "geonode.api.resourcebase_api.LayerResource", attribute="dataset_default_style", null=True
+        "geonode.api.resourcebase_api.LayerResource",
+        attribute="dataset_default_style",
+        null=True,
     )
     version = fields.CharField(attribute="sld_version", null=True, blank=True)
     style_url = fields.CharField(attribute="sld_url")

geonode/api/authentication.py

@@ -28,7 +28,9 @@ class OAuthAuthentication(Authentication):
     def extract_auth_header(self, request):
         auth_header = None
         try:
-            auth_header = request.META.get("HTTP_AUTHORIZATION", request.META.get("HTTP_AUTHORIZATION2"))
+            auth_header = request.META.get(
+                "HTTP_AUTHORIZATION", request.META.get("HTTP_AUTHORIZATION2")
+            )
         except KeyError:
             pass
         return auth_header