use ruff tool

Author: lestex

.pre-commit-config.yaml

@@ -1,8 +1,7 @@
 # See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.3.0
+  rev: v4.4.0
   hooks:
   - id: check-added-large-files
   - id: check-toml
@@ -21,3 +20,8 @@ repos:
   hooks:
     - id: blue
       name: blue
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.219
+  hooks:
+    - id: ruff
+      args: ["--force-exclude"]

pygithubactions/core/core.py

@@ -64,7 +64,7 @@ def get_input(
 
     Returns:
         value (str): - Input value.
-    """   # noqa
+    """
     norm_name = name.replace(' ', '_').upper()
     value = os.environ.get(f'INPUT_{norm_name}', '')
 
@@ -91,7 +91,7 @@ def get_boolean_input(
 
     Returns:
         bool
-    """  # noqa
+    """
     true_values = ['true', 'True', 'TRUE']
     false_values = ['false', 'False', 'FALSE']
     value = get_input(name, required, trim_whitespace)
@@ -122,7 +122,7 @@ def get_multiline_input(
 
     Returns:
         list[str]: List of inputs.
-    """  # noqa
+    """
     inputs = get_input(name, required, trim_whitespace)
     inputs_list = [i for i in inputs.split('\n') if i != '']
 

pygithubactions/core/file_command.py

@@ -40,4 +40,4 @@ def prepare_key_value_message(key: str, value: Any) -> str:
             f'the delimiter: {delimiter}'
         )
 
-    return f'{key}<<{delimiter}{os.linesep}{converted_value}{os.linesep}{delimiter}'   # noqa
+    return f'{key}<<{delimiter}{os.linesep}{converted_value}{os.linesep}{delimiter}'

pyproject.toml

@@ -58,3 +58,7 @@ select = [
 
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401"]
+"tests/*.py" = ["E501"]
+
+[tool.ruff.mccabe]
+max-complexity = 3

tests/test_command.py

@@ -16,7 +16,7 @@ def test_command_escape_message(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command::percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A{os.linesep}'  # noqa: E501
+        == f'::some-command::percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A{os.linesep}'
     )
 
     # verify literal escape sequences
@@ -32,14 +32,14 @@ def test_command_escape_property(capsys):
     issue_command(
         'some-command',
         {
-            'name': 'percent % percent % cr \r cr \r lf \n lf \n colon : colon : comma , comma ,'  # noqa: E501
+            'name': 'percent % percent % cr \r cr \r lf \n lf \n colon : colon : comma , comma ,'
         },
         '',
     )
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command name=percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A colon %3A colon %3A comma %2C comma %2C::{os.linesep}'  # noqa: E501
+        == f'::some-command name=percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A colon %3A colon %3A comma %2C comma %2C::{os.linesep}'
     )
 
     # Verify literal escape sequences
@@ -51,7 +51,7 @@ def test_command_escape_property(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command::%2525 %2525 %250D %250D %250A %250A %253A %253A %252C %252C{os.linesep}'  # noqa: E501
+        == f'::some-command::%2525 %2525 %250D %250D %250A %250A %253A %253A %252C %252C{os.linesep}'
     )
 
 
@@ -70,7 +70,7 @@ def test_command_with_message_properties(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command prop1=value 1,prop2=value 2::some message{os.linesep}'  # noqa: E501
+        == f'::some-command prop1=value 1,prop2=value 2::some message{os.linesep}'
     )
 
 
@@ -102,7 +102,7 @@ def test_command_with_three_properties(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command prop1=value 1,prop2=value 2,prop3=value 3::{os.linesep}'  # noqa: E501
+        == f'::some-command prop1=value 1,prop2=value 2,prop3=value 3::{os.linesep}'
     )
 
 
@@ -118,5 +118,5 @@ def test_command_with_non_string_props(capsys):
     )
 
     captured = capsys.readouterr()
-    part_out = '::some-command prop1={"test"%3A "object"},prop2=123,prop3=true::{"test": "object"}'  # noqa: E501
+    part_out = '::some-command prop1={"test"%3A "object"},prop2=123,prop3=true::{"test": "object"}'
     assert captured.out == f'{part_out}{os.linesep}'

tests/test_core.py

@@ -26,7 +26,7 @@ def test_is_debug():
 
 def test_set_failed_sets_correct_exit_code_failure_message(capsys):
     failure_message = 'Failure message'
-    with pytest.raises(SystemExit) as e:   # noqa
+    with pytest.raises(SystemExit) as e:
         set_failed(failure_message)
 
     captured = capsys.readouterr()

tests/test_core_export_variable.py

@@ -23,7 +23,7 @@ def test_legacy_export_variable(self, capsys):
     def test_legacy_export_variable_escapes_variable_names(self, capsys):
         export_variable('special char var \r\n,:', 'special val')
         got = capsys.readouterr().out
-        want = f'::set-env name=special char var %0D%0A%2C%3A::special val{os.linesep}'   # noqa
+        want = f'::set-env name=special char var %0D%0A%2C%3A::special val{os.linesep}'
         assert got == want
 
     @requires_env('local')
@@ -49,7 +49,7 @@ def test_export_variable(self, tmp_path, create_file_func, read_file_func):
             export_variable('my var', 'var val')
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my var<<{DELIMITER}{os.linesep}var val{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my var<<{DELIMITER}{os.linesep}var val{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_export_variable_handles_boolean_inputs(
@@ -62,7 +62,7 @@ def test_export_variable_handles_boolean_inputs(
             export_variable('my var', True)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my var<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my var<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_export_variable_handles_number_inputs(
@@ -75,7 +75,7 @@ def test_export_variable_handles_number_inputs(
             export_variable('my var', 5)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my var<<{DELIMITER}{os.linesep}5{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my var<<{DELIMITER}{os.linesep}5{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_export_variable_does_not_allow_delimiter_value(

tests/test_core_save_state.py

@@ -41,7 +41,7 @@ def test_save_state_produces_correct_command_saves_state(
             save_state('my state', 'out val')
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my state<<{DELIMITER}{os.linesep}out val{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my state<<{DELIMITER}{os.linesep}out val{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_save_state_handles_boolean_inputs(
@@ -54,7 +54,7 @@ def test_save_state_handles_boolean_inputs(
             save_state('my state', True)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my state<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my state<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_save_state_handles_numbers_inputs(
@@ -67,7 +67,7 @@ def test_save_state_handles_numbers_inputs(
             save_state('my state', 65)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my state<<{DELIMITER}{os.linesep}65{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my state<<{DELIMITER}{os.linesep}65{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_set_output_does_not_allow_delimiter_value(

tests/test_core_set_output.py

@@ -18,7 +18,7 @@ def test_legacy_set_output_produces_correct_command(self, capsys):
         set_output('some output', 'some value')
         captured = capsys.readouterr()
 
-        want = f'{os.linesep}::set-output name=some output::some value{os.linesep}'   # noqa
+        want = f'{os.linesep}::set-output name=some output::some value{os.linesep}'
         assert captured.out == want
 
     @requires_env('local')
@@ -48,7 +48,7 @@ def test_set_output_produces_correct_command_and_sets_output(
             set_output('my out', 'out val')
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my out<<{DELIMITER}{os.linesep}out val{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my out<<{DELIMITER}{os.linesep}out val{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_set_output_handles_boolean_inputs(
@@ -62,7 +62,7 @@ def test_set_output_handles_boolean_inputs(
             set_output('my out', True)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my out<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my out<<{DELIMITER}{os.linesep}true{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_set_output_handles_number_inputs(
@@ -76,7 +76,7 @@ def test_set_output_handles_number_inputs(
             set_output('my out', 5)
 
         got = read_file_func(self.command, tmp_path)
-        want = f'my out<<{DELIMITER}{os.linesep}5{os.linesep}{DELIMITER}{os.linesep}'   # noqa
+        want = f'my out<<{DELIMITER}{os.linesep}5{os.linesep}{DELIMITER}{os.linesep}'
         assert got == want
 
     def test_set_output_does_not_allow_delimiter_value(