linting fixups

.github/workflows/build.yml

@@ -256,6 +256,14 @@ jobs:
       with:
         submodules: recursive
 
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        cache: pip
+
+    - name: Setup Pip
+      run: pip install pytest
+
     - name: Run pyright
       uses: jakebailey/pyright-action@v2
 

command_extensions/Readme.md

@@ -21,9 +21,9 @@ enabled (and won't suddenly re-enable soon).
 
 ### Command Extensions v2
 - Complete rewrite for v3 sdk.
-- Added the `CE_NewCmd` command, for use in mod files that attempt to regsiter their own commands.
+- Added the `CE_NewCmd` command, for use in mod files that attempt to register their own commands.
 - Deprecated the `--suppress-exists` arg on `clone_bpd` and `clone`, existing uses are noop'd. While
-  developing, you can use the `clone_dbg_suppress_exists` command instead, which supresses the
+  developing, you can use the `clone_dbg_suppress_exists` command instead, which suppresses the
   warning for all clone commands.
 - Removed the `set_material` command.
 
@@ -71,4 +71,4 @@ enabled (and won't suddenly re-enable soon).
 - Switched the demo mod file to "online" mode.
 
 ### Command Extensions v1.0
-- Inital Release.
+- Initial Release.

command_extensions/Writing-Mods.md

@@ -136,7 +136,7 @@ of the original objects, dump them manually to check what their new names are.
 ## `clone_dbg_suppress_exists`
 usage: `clone_dbg_suppress_exists [-h] {Enable,Disable}`
 
-Supresses the 'object already exists' errors which may occur while cloning.
+Suppresses the 'object already exists' errors which may occur while cloning.
 Only intended for debug usage.
 
 | positional arguments |      |
@@ -181,7 +181,7 @@ usage: `load_package [-h] [--list] [package]`
 Loads a package and all objects contained within it. This freezes the game as
 it loads; it should be used sparingly. Supports using glob-style wildcards to
 load up to 10 packages at once, though being explicit should still be
-prefered.
+preferred.
 
 | positional arguments |                                                                                               |
 | :------------------- | :-------------------------------------------------------------------------------------------- |
@@ -299,7 +299,7 @@ whitespace is ignored.
 
 BLCMM files use a bit more involved parsing. Custom commands can be enabled and disabled by toggling
 the category they're in. This requires a bit a workaround however, which might cause some
-interesting behaviour. BLCMM unfortuantly only stores if individual set commands enabled. Our custom
+interesting behaviour. BLCMM unfortunately only stores if individual set commands enabled. Our custom
 commands are technically comments, so they don't get this, and categories themselves don't have a
 specific enabled state either. Instead, we have to determine if a custom command is enabled by if
 the regular set commands around it are.
@@ -318,7 +318,7 @@ considered to be enabled.
 ## Adding custom commands
 Command Extensions is built on top of the command system in `mods_base`. After creating a command
 normally, you must register it with command extensions in order to let it work from mod files. You
-can do this either by manually callling `command_extensions.register` and
+can do this either by manually calling `command_extensions.register` and
 `command_extensions.deregister`, or you can use `command_extensions.autoregister` to do so
 automatically when the command is enabled/disabled.
 

command_extensions/__init__.py

@@ -190,7 +190,7 @@ def execute_file(file_path: Path) -> None:
                 try:
                     exec(line[cmd_len:].lstrip(), py_globals)  # noqa: S102
                 except Exception:  # noqa: BLE001
-                    logging.error("Error occured during 'py' command:")
+                    logging.error("Error occurred during 'py' command:")
                     logging.error(line)
                     traceback.print_exc()
 
@@ -201,7 +201,7 @@ def execute_file(file_path: Path) -> None:
                         # To match pyunrealsdk, each pyexec gets a new empty of globals
                         exec(file.read(), {"__file__": str(path)})  # noqa: S102
                 except Exception:  # noqa: BLE001
-                    logging.error("Error occured during 'pyexec' command:")
+                    logging.error("Error occurred during 'pyexec' command:")
                     logging.error(line)
                     traceback.print_exc()
 

command_extensions/builtins/clone.py

@@ -96,7 +96,7 @@ def clone(args: argparse.Namespace) -> None:  # noqa: D103
 
 @command(
     description=(
-        "Supresses the 'object already exists' errors which may occur while cloning. Only intended"
+        "Suppresses the 'object already exists' errors which may occur while cloning. Only intended"
         " for debug usage."
     ),
 )

command_extensions/builtins/load_package.py

@@ -22,7 +22,7 @@
     description=(
         "Loads a package and all objects contained within it. This freezes the game as it loads; it"
         " should be used sparingly. Supports using glob-style wildcards to load up to 10 packages"
-        " at once, though being explicit should still be prefered."
+        " at once, though being explicit should still be preferred."
     ),
 )
 def load_package(args: argparse.Namespace) -> None:  # noqa: D103

command_extensions/builtins/pyb.py

@@ -31,7 +31,7 @@ def pyb(args: argparse.Namespace) -> None:  # noqa: D103
         try:
             exec(joined, {})  # noqa: S102
         except Exception:  # noqa: BLE001
-            logging.error("Error occured during 'pyb' command:")
+            logging.error("Error occurred during 'pyb' command:")
             logging.error(joined)
             if len(cached_lines) > 1:
                 logging.error("=" * 80)

command_extensions/builtins/regen_balance.py

@@ -186,7 +186,7 @@ def gather_parts_lists(
     Given a balance, work out what it's final parts list should be.
 
     Args:
-        final_bal: The balance to gather tha parts lists of.
+        final_bal: The balance to gather the parts lists of.
         item_type: What item type this balance is.
     Returns:
         A parts list dict, or None on error.

command_extensions/file_parser/blcm_parser.cpp

@@ -69,24 +69,24 @@ struct CommandBlock {
         if (non_space == val.end()) {
             return;
         }
-        auto strat_end =
+        auto strategy_end =
             std::find_if(non_space, val.end(), [](auto chr) { return std::isspace(chr); });
 
-        auto strategy_name = CaseInsensitiveStringView{non_space, strat_end};
+        auto strategy_name = CaseInsensitiveStringView{non_space, strategy_end};
 
-        static const constexpr CaseInsensitiveStringView strat_all = "All";
-        static const constexpr CaseInsensitiveStringView strat_any = "Any";
-        static const constexpr CaseInsensitiveStringView strat_force = "Force";
-        static const constexpr CaseInsensitiveStringView strat_next = "Next";
+        static const constexpr CaseInsensitiveStringView strategy_all = "All";
+        static const constexpr CaseInsensitiveStringView strategy_any = "Any";
+        static const constexpr CaseInsensitiveStringView strategy_force = "Force";
+        static const constexpr CaseInsensitiveStringView strategy_next = "Next";
 
         EnableStrategy new_strategy{};
-        if (strategy_name == strat_all) {
+        if (strategy_name == strategy_all) {
             new_strategy = EnableStrategy::ALL;
-        } else if (strategy_name == strat_any) {
+        } else if (strategy_name == strategy_any) {
             new_strategy = EnableStrategy::ANY;
-        } else if (strategy_name == strat_force) {
+        } else if (strategy_name == strategy_force) {
             new_strategy = EnableStrategy::FORCE;
-        } else if (strategy_name == strat_next) {
+        } else if (strategy_name == strategy_next) {
             new_strategy = EnableStrategy::NEXT;
         } else {
             return;
@@ -162,7 +162,7 @@ struct CommandBlock {
 };
 
 /**
- * @brief Recusively look through BLCMM categories and extract all enabled commands within them.
+ * @brief Recursively look through BLCMM categories and extract all enabled commands within them.
  *
  * @param category The XML category to look through.
  * @param input_strategy The current enable strategy.
@@ -195,7 +195,7 @@ void handle_category(const pugi::xml_node& category,
 
         static const constexpr CaseInsensitiveStringView code = "code";
         if (child_name == code) {
-            auto is_enabled = blcm_preprocessor::in_comma_seperated_list(
+            auto is_enabled = blcm_preprocessor::in_comma_separated_list(
                 profile, child.attribute("profiles").as_string());
 
             block.handle_standard_command(is_enabled);

command_extensions/file_parser/blcm_preprocessor/blcm_preprocessor.cpp

@@ -206,7 +206,7 @@ bool preprocess_line(std::string_view line,
     auto tag_start = line.find_first_of('<');
     if (tag_start == std::string_view::npos) {
         throw ParserError(
-            std::format("Failed to parse line (couldn't find inital tag):\n{}", line));
+            std::format("Failed to parse line (couldn't find initial tag):\n{}", line));
     }
 
     // Ignore the filtertool warning - which starts one char before the opening bracket
@@ -217,7 +217,7 @@ bool preprocess_line(std::string_view line,
     auto tag_name_end = line.find_first_of("> \t", tag_start);
     if (tag_name_end == std::string_view::npos) {
         throw ParserError(
-            std::format("Failed to parse line (inital tag doesn't close):\n{}", line));
+            std::format("Failed to parse line (initial tag doesn't close):\n{}", line));
     }
 
     // Note this may include a leading `/` if looking at a closing tag
@@ -280,7 +280,7 @@ void preprocess(std::istream& blcmm_input, std::ostream& xml_output) {
     }
 }
 
-bool in_comma_seperated_list(std::string_view value, std::string_view list) {
+bool in_comma_separated_list(std::string_view value, std::string_view list) {
     for (size_t entry_start = 0; entry_start < list.size();) {
         auto entry_end = list.find_first_of(',', entry_start);
         if (list.substr(entry_start, entry_end - entry_start) == value) {

command_extensions/file_parser/blcm_preprocessor/blcm_preprocessor.h

@@ -23,14 +23,14 @@ class ParserError : public std::runtime_error {
 void preprocess(std::istream& blcmm_input, std::ostream& xml_output);
 
 /**
- * @brief Checks if a string is in a comma seperated list.
+ * @brief Checks if a string is in a comma separated list.
  * @note Intended to be used to check if a command is active in the current profile.
  *
  * @param value The value to search for.
- * @param list The comma seperated list to search through.
+ * @param list The comma separated list to search through.
  * @return True if the value is found in the list, false otherwise.
  */
-bool in_comma_seperated_list(std::string_view value, std::string_view list);
+bool in_comma_separated_list(std::string_view value, std::string_view list);
 
 }  // namespace blcm_preprocessor
 

command_extensions/file_parser/main.cpp

@@ -42,9 +42,9 @@ PYBIND11_MODULE(file_parser, mod) {
 
             std::vector<CommandMatch> matches{};
             if (line.rfind("<BLCMM", 0) == 0) {
-                matches = std::move(parse_blcmm_file(file));
+                matches = parse_blcmm_file(file);
             } else {
-                matches = std::move(parse_file_line_by_line(file));
+                matches = parse_file_line_by_line(file);
             }
 
             std::vector<py::tuple> output;

command_extensions/file_parser/matcher.cpp

@@ -41,7 +41,7 @@ bool CaseInsensitiveStringView::operator==(std::string_view str) const {
 
 namespace {
 
-// To match strings somewhat efficently we'll use a binary search - while not profiled I don't think
+// To match strings somewhat efficiently we'll use a binary search - while not profiled I don't think
 // we have enough strings and enough matching prefixes to make a full radix trie worth it.
 
 // For this we need to keep our list of commands sorted.

command_extensions/file_parser_tests/Readme.md

@@ -1,14 +1,14 @@
 # File Parser Tests
-These tests run on the file parser module, in a regular Python intepreter.
+These tests run on the file parser module, in a regular Python interpreter.
 
 To run:
 ```sh
 pip install pytest
 pytest command_extensions/file_parser_tests
 ```
 
-Generally, tests consist of a `.testin` and `.json` pair. The `.testin` file is the raw mod file to
-be parsed. The `.json` contains the commands to be enabled, as a list of strings under the
+Generally, tests consist of a `.test_in` and `.json` pair. The `.test_in` file is the raw mod file
+to be parsed. The `.json` contains the commands to be enabled, as a list of strings under the
 `commands` key, and the expected results under the `output` key (using a list of lists instead of
 a list of tuples).
 

command_extensions/file_parser_tests/_test.py

@@ -59,7 +59,7 @@ def __init__(self, input_path: Path, data_path: Path) -> None:
 
         Args:
             input_path: The input file path.
-            data_path: The corosponding test data path.
+            data_path: The corresponding test data path.
         """
         self.path = input_path
 
@@ -83,11 +83,11 @@ def gather_test_data() -> list[TestData]:
         ),
     ]
 
-    for input_path in Path(__file__).parent.glob("**/*.testin"):
+    for input_path in Path(__file__).parent.glob("**/*.test_in"):
         data_path = input_path.with_suffix(".json")
         if not data_path.exists():
             warnings.warn(
-                f"Skipping '{input_path}' because it does not have a corosponding data file.",
+                f"Skipping '{input_path}' because it does not have a corresponding data file.",
                 stacklevel=1,
             )
             continue
@@ -97,7 +97,7 @@ def gather_test_data() -> list[TestData]:
     return all_test_data
 
 
-def test_non_existant_file() -> None:
+def test_non_existent_file() -> None:
     dummy_path = Path("dummy")
     assert not dummy_path.exists()