nautobot 3.0.0rc1__py3-none-any.whl → 3.0.1__py3-none-any.whl

nautobot/core/cli/bootstrap_v3_to_v5.py

@@ -3,6 +3,8 @@ import logging
 import os
 import re
 
+import yaml
+
 from .migrate_deprecated_templates import replace_deprecated_templates
 
 logger = logging.getLogger(__name__)
@@ -547,6 +549,97 @@ def _fix_breadcrumbs_block(html_string: str, stats: dict) -> str:
     return block_pattern.sub(process_match, html_string)
 
 
+# --- Grid Breakpoints Resize Function ---
+
+
+def _resize_grid_breakpoints(html_string: str, class_combinations: list[str], stats: dict, file_path: str) -> str:
+    """
+    Resizes grid breakpoints in `col-*` and `offset-*` classes one step up. Uses given `class_combinations` for known
+    class pattern replacements and otherwise does generic xs → sm and md → lg breakpoint resize. In case class list
+    contains grid breakpoints other than xs and md, flags it for manual review.
+    """
+    # Define the breakpoint mapping
+    breakpoint_map = {"xs": "sm", "sm": "md", "md": "lg", "lg": "xl", "xl": "xxl"}
+    breakpoint_map_keys = list(breakpoint_map.keys())
+
+    if "manual_grid_template_lines" not in stats:
+        stats["manual_grid_template_lines"] = []
+
+    def create_grid_class_regex(breakpoints=breakpoint_map_keys):  # pylint: disable=dangerous-default-value
+        # Create regex matching Bootstrap grid classes, i.e. `col-*` and `offset-*`, within given breakpoints.
+        return re.compile(rf"\b(col|offset)-({'|'.join(breakpoints)})([a-zA-Z0-9-]*)")
+
+    # Resize all given grid `breakpoints` in `string` according to defined `breakpoint_map`
+    def resize_breakpoints(string, breakpoints=breakpoint_map_keys, count_stats=False):  # pylint: disable=dangerous-default-value
+        def regex_repl(match):
+            new_breakpoint = breakpoint_map[match.group(2)]
+            if count_stats:
+                stats["grid_breakpoints"] += 1
+            return f"{match.group(1)}-{new_breakpoint}{match.group(3)}"
+
+        # Replace with regex, e.g., col-xs-12 → col-sm-12
+        regex = create_grid_class_regex(breakpoints)
+        return regex.sub(regex_repl, string)
+
+    # Resize given `class_combinations` and create an additional joint array from the two. This is required to determine
+    # whether a known class combination is present in certain element class list and handle one of the following cases:
+    #   1. No, but identified grid breakpoints other than xs and md: flag for manual review.
+    #   2. No, and only xs and md grid breakpoints found: generic xs → sm and md → lg replacement.
+    #   3. Yes, but has not been resized yet: resize with proper combination.
+    #   4. Yes, and has already been resized: do nothing.
+    resized_class_combinations = [resize_breakpoints(class_combination) for class_combination in class_combinations]
+    known_class_combinations = [*class_combinations, *resized_class_combinations]
+
+    def grid_breakpoints_replacer(match):
+        classes = match.group(1)
+        # Remove Django template tag blocks, variables and comments and split individual classes into separate strings.
+        raw_classes = re.compile(r"{{?((?!{|}).)*}}?").sub(" ", classes).split()
+        # Filter out all non-grid classes, keep only `col-*` and `offset-*`.
+        grid_class_regex = create_grid_class_regex()
+        grid_classes = [cls for cls in raw_classes if grid_class_regex.search(cls)]
+
+        # Check whether given class list consists of any of the known class combinations.
+        known_class_combination = None
+        for class_combination in known_class_combinations:
+            # Look for an exact match, when all classes from given combination are included in element classes and vice versa.
+            if all(cls in classes for cls in class_combination.split()) and all(
+                grid_class in class_combination for grid_class in grid_classes
+            ):
+                known_class_combination = class_combination
+                break
+
+        if known_class_combination is None:
+            # Class combination has not been found.
+            if any("xs" not in grid_class and "md" not in grid_class for grid_class in grid_classes):
+                # Class list contains grid breakpoints other than xs and md, require manual review.
+                linenum = match.string.count("\n", 0, match.start()) + 1
+                stats["manual_grid_template_lines"].append(
+                    f"{file_path}:{linenum} - Please review manually '{match.group(0)}'"
+                )
+            else:
+                # Class list contains only xs and md grid breakpoints, do generic xs → sm and md → lg replacement
+                return f'class="{resize_breakpoints(classes, breakpoints=["xs", "md"], count_stats=True)}"'
+
+        elif known_class_combination not in resized_class_combinations:
+            # Class combination has been found, but has not been resized yet: resize with proper combination.
+            resized_classes = resized_class_combinations[class_combinations.index(known_class_combination)].split()
+
+            def class_replacer(m):
+                current_class = m.group(0)
+                stats["grid_breakpoints"] += 1
+                return resized_classes[known_class_combination.split().index(current_class)]
+
+            # Replace all classes from given combination by mapping them individually to their resized equivalents.
+            return f'class="{re.compile("|".join(known_class_combination.split())).sub(class_replacer, classes)}"'
+
+        # Return unchanged string if conditions above are not satisfied, i.e. do nothing.
+        return match.group(0)
+
+    # Find all `class="..."` matches and execute grid breakpoint replacement on them.
+    pattern = re.compile(r'class="([^"]*)"')
+    return pattern.sub(grid_breakpoints_replacer, html_string)
+
+
 # --- Main Conversion Function ---
 
 
@@ -564,7 +657,9 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
         "nav_items": 0,
         "dropdown_items": 0,
         "panel_classes": 0,
+        "grid_breakpoints": 0,
         "manual_nav_template_lines": [],
+        "manual_grid_template_lines": [],
     }
 
     # --- Stage 1: Apply rules that work directly on the HTML string (simple string/regex replacements) ---
@@ -628,6 +723,26 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
         "data-backdrop": "data-bs-backdrop",  # Bootstrap 5 uses data-bs-* attributes
     }
 
+    standard_grid_breakpoint_combinations = [
+        "col-md-6 col-sm-6 col-xs-12",  # Rack elevation container: nautobot/dcim/templates/dcim/rack_elevation.html:2
+        "col-sm-3 col-md-2 col-md-offset-1",  # Legacy user page nav pills container: nautobot/users/templates/users/base.html:10
+        "col-sm-3 col-md-2 offset-md-1",
+        "col-sm-4 col-sm-offset-4",  # Selected centered panel containers, e.g. on 404 and 500 error pages and legacy login page: nautobot/core/templates/login.html:54
+        "col-sm-4 offset-sm-4",
+        "col-sm-4 col-md-3",  # Legacy header search form container: nautobot/core/templates/generic/object_list.html:32
+        "col-sm-8 col-md-9 col-sm-12 col-md-12",  # Legacy breadcrumbs container variation on change list page: nautobot/core/templates/admin/change_list.html:33
+        "col-sm-8 col-md-9 col-md-12",  # Legacy breadcrumbs container variation on generic object list view page: nautobot/core/templates/generic/object_list.html:13
+        "col-sm-8 col-md-9",  # Legacy breadcrumbs container: nautobot/core/templates/generic/object_retrieve.html:16
+        "col-sm-9 col-md-8",  # Legacy user page content container: nautobot/users/templates/users/base.html:31
+        "col-md-5 col-sm-12",  # Cable trace form left-hand side container: nautobot/dcim/templates/dcim/cable_trace.html:10
+        "col-md-7 col-sm-12",  # Cable trace form right-hand side container: nautobot/dcim/templates/dcim/cable_trace.html:86
+        "col-lg-6 col-md-6",  # Jinja template/rendered template panel containers: nautobot/core/templates/utilities/render_jinja2.html:29
+        "col-md-4 col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1",  # Standard centered form container variation on generic object bulk update page: nautobot/core/templates/generic/object_bulk_update.html:39
+        "col-md-4 col-lg-8 col-lg-offset-2 col-md-10 offset-md-1",
+        "col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1",  # Standard centered form container, e.g. on generic object create page: nautobot/core/templates/generic/object_create.html:12
+        "col-lg-8 offset-lg-2 col-md-10 offset-md-1",
+    ]
+
     current_html = _replace_attributes(current_html, attribute_replacements, stats)
     current_html = _replace_classes(current_html, class_replacements, stats, file_path=file_path)
     current_html = _fix_extra_breadcrumbs_block(current_html, stats)
@@ -642,6 +757,7 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
     current_html = _convert_hover_copy_buttons(current_html, stats)
     current_html = _fix_nav_tabs_items(current_html, stats, file_path=file_path)
     current_html = _fix_dropdown_items(current_html, stats, file_path=file_path)
+    current_html = _resize_grid_breakpoints(current_html, standard_grid_breakpoint_combinations, stats, file_path)
 
     return current_html, stats
 
@@ -649,11 +765,10 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
 # --- File Processing ---
 
 
-def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, skip_templates=False) -> None:
+def fix_html_files_in_directory(directory: str, dry_run=False, skip_templates=False) -> None:
     """
     Recursively finds all .html files in the given directory, applies convert_bootstrap_classes,
-    and overwrites each file with the fixed content. If resize is True, it will only change the
-    breakpoints (This should only be done once.).
+    and overwrites each file with the fixed content.
     """
 
     totals = {
@@ -665,11 +780,9 @@ def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, ski
             "nav_items",
             "dropdown_items",
             "panel_classes",
-            "resizing_xs",
+            "grid_breakpoints",
         ]
     }
-    # Breakpoints that are not xs do not count as failures in djlint, so we keep a separate counter
-    resizing_other = 0
 
     if not os.path.exists(directory):
         raise FileNotFoundError(directory)
@@ -680,9 +793,6 @@ def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, ski
     else:
         only_filename = None
 
-    # Define the breakpoint mapping
-    breakpoint_map = {"xs": "sm", "sm": "md", "md": "lg", "lg": "xl", "xl": "xxl"}
-
     for root, _, files in os.walk(directory):
         for filename in files:
             if only_filename and only_filename != filename:
@@ -695,29 +805,6 @@ def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, ski
 
                 content = original_content
 
-                if resize:
-                    # If resize is True, we only change the breakpoints
-                    # This is a one-time operation to adjust the breakpoints.
-                    logger.info("Resizing Breakpoints: %s", file_path)
-
-                    resizing_other = 0
-
-                    # Iterate from the highest breakpoint to the lowest
-                    for bkpt in ["xl", "lg", "md", "sm", "xs"]:
-                        # Replace with regex, e.g., col-xs-12 → col-sm-12
-                        regex = re.compile(rf"(\bcol-{bkpt})([a-zA-Z0-9-]*)")
-
-                        def regex_repl(m, captured_bkpt=bkpt):
-                            nonlocal resizing_other
-                            if captured_bkpt == "xs":
-                                totals["resizing_xs"] += 1
-                            else:
-                                resizing_other += 1
-                            new_bkpt = breakpoint_map[captured_bkpt]
-                            return f"col-{new_bkpt}{m.group(2)}"
-
-                        content = regex.sub(regex_repl, content)
-
                 fixed_content, stats = convert_bootstrap_classes(content, file_path=file_path)
 
                 if dry_run:
@@ -741,12 +828,18 @@ def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, ski
                         print(f"{stats['dropdown_items']} dropdown-items, ", end="")
                     if stats["panel_classes"]:
                         print(f"{stats['panel_classes']} panel replacements, ", end="")
+                    if stats["grid_breakpoints"]:
+                        print(f"{stats['grid_breakpoints']} grid breakpoint replacements, ", end="")
                     print()
 
                 if stats.get("manual_nav_template_lines"):
                     print("  !!! Manual review needed for nav-item fixes at:")
                     for line in stats["manual_nav_template_lines"]:
                         print(f"    - {line}")
+                if stats.get("manual_grid_template_lines"):
+                    print("  !!! Manual review needed for non-standard grid breakpoints at:")
+                    for line in stats["manual_grid_template_lines"]:
+                        print(f"    - {line}")
                 for k, v in stats.items():
                     if k in totals:
                         totals[k] += v
@@ -763,21 +856,63 @@ def fix_html_files_in_directory(directory: str, resize=False, dry_run=False, ski
     print(f"- <li> in <ul.nav-tabs>:         {totals['nav_items']}")
     print(f"- <a> in <ul.dropdown-menu>:     {totals['dropdown_items']}")
     print(f"- Panel class replacements:      {totals['panel_classes']}")
-    print(f"- Resizing breakpoint xs:        {totals['resizing_xs']}")
-    print("-------------------------------------")
-    print(f"- Resizing other breakpoints:    {resizing_other}")
+    print(f"- Grid breakpoint resizes:       {totals['grid_breakpoints']}")
     print("-------------------------------------")
     print(f"- Deprecated templates replaced: {templates_replaced}")
 
 
+def check_python_files_for_legacy_html(directory: str):
+    exclude_dirs = [
+        "__pycache__",
+        "node_modules",
+    ]
+    exclude_files = [
+        "bootstrap_v3_to_v5.py",
+    ]
+
+    with open(os.path.join(os.path.dirname(__file__), "bootstrap_v3_to_v5_changes.yaml")) as yaml_file:
+        try:
+            bootstrap_v3_to_v5_changes = yaml.safe_load(yaml_file)
+        except yaml.YAMLError:
+            print("`bootstrap_v3_to_v5_changes.yaml` file is corrupted.")
+            return 1
+
+    def has_multiline_pattern(change):
+        return "(?s)" in change["Search Regex"][1:-2]
+
+    multiline_pattern_changes = [change for change in bootstrap_v3_to_v5_changes if has_multiline_pattern(change)]
+    standard_pattern_changes = [change for change in bootstrap_v3_to_v5_changes if not has_multiline_pattern(change)]
+
+    matches = 0
+    for dirpath, dirnames, filenames in os.walk(directory):
+        for filename in filenames:
+            if filename in exclude_files or not filename.endswith(".py"):
+                continue
+            with open(os.path.join(dirpath, filename), "rt") as fh:
+                contents = fh.readlines()
+                full_contents = "".join(contents)
+
+            for linenum, line in enumerate(contents, start=1):
+                for change in standard_pattern_changes:
+                    if re.search(change["Search Regex"][1:-2], line):
+                        print(f"{os.path.join(dirpath, filename)}({linenum}):\t{line}\t:\t{change['Bootstrap v5']}")
+                    matches += 1
+            for change in multiline_pattern_changes:
+                multiline_matches = re.finditer(change["Search Regex"][1:-2], full_contents)
+                for multiline_match in multiline_matches:
+                    linenum = multiline_match.string.count("\n", 0, multiline_match.start()) + 1
+                    substring = multiline_match.string[multiline_match.start() : multiline_match.end()]
+                    print(f"{os.path.join(dirpath, filename)}({linenum}):\t{substring}\n\t:\t{change['Bootstrap v5']}")
+                    matches += 1
+            for exclude_dir in exclude_dirs:
+                if exclude_dir in dirnames:
+                    dirnames.remove(exclude_dir)
+
+    return matches
+
+
 def main():
     parser = argparse.ArgumentParser(description="Bootstrap 3 to 5 HTML fixer.")
-    parser.add_argument(
-        "-r",
-        "--resize",
-        action="store_true",
-        help="Change column breakpoints to be one level higher, such as 'col-xs-*' to 'col-sm-*'",
-    )
     parser.add_argument(
         "-d",
         "--dry-run",
@@ -788,11 +923,17 @@ def main():
     parser.add_argument(
         "-st", "--skip-template-replacement", action="store_true", help="Skip replacing deprecated templates."
     )
+    parser.add_argument("-p", "--check-python-files", action="store_true", help="Check Python files for legacy HTML.")
+    parser.add_argument("--no-fix-html-templates", action="store_true", help="Do not fix HTML template files.")
     args = parser.parse_args()
 
-    fix_html_files_in_directory(
-        args.path, resize=args.resize, dry_run=args.dry_run, skip_templates=args.skip_template_replacement
-    )
+    exit_code = 0
+    if args.check_python_files:
+        exit_code = check_python_files_for_legacy_html(args.path)
+    if not args.no_fix_html_templates:
+        fix_html_files_in_directory(args.path, dry_run=args.dry_run, skip_templates=args.skip_template_replacement)
+
+    return exit_code
 
 
 if __name__ == "__main__":

nautobot/core/cli/bootstrap_v3_to_v5_changes.yaml

@@ -0,0 +1,314 @@
+- "Bootstrap v3": btn-default
+  "Bootstrap v5": btn-secondary
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')btn-default(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": btn-lg
+  "Bootstrap v5": btn
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')btn-lg(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": btn-xs
+  "Bootstrap v5": btn-sm
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')btn-xs(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": caret
+  "Bootstrap v5": mdi mdi-chevron-down
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')caret(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": center-block
+  "Bootstrap v5": d-block mx-auto
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')center-block(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": checkbox
+  "Bootstrap v5": form-check
+  "Search Regex": |
+    `(?<!type=)("|')([^"']*)(?<=\s|"|')checkbox(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": checkbox-inline
+  "Bootstrap v5": form-check-input
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')checkbox-inline(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": close
+  "Bootstrap v5": btn-close
+  "Search Regex": |
+    `(?<=class=)("|')([^"']*)(?<=\s|"|')close(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": col-*-offset-*
+  "Bootstrap v5": offset-*-*
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')col-(xs|sm|md|lg|x?xl)-offset-\d{1,2}(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": control-label
+  "Bootstrap v5": col-form-label
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')control-label(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": dropdown-menu-left
+  "Bootstrap v5": dropdown-menu-start
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')dropdown-menu-left(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": dropdown-menu-right
+  "Bootstrap v5": dropdown-menu-end
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')dropdown-menu-right(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": form-control-static
+  "Bootstrap v5": form-control-plaintext
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')form-control-static(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": form-group
+  "Bootstrap v5": mb-10 d-flex justify-content-center
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')form-group(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": help-block
+  "Bootstrap v5": form-text
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')help-block(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": hidden
+  "Bootstrap v5": d-none
+  "Search Regex": |
+    `(?<!type=)("|')([^"']*)(?<=\s|"|')hidden(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label
+  "Bootstrap v5": badge
+  "Search Regex": |
+    `(?<=class=)("|')([^"']*)(?<=\s|"|')label(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-default
+  "Bootstrap v5": bg-default
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-default(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-danger
+  "Bootstrap v5": bg-danger
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-danger(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-info
+  "Bootstrap v5": bg-info
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-info(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-primary
+  "Bootstrap v5": bg-primary
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-primary(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-success
+  "Bootstrap v5": bg-success
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-success(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-transparent
+  "Bootstrap v5": bg-transparent
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-transparent(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": label-warning
+  "Bootstrap v5": bg-warning
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')label-warning(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": noprint
+  "Bootstrap v5": d-print-none
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')noprint(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": panel
+  "Bootstrap v5": card
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')panel(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": panel-body
+  "Bootstrap v5": card-body
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')panel-body(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": panel-footer
+  "Bootstrap v5": card-footer
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')panel-footer(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": panel-heading
+  "Bootstrap v5": card-header
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')panel-heading(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": pull-left
+  "Bootstrap v5": float-start
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')pull-left(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": pull-right
+  "Bootstrap v5": float-end
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')pull-right(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": sr-only
+  "Bootstrap v5": visually-hidden
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')sr-only(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": sr-only-focusable
+  "Bootstrap v5": visually-hidden-focusable
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')sr-only-focusable(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": text-left
+  "Bootstrap v5": text-start
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')text-left(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": text-muted
+  "Bootstrap v5": text-secondary
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')text-muted(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": text-right
+  "Bootstrap v5": text-end
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')text-right(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": accordion-toggle
+  "Bootstrap v5": nb-collapse-toggle
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')accordion-toggle(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": accordion-toggle-all
+  "Bootstrap v5": data-nb-toggle
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')accordion-toggle-all(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": banner-bottom
+  "Bootstrap v5": nb-banner-bottom
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')banner-bottom(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": btn-inline
+  "Bootstrap v5": nb-btn-inline-hover
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')btn-inline(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": color-block
+  "Bootstrap v5": nb-color-block
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')color-block(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": description
+  "Bootstrap v5": nb-description
+  "Search Regex": |
+    `(?<=class=)("|')([^"']*)(?<=\s|"|')description(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": editor-container
+  "Bootstrap v5": nb-editor-container
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')editor-container(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": loading
+  "Bootstrap v5": nb-loading
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')loading(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": report-stats
+  "Bootstrap v5": nb-report-stats
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')report-stats(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": required
+  "Bootstrap v5": nb-required
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')required(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": right-side-panel
+  "Bootstrap v5": nb-right-side-panel
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')right-side-panel(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": software-image-hierarchy
+  "Bootstrap v5": nb-software-image-hierarchy
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')software-image-hierarchy(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": style-line
+  "Bootstrap v5": nb-style-line
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')style-line(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": table-headings
+  "Bootstrap v5": nb-table-headings
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')table-headings(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tile
+  "Bootstrap v5": nb-tile
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tile(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tile-description
+  "Bootstrap v5": nb-tile-description
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tile-description(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tile-footer
+  "Bootstrap v5": nb-tile-footer
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tile-footer(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tile-header
+  "Bootstrap v5": nb-tile-header
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tile-header(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tiles
+  "Bootstrap v5": nb-tiles
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tiles(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": tree-hierarchy
+  "Bootstrap v5": nb-tree-hierarchy
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')tree-hierarchy(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": filter-container
+  "Bootstrap v5": removed
+  "Search Regex": |
+    `("|')([^"']*)(?<=\s|"|')filter-container(?=\s|"|')([^"']*)("|')`
+
+- "Bootstrap v3": data-backdrop
+  "Bootstrap v5": data-bs-backdrop
+  "Search Regex": |
+    `data-backdrop`
+
+- "Bootstrap v3": data-dismiss
+  "Bootstrap v5": data-bs-dismiss
+  "Search Regex": |
+    `data-dismiss`
+
+- "Bootstrap v3": data-target
+  "Bootstrap v5": data-bs-target
+  "Search Regex": |
+    `data-target`
+
+- "Bootstrap v3": data-title
+  "Bootstrap v5": data-bs-title
+  "Search Regex": |
+    `data-title`
+
+- "Bootstrap v3": data-toggle
+  "Bootstrap v5": data-bs-toggle
+  "Search Regex": |
+    `data-toggle`
+
+- "Bootstrap v3": Breadcrumbs, Dropdowns, Tabs
+  "Bootstrap v5": breadcrumb-item, dropdown-item, nav-item, nav-link
+  "Search Regex": |
+    `(?s)<li((?!<li|</li>|breadcrumb-item).)*(?=<a|<button)((?!<li|</li>|breadcrumb-item|dropdown-item|nav-item|nav-link).)*</li>`

nautobot/core/graphql/generators.py

@@ -3,7 +3,6 @@
 import logging
 
 import graphene
-from graphene_django.fields import DjangoListField
 import graphene_django_optimizer as gql_optimizer
 from graphql import GraphQLError
 
@@ -375,7 +374,8 @@ def generate_attrs_for_schema_type(schema_type):
     # Define Attributes for single item and list with their search parameters
     search_params = generate_list_search_parameters(schema_type)
     attrs[single_item_name] = graphene.Field(schema_type, id=graphene.ID())
-    attrs[list_name] = DjangoListField(schema_type, **search_params)
+    # TODO: refactor to use DjangoListField instead of graphene.List (https://github.com/nautobot/nautobot/issues/4690)
+    attrs[list_name] = graphene.List(schema_type, **search_params)
 
     # Define Resolvers for both single item and list
     single_item_resolver_name = f"{RESOLVER_PREFIX}{single_item_name}"