Exempt examples from fewer ruff linting rules

Author: tleonhardt

examples/annotated_example.py

@@ -99,6 +99,7 @@ def do_add(self, a: int, b: int = 0, verbose: bool = False) -> None:
         Examples:
             add 2 --b 3
             add 10 --b 5 --verbose
+
         """
         result = a + b
         if verbose:

examples/argparse_example.py

@@ -125,13 +125,13 @@ def do_print_unknown(self, args: argparse.Namespace, unknown: list[str]) -> None
     # subcommand functions for the calculate command
     @cmd2.as_subcommand_to("calculate", "add", add_parser, help=add_description.lower())
     def add(self, args: argparse.Namespace) -> None:
-        """add subcommand of calculate command."""
+        """Add subcommand of calculate command."""
         result = args.num1 + args.num2
         self.poutput(f"{args.num1} + {args.num2} = {result}")
 
     @cmd2.as_subcommand_to("calculate", "subtract", subtract_parser, help=subtract_description.lower())
     def subtract(self, args: argparse.Namespace) -> None:
-        """subtract subcommand of calculate command."""
+        """Subtract subcommand of calculate command."""
         result = args.num1 - args.num2
         self.poutput(f"{args.num1} - {args.num2} = {result}")
 

examples/async_call.py

@@ -13,7 +13,6 @@
 
 def run_async(coro) -> concurrent.futures.Future:
     """Await a coroutine from a synchronous function/method."""
-
     global _event_loop  # noqa: PLW0603
 
     if _event_loop is None:
@@ -31,7 +30,7 @@ def run_async(coro) -> concurrent.futures.Future:
 
 
 async def async_wait(duration: float) -> float:
-    """Example async function that is called from a synchronous cmd2 command"""
+    """Example async function that is called from a synchronous cmd2 command."""
     await asyncio.sleep(duration)
     return duration
 
@@ -47,7 +46,6 @@ def do_async_wait(self, _: str) -> None:
 
         Example cmd2 command that calls an async function.
         """
-
         waitable = run_async(async_wait(0.1))
         self.poutput("Begin waiting...")
         # Wait for coroutine to complete and get its return value:

examples/async_commands.py

@@ -7,7 +7,7 @@
 
 import asyncio
 import functools
-import random
+import secrets
 import shutil
 import threading
 from collections.abc import Callable
@@ -46,7 +46,6 @@ def _get_event_loop() -> asyncio.AbstractEventLoop:
 def with_async_loop(func: Callable[..., Any], cancel_on_interrupt: bool = True) -> Callable[..., Any]:
     """Decorate an async ``do_*`` command method to give it access to the event loop.
 
-
     This decorator wraps a do_* command method. When the command is executed,
     it submits the coroutine returned by the method to a background asyncio loop
     and waits for the result synchronously (blocking the cmd2 loop, as expected
@@ -79,6 +78,9 @@ def __init__(self) -> None:
         super().__init__()
         self.intro = 'Welcome to the Async Commands example. Type "help" to see available commands.'
 
+        # Create an instance of SystemRandom
+        self._secure_generator = secrets.SystemRandom()
+
         if self.main_session.key_bindings is None:
             self.main_session.key_bindings = KeyBindings()
 
@@ -118,14 +120,14 @@ def handle_control_t(self, _event) -> None:
         word = "fnord"
 
         # Generate a random RGB color tuple
-        r = random.randint(0, 255)
-        g = random.randint(0, 255)
-        b = random.randint(0, 255)
+        r = self._secure_generator.randint(0, 255)
+        g = self._secure_generator.randint(0, 255)
+        b = self._secure_generator.randint(0, 255)
 
         # Get terminal width to calculate padding for right-alignment
         cols, _ = shutil.get_terminal_size()
         extra_width = cols - len(word) - 1
-        padding_size = random.randint(0, extra_width)
+        padding_size = self._secure_generator.randint(0, extra_width)
         padding = " " * padding_size
 
         # Use rich to generate the overall text to print out

examples/async_printing.py

@@ -3,7 +3,7 @@
 and changes the window title.
 """
 
-import random
+import secrets
 import threading
 import time
 
@@ -46,6 +46,9 @@ def __init__(self) -> None:
         self.register_preloop_hook(self._preloop_hook)
         self.register_postloop_hook(self._postloop_hook)
 
+        # Create an instance of SystemRandom
+        self._secure_generator = secrets.SystemRandom()
+
     def _preloop_hook(self) -> None:
         """Start the alerter thread."""
         self._stop_event.clear()
@@ -91,7 +94,7 @@ def _get_alerts(self) -> list[str]:
             self._next_alert_time = cur_time + 4
 
         else:
-            rand_num = random.randint(1, 20)
+            rand_num = self._secure_generator.randint(1, 20)
             if rand_num > 2:
                 return []
 
@@ -129,7 +132,7 @@ def _build_colored_prompt(self) -> str:
         """Randomly builds a colored prompt
         :return: the new prompt.
         """
-        rand_num = random.randint(1, 6)
+        rand_num = self._secure_generator.randint(1, 6)
 
         status_color = Color.DEFAULT
 

examples/cmd_as_argument.py

@@ -8,7 +8,7 @@
 """
 
 import argparse
-import random
+import secrets
 
 import cmd2
 
@@ -31,6 +31,9 @@ def __init__(self) -> None:
         # Make maxrepeats settable at runtime
         self.add_settable(cmd2.Settable("maxrepeats", int, "max repetitions for speak command", self))
 
+        # Create an instance of SystemRandom
+        self._secure_generator = secrets.SystemRandom()
+
     speak_parser = cmd2.Cmd2ArgumentParser()
     speak_parser.add_argument("-p", "--piglatin", action="store_true", help="atinLay")
     speak_parser.add_argument("-s", "--shout", action="store_true", help="N00B EMULATION MODE")
@@ -41,7 +44,8 @@ def __init__(self) -> None:
     def do_speak(self, args) -> None:
         """Repeats what you tell me to."""
         words = []
-        for word in args.words:
+        for w in args.words:
+            word = w.copy()
             if args.piglatin:
                 word = f"{word[1:]}{word[0]}ay"
             if args.shout:
@@ -65,14 +69,14 @@ def do_mumble(self, args) -> None:
         repetitions = args.repeat or 1
         for _ in range(min(repetitions, self.maxrepeats)):
             output = []
-            if random.random() < 0.33:
-                output.append(random.choice(self.MUMBLE_FIRST))
+            if self._secure_generator.random() < 0.33:
+                output.append(secrets.choice(self.MUMBLE_FIRST))
             for word in args.words:
-                if random.random() < 0.40:
-                    output.append(random.choice(self.MUMBLES))
+                if self._secure_generator.random() < 0.40:
+                    output.append(secrets.choice(self.MUMBLES))
                 output.append(word)
-            if random.random() < 0.25:
-                output.append(random.choice(self.MUMBLE_LAST))
+            if self._secure_generator.random() < 0.25:
+                output.append(secrets.choice(self.MUMBLE_LAST))
             self.poutput(" ".join(output))
 
 

examples/completion_item_choices.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
-"""
-Demonstrates using CompletionItem instances as elements in an argparse choices list.
+"""Demonstrates using CompletionItem instances as elements in an argparse choices list.
 
 Technical Note:
   Using 'choices' is best for fixed datasets that do not change during the
@@ -53,7 +52,7 @@
 class Account:
     """A complex object that we want to select by a friendly name."""
 
-    def __init__(self, account_id: int, owner: str):
+    def __init__(self, account_id: int, owner: str) -> None:
         self.account_id = account_id
         self.owner = owner
 

examples/custom_parser.py

@@ -1,5 +1,4 @@
-"""
-The standard parser used by cmd2 built-in commands is Cmd2ArgumentParser.
+"""The standard parser used by cmd2 built-in commands is Cmd2ArgumentParser.
 The following code shows how to override it with your own parser class.
 """
 

examples/migrating.py

@@ -3,7 +3,7 @@
 
 # import cmd2 as cmd  # noqa: ERA001
 import cmd  # Comment this line and uncomment the one above to migrate to cmd2
-import random
+import secrets
 
 
 class CmdLineApp(cmd.Cmd):
@@ -13,6 +13,10 @@ class CmdLineApp(cmd.Cmd):
     MUMBLE_FIRST = ("so", "like", "well")
     MUMBLE_LAST = ("right?",)
 
+    def __init__(self) -> None:
+        super().__init__()
+        self._secure_generator = secrets.SystemRandom()
+
     def do_exit(self, _line) -> bool:
         """Exit the application."""
         return True
@@ -30,14 +34,14 @@ def do_mumble(self, line) -> None:
         """Mumbles what you tell me to."""
         words = line.split(" ")
         output = []
-        if random.random() < 0.33:
-            output.append(random.choice(self.MUMBLE_FIRST))
+        if self._secure_generator.random() < 0.33:
+            output.append(secrets.choice(self.MUMBLE_FIRST))
         for word in words:
-            if random.random() < 0.40:
-                output.append(random.choice(self.MUMBLES))
+            if self._secure_generator.random() < 0.40:
+                output.append(secrets.choice(self.MUMBLES))
             output.append(word)
-        if random.random() < 0.25:
-            output.append(random.choice(self.MUMBLE_LAST))
+        if self._secure_generator.random() < 0.25:
+            output.append(secrets.choice(self.MUMBLE_LAST))
         print(" ".join(output), file=self.stdout)
 
 

examples/read_input.py

@@ -111,7 +111,7 @@ def do_read_password(self, _) -> None:
         except EOFError:
             pass
 
-    def do_eat(self, arg):
+    def do_eat(self, arg) -> None:
         """Example of using the select method for reading multiple choice input.
 
         Usage: eat wheatties