black format, flake8

Author: marcanuy

dynamic_breadcrumbs/app_settings.py

@@ -1,22 +1,12 @@
 from django.conf import settings
 
-HOME_LABEL = getattr(
-    settings, "DYNAMIC_BREADCRUMBS_HOME_LABEL", "Home"
-)
-SHOW_AT_BASE_PATH = getattr(
-    settings, "DYNAMIC_BREADCRUMBS_SHOW_AT_BASE_PATH", False
-)
+HOME_LABEL = getattr(settings, "DYNAMIC_BREADCRUMBS_HOME_LABEL", "Home")
+SHOW_AT_BASE_PATH = getattr(settings, "DYNAMIC_BREADCRUMBS_SHOW_AT_BASE_PATH", False)
 
-SHOW_VERBOSE_NAME = getattr(
-    settings, "DYNAMIC_BREADCRUMBS_SHOW_VERBOSE_NAME", False
-)
+SHOW_VERBOSE_NAME = getattr(settings, "DYNAMIC_BREADCRUMBS_SHOW_VERBOSE_NAME", False)
 
-PATH_XSS_SAFE_MODE = getattr(
-    settings, "DYNAMIC_BREADCRUMBS_PATH_XSS_SAFE_MODE", True
-)
-PATH_MAX_DEPTH = getattr(
-    settings, "DYNAMIC_BREADCRUMBS_PATH_MAX_DEPTH", 5
-)
+PATH_XSS_SAFE_MODE = getattr(settings, "DYNAMIC_BREADCRUMBS_PATH_XSS_SAFE_MODE", True)
+PATH_MAX_DEPTH = getattr(settings, "DYNAMIC_BREADCRUMBS_PATH_MAX_DEPTH", 5)
 PATH_MAX_COMPONENT_LENGTH = getattr(
     settings, "DYNAMIC_BREADCRUMBS_PATH_MAX_COMPONENT_LENGTH", 50
 )

dynamic_breadcrumbs/context_processors.py

@@ -5,9 +5,9 @@ def breadcrumbs(request):
     """
     Add breadcrumbs dict to the context.
     """
-    breadcrumbs = Breadcrumbs(base_url=request.build_absolute_uri('/'), path=request.path)
+    breadcrumbs = Breadcrumbs(
+        base_url=request.build_absolute_uri("/"), path=request.path
+    )
 
     # Return a dictionary with the breadcrumbs data
-    return {
-        'breadcrumbs': breadcrumbs.as_list()
-    }
+    return {"breadcrumbs": breadcrumbs.as_list()}

dynamic_breadcrumbs/utils.py

@@ -8,7 +8,6 @@
 from django.urls import Resolver404, resolve
 
 from . import app_settings
-from django.conf import settings
 
 logger = logging.getLogger(__name__)
 
@@ -23,6 +22,7 @@ def sanitize_url(url):
         return ""
     return url
 
+
 def validate_path(path):
     """Validate the path to ensure it matches an expected pattern and is within allowed limits."""
     if not isinstance(path, str):
@@ -31,11 +31,11 @@ def validate_path(path):
 
     if app_settings.PATH_XSS_SAFE_MODE:
         # Ensure the path contains only alphanumeric characters, dashes, underscores, and slashes
-        if not re.match(r'^[a-zA-Z0-9_\-/]*$', path):
+        if not re.match(r"^[a-zA-Z0-9_\-/]*$", path):
             logger.warning("Invalid path provided: %s", path)
             return ""
 
-    components = path.split('/')
+    components = path.split("/")
     # Check path depth
     if len(components) > app_settings.PATH_MAX_DEPTH:
         logger.warning("Path depth exceeded for: %s", path)
@@ -49,6 +49,7 @@ def validate_path(path):
 
     return path
 
+
 class Breadcrumbs:
     def __init__(self, base_url="", path=None):
         self.base_url = sanitize_url(base_url)
@@ -109,8 +110,6 @@ def _fill_items(self):
             self.items.append(b_item)
 
 
-
-
 class BreadcrumbsItem:
     def __init__(self, name_raw, path, position, base_url=None):
         self.name_raw = escape(name_raw)  # Escape the raw name

tests/settings.py

@@ -1,4 +1,3 @@
-import os
 from pathlib import Path
 
 BASE_DIR = Path(__file__).resolve().parent
@@ -15,4 +14,3 @@
 SECRET_KEY = "foobar"
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
-

tests/tests.py

@@ -2,63 +2,66 @@
 
 from django.test import TestCase, override_settings
 
-from dynamic_breadcrumbs.utils import Breadcrumbs, BreadcrumbsItem, validate_path, sanitize_url
+from dynamic_breadcrumbs.utils import (
+    Breadcrumbs,
+    validate_path,
+    sanitize_url,
+)
 from dynamic_breadcrumbs import app_settings
 from django.conf import settings
-from django.http import HttpResponse, HttpRequest
-from dynamic_breadcrumbs import app_settings
+
 
 @override_settings(ALLOWED_HOSTS=["www.example.com"])
 class SanitizeUrlTests(TestCase):
-
     def test_sanitize_base_urls_host_in_allowed_hosts_keeps_url(self):
-        base_url= f"https://{settings.ALLOWED_HOSTS[0]}"
-        
+        base_url = f"https://{settings.ALLOWED_HOSTS[0]}"
+
         result = sanitize_url(url=base_url)
-        
+
         self.assertEqual(result, base_url)
 
     def test_sanitize_base_urls_host_not_in_allowed_hosts_returns_empty_string(self):
-        base_url= "https://anothersite.com"
-        
+        base_url = "https://anothersite.com"
+
         result = sanitize_url(url=base_url)
-        
+
         self.assertEqual(result, "")
 
+
 class ValidatePathTests(TestCase):
     def test_validate_path_not_string_returns_empty_string(self):
-        path=3.1416
-        
+        path = 3.1416
+
         result = validate_path(path=path)
-        
+
         self.assertEqual(result, "")
 
     def test_validate_path_check_alphanumeric_returns_empty_string(self):
-        app_settings.PATH_XSS_SAFE_MODE=True
-        path="*%#$@@#*(/%#%_)*"
-        
+        app_settings.PATH_XSS_SAFE_MODE = True
+        path = "*%#$@@#*(/%#%_)*"
+
         result = validate_path(path=path)
-        
+
         self.assertEqual(result, "")
-    
+
     def test_validate_path_non_check_alphanumeric_returns_path(self):
-        app_settings.PATH_XSS_SAFE_MODE=False
-        path="*%#$@@#*(/%#%_)*"
-        
+        app_settings.PATH_XSS_SAFE_MODE = False
+        path = "*%#$@@#*(/%#%_)*"
+
         result = validate_path(path=path)
-        
+
         self.assertEqual(result, path)
-    
+
 
 class BreadcrumbsTests(TestCase):
     def setUp(self):
         self.host = settings.ALLOWED_HOSTS[0]
 
-        #response = self.client.get('/')
-        #request = HttpRequest().build_absolute_uri(location="/")
-        #print(request)
+        # response = self.client.get('/')
+        # request = HttpRequest().build_absolute_uri(location="/")
+        # print(request)
 
-        #self.breadcrumbs = Breadcrumbs(base_url=self.base_url)
+        # self.breadcrumbs = Breadcrumbs(base_url=self.base_url)
 
     def test_split_path_ending_in_slash(self):
         path = "/scale/minor-scale/"
@@ -86,9 +89,9 @@ def test_split_path_returns_empty_list(self):
 
         self.assertEqual(paths, expected_result)
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_process_all_paths_including_home(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         base_url = "https://example.com"
         path = "/scale/minor-scale/c"
         breadcrumbs = Breadcrumbs(base_url=base_url, path=path)
@@ -97,9 +100,9 @@ def test_process_all_paths_including_home(self, mock_resolve):
 
         self.assertEqual(len(result), 4)
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_as_list(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         path = "/continent/some-continent/"
         breadcrumbs = Breadcrumbs(path=path)
 
@@ -109,9 +112,9 @@ def test_as_list(self, mock_resolve):
         self.assertEqual(result[1]["name"], "continent")
         self.assertEqual(result[2]["name"], "some-continent")
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_as_list_only_home(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         app_settings.SHOW_AT_BASE_PATH = True
         path = "/"
         breadcrumbs = Breadcrumbs(path=path)
@@ -120,9 +123,9 @@ def test_as_list_only_home(self, mock_resolve):
 
         self.assertEqual(len(result), 1)
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_as_list_not_showing_at_home(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         app_settings.SHOW_AT_BASE_PATH = False
         path = "/"
         breadcrumbs = Breadcrumbs(path=path)
@@ -131,9 +134,9 @@ def test_as_list_not_showing_at_home(self, mock_resolve):
 
         self.assertEqual(len(result), 0)
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_show_home_at_base_url(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         app_settings.SHOW_AT_BASE_PATH = True
         path = "/"
         breadcrumbs = Breadcrumbs(path=path)
@@ -142,9 +145,9 @@ def test_show_home_at_base_url(self, mock_resolve):
 
         self.assertEqual(len(result), 1)
 
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_hide_home_at_base_url(self, mock_resolve):
-        mock_resolve = True
+        mock_resolve = True  # noqa
         app_settings.SHOW_AT_BASE_PATH = False
         path = "/"
         breadcrumbs = Breadcrumbs(path=path)
@@ -153,27 +156,21 @@ def test_hide_home_at_base_url(self, mock_resolve):
 
         self.assertEqual(len(result), 0)
 
-
-    
-    @patch('dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata')
+    @patch("dynamic_breadcrumbs.utils.BreadcrumbsItem._get_resolved_url_metadata")
     def test_filter_xss_attacks(self, mock_resolve):
-        mock_resolve = False
+        mock_resolve = False  # noqa
 
         app_settings.SHOW_AT_BASE_PATH = False
         malicious_code = """
         jaVasCript:/*-/*`/*\`/*'/*"/**/(/* */oNcliCk=alert() )//%0D%0A%0d%0a//</stYle/</titLe/</teXtarEa/</scRipt/--!>\x3csVg/<sVg/oNloAd=alert()//>\x3e
-        """
+        """  # noqa
         path = f"/level/{malicious_code}/leaf/"
         breadcrumbs = Breadcrumbs(path=path)
 
         result = breadcrumbs.as_list()
         self.assertEqual(len(result), 0)
 
 
-    
-    
-
-
 # class BreadcrumbsItemTests(TestCase):
 #     def test_get_resolved_url_metadata_resolves_valid_path(self):
 #         item = BreadcrumbsItem(