ruff format --exclude */source/conf.py

Author: cclauss

.flake8

@@ -8,8 +8,8 @@ ignore =
     E226,
     # E261 at least two spaces before inline comment
     E261,
-    # W504 line break after binary operator
-    W504,
+    # W503 line break before binary operator
+    W503,
     # E203 whitespace before ':'
     E203,
     # E221 multiple spaces before operator

.pre-commit-config.yaml

@@ -8,4 +8,8 @@ repos:
   - repo: https://github.com/pycqa/flake8
     rev: 7.3.0
     hooks:
-    - id: flake8
+      - id: flake8
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.5
+    hooks:
+      - id: ruff-format

build_parameters.py

@@ -9,11 +9,11 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
-    'sphinx.ext.mathjax',     # For :math: element rendering
+    'sphinx.ext.mathjax',  # For :math: element rendering
     'sphinx.ext.ifconfig',
     'sphinxcontrib.youtube',  # For youtube embedding
     'sphinxcontrib.jquery',
-    'sphinx_tabs.tabs'        # For clickable tabs
+    'sphinx_tabs.tabs',  # For clickable tabs
 ]
 
 # Set False to re-enable warnings for non-local images.
@@ -32,29 +32,19 @@
 # This needs to change to the actual URL root once the theme updated.
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'copter': (intersphinx_base_url % 'copter',
-                                  None),
-                       'plane': (intersphinx_base_url % 'plane',
-                                  None),  # noqa: E127
-                       'rover': (intersphinx_base_url % 'rover',
-                                  None),  # noqa: E127
-                       'sub': (intersphinx_base_url % 'sub',
-                                  None),  # noqa: E127
-                       'planner': (intersphinx_base_url % 'planner',
-                                  None),  # noqa: E128
-                       'planner2': (intersphinx_base_url % 'planner2',
-                                  None),  # noqa: E128
-                       'dev': (intersphinx_base_url % 'dev',
-                                  None),  # noqa: E127
-                       'antennatracker': (intersphinx_base_url % 'antennatracker',
-                                  None),  # noqa: E128
-                       'ardupilot': (intersphinx_base_url % 'ardupilot',
-                                  None),  # noqa: E128
-                       'mavproxy': (intersphinx_base_url % 'mavproxy',
-                                  None),  # noqa: E128
-                       'blimp': (intersphinx_base_url % 'blimp',
-                                  None),  # noqa: E127
-                      }  # noqa: E124
+intersphinx_mapping = {
+    'copter': (intersphinx_base_url % 'copter', None),
+    'plane': (intersphinx_base_url % 'plane', None),
+    'rover': (intersphinx_base_url % 'rover', None),
+    'sub': (intersphinx_base_url % 'sub', None),
+    'planner': (intersphinx_base_url % 'planner', None),
+    'planner2': (intersphinx_base_url % 'planner2', None),
+    'dev': (intersphinx_base_url % 'dev', None),
+    'antennatracker': (intersphinx_base_url % 'antennatracker', None),
+    'ardupilot': (intersphinx_base_url % 'ardupilot', None),
+    'mavproxy': (intersphinx_base_url % 'mavproxy', None),
+    'blimp': (intersphinx_base_url % 'blimp', None),
+}
 
 # PATCH REMOVE NON-LOCAL IMAGE WARNINGS
 # From:

common_conf.py

@@ -2,6 +2,7 @@
 """
 Script to get last blog entries on Discourse (https://discuss.ardupilot.org/)
 """
+
 import argparse
 import json
 import re
@@ -41,25 +42,29 @@ def __init__(self, blog_url: str, news_url: str):
         self.news_url = news_url
         base_dir = Path.cwd()
         if str(base_dir).endswith('frontend'):
-            base_dir = base_dir.parent  # move one level up in the directory tree if needed
+            base_dir = (
+                base_dir.parent
+            )  # move one level up in the directory tree if needed
 
         self.files_names = {
             self.blog_url: (base_dir / "./frontend/blog_posts.json").resolve(),
-            self.news_url: (base_dir / "./frontend/news_posts.json").resolve()
+            self.news_url: (base_dir / "./frontend/news_posts.json").resolve(),
         }
         # Configure session with proper cookie handling
         self.session = requests.Session()
-        self.session.headers.update({
-            'User-Agent': 'Mozilla/5.0 (compatible; ArduPilotPostGrabber/1.0)',
-            'Accept': 'application/json',
-            "Connection": "keep-alive",
-        })
+        self.session.headers.update(
+            {
+                'User-Agent': 'Mozilla/5.0 (compatible; ArduPilotPostGrabber/1.0)',
+                'Accept': 'application/json',
+                "Connection": "keep-alive",
+            }
+        )
         # Add retry logic for 429 and other errors
         retries = Retry(
             total=5,
             backoff_factor=2,
             status_forcelist=[429, 500, 502, 503, 504],
-            allowed_methods=["HEAD", "GET", "OPTIONS"]
+            allowed_methods=["HEAD", "GET", "OPTIONS"],
         )
         adapter = HTTPAdapter(max_retries=retries)
         self.session.mount("https://", adapter)
@@ -68,8 +73,16 @@ def __init__(self, blog_url: str, news_url: str):
     @staticmethod
     def get_arguments() -> Any:
         parser = argparse.ArgumentParser(description="python3 get_discourse_posts.py")
-        parser.add_argument("--n_posts", dest='n_posts', default="9", help="Number of posts to retrieve")
-        parser.add_argument("--verbose", dest='verbose', action='store_false', default=True, help="show debugging output")
+        parser.add_argument(
+            "--n_posts", dest='n_posts', default="9", help="Number of posts to retrieve"
+        )
+        parser.add_argument(
+            "--verbose",
+            dest='verbose',
+            action='store_false',
+            default=True,
+            help="show debugging output",
+        )
         args, unknown = parser.parse_known_args()
         return args
 
@@ -119,27 +132,41 @@ def get_single_post_text(self, content: Any) -> str:
 
     @staticmethod
     def get_first_youtube_or_img_link(request: str) -> Tuple[str, bool]:
-        """ Returns the first YouTube link or image link in the request, if any.
-            True if the link is a Youtube link."""
+        """Returns the first YouTube link or image link in the request, if any.
+        True if the link is a Youtube link."""
         request_lines = request.splitlines()
         # Join the first 5 lines back together
         first_five_lines = '\n'.join(request_lines[:5])
 
         # Regular expression to find URLs that contain 'YouTube' or image links
         url_pattern = re.compile(r'href=[\'"]?(https?://www\.youtube[^\'" >]+)')
-        img_pattern = re.compile(r'(?i)(?:href|src)=[\'"]?(https?://[^\'" >]+\.(?:jpg|jpeg|png|gif|svg|bmp|webp))')
-        img_pattern2 = re.compile(r'img src=[\'"]?(https?://[^\'" >]+)')  # catch google link and such
+        img_pattern = re.compile(
+            r'(?i)(?:href|src)=[\'"]?(https?://[^\'" >]+\.(?:jpg|jpeg|png|gif|svg|bmp|webp))'
+        )
+        img_pattern2 = re.compile(
+            r'img src=[\'"]?(https?://[^\'" >]+)'
+        )  # catch google link and such
 
         # Find all matches
         youtube_links = url_pattern.findall(first_five_lines)
-        img_links = img_pattern.findall(first_five_lines)[0] if img_pattern.findall(first_five_lines) else None
+        img_links = (
+            img_pattern.findall(first_five_lines)[0]
+            if img_pattern.findall(first_five_lines)
+            else None
+        )
         if img_links is None:
-            img_links = img_pattern2.findall(first_five_lines)[0] if img_pattern2.findall(
-                first_five_lines) else None
+            img_links = (
+                img_pattern2.findall(first_five_lines)[0]
+                if img_pattern2.findall(first_five_lines)
+                else None
+            )
 
         # If there are image links before YouTube links, return empty string
-        if img_links and (not youtube_links or
-                          first_five_lines.index(img_links) < first_five_lines.index(youtube_links[0])):
+        if img_links and (
+            not youtube_links
+            or first_five_lines.index(img_links)
+            < first_five_lines.index(youtube_links[0])
+        ):
             if 'github.com' in img_links:
                 img_links = img_links + "?raw=true"
             return img_links, False
@@ -155,18 +182,32 @@ def get_first_youtube_or_img_link(request: str) -> Tuple[str, bool]:
 
     @staticmethod
     def youtube_link_to_embed_link(url: str) -> str:
-        return url.replace('https://www.youtube.com/watch?v=', 'https://www.youtube-nocookie.com/embed/')
+        return url.replace(
+            'https://www.youtube.com/watch?v=',
+            'https://www.youtube-nocookie.com/embed/',
+        )
 
     def get_post_data(self, content: Any, i: int, verbose: bool) -> Post:
         item = content['topic_list']['topics'][i]
-        single_post_link = str('https://discuss.ardupilot.org/t/' + str(item['slug']) + '/' + str(item['id'])) + '.json'
+        single_post_link = (
+            str(
+                'https://discuss.ardupilot.org/t/'
+                + str(item['slug'])
+                + '/'
+                + str(item['id'])
+            )
+            + '.json'
+        )
         self.debug(f"Requesting post text {single_post_link} ... ", verbose)
         post_content_raw = self.execute_http_request_json(single_post_link)
         post_content = str(post_content_raw['post_stream']['posts'][0]['cooked'])
         single_post_text = self.get_single_post_text(post_content)
 
         has_image = False
-        self.debug(f"Requesting post text {single_post_link} to look for youtube link... ", verbose)
+        self.debug(
+            f"Requesting post text {single_post_link} to look for youtube link... ",
+            verbose,
+        )
         thing_link, isyoutube = self.get_first_youtube_or_img_link(post_content)
         youtube_link = self.youtube_link_to_embed_link(thing_link) if isyoutube else ''
         if youtube_link == '':
@@ -178,8 +219,14 @@ def get_post_data(self, content: Any, i: int, verbose: bool) -> Post:
                 youtube_link = 'nops'
                 item['image_url'] = thing_link
 
-        return Post(item['title'], item['image_url'], has_image, youtube_link, single_post_link.rsplit('.', 1)[0],
-                    single_post_text.strip())
+        return Post(
+            item['title'],
+            item['image_url'],
+            has_image,
+            youtube_link,
+            single_post_link.rsplit('.', 1)[0],
+            single_post_text.strip(),
+        )
 
     def save_posts_to_json(self, url: str, n_posts: int, verbose: bool) -> None:
         content = self.execute_http_request_json(url)
@@ -194,7 +241,9 @@ def write_to_json(self, url: str, data: List[Post]) -> None:
             with open(self.files_names[url], 'w', encoding='utf-8') as f:
                 json.dump(post_data, f, ensure_ascii=False, indent=4)
         except Exception as e:
-            raise WriteToFileError(f"Exception occurred while writing to file with message {e}")
+            raise WriteToFileError(
+                f"Exception occurred while writing to file with message {e}"
+            )
 
     def fetch(self, args: Any) -> None:
         try:

frontend/scripts/get_discourse_posts.py

@@ -0,0 +1,4 @@
+[tool.ruff]
+format.exclude = ["*/source/conf.py"]
+format.quote-style="preserve"
+

pyproject.toml

@@ -17,7 +17,12 @@ def tablify_row(rowheading, row, widths, height):
         out_line = ""
         if rowheading is not None:
             rowheading_line = rowheading_lines[i]
-            out_line += joiner + " " + rowheading_line + " " * (widths[0] - len(rowheading_line) - 1)
+            out_line += (
+                joiner
+                + " "
+                + rowheading_line
+                + " " * (widths[0] - len(rowheading_line) - 1)
+            )
             joiner = "#"
         j = 0
         for item in row_lines:

rst_table.py

@@ -140,7 +140,9 @@ def get_motors_json():
     if not motors_json or not display_json:
         return {}
 
-    existing_layouts = {(layout["Class"], layout["Type"]) for layout in motors_json["layouts"]}
+    existing_layouts = {
+        (layout["Class"], layout["Type"]) for layout in motors_json["layouts"]
+    }
 
     # append additional layouts from display json
     for layout in display_json["layouts"]:
@@ -222,7 +224,7 @@ def get_translated_coordinates(x, y, radius):
     scale motor vector (Roll/Pitch) output to svg coordinates
     """
     θ = math.atan2(-y, -x)
-    r = math.sqrt(y ** 2 + x ** 2) * radius
+    r = math.sqrt(y**2 + x**2) * radius
     x_translated = r * math.cos(θ)
     y_translated = r * math.sin(θ)
     return x_translated, y_translated, r, θ
@@ -912,8 +914,8 @@ def clean(directory="."):
         generate_all_diagrams()
         exit(0)
 
-    # TODO: future use for inserting wiki text automatically
-    # if args.build or args.preview:
+        # TODO: future use for inserting wiki text automatically
+        # if args.build or args.preview:
         build_all(preview=args.preview)
         exit(0)
     if args.preview:

scripts/build_motor_diagrams.py

@@ -6,8 +6,11 @@
 import re
 
 from argparse import ArgumentParser
+
 parser = ArgumentParser('find and optionally replace parameters')
-parser.add_argument("--change", action='store_true', help="change matches to use param markup")
+parser.add_argument(
+    "--change", action='store_true', help="change matches to use param markup"
+)
 parser.add_argument("files", nargs='+')
 
 args = parser.parse_args()

scripts/cap_params.py

@@ -16,6 +16,7 @@
 *   in an Ardupilot/ardupilot environment to update JSON data.
 *
 ****************************************************************************"""
+
 import argparse
 import json
 import math
@@ -167,7 +168,7 @@ def truncate(number, decimal_places):
     """
     truncate a float decimal_places digits after the decimal point
     """
-    str = f"{number:.{decimal_places+1}f}"
+    str = f"{number:.{decimal_places + 1}f}"
     truncated = str[: str.find(".") + decimal_places + 1]
     return float(truncated)
 
@@ -449,7 +450,8 @@ def generate_all(output_file=None, force_overwrite=False):
     if run with '-h' or '--help', print help
     """
     parser = argparse.ArgumentParser(
-        description="Generate motor matrices (JSON) from 'AP_Motors/AP_MotorsMatrix.cpp'.")
+        description="Generate motor matrices (JSON) from 'AP_Motors/AP_MotorsMatrix.cpp'."
+    )
     parser.add_argument(
         "-o",
         "--output",
@@ -460,7 +462,8 @@ def generate_all(output_file=None, force_overwrite=False):
         help=(
             "Output to file (default is stdout; '-o' or '--output' with no argument writes to "
             f"'{DEFAULT_OUTPUT_FILE.relative_to(THIS_SCRIPT.parent)}')."
-        ))
+        ),
+    )
     parser.add_argument(
         "-f",
         "--force",