Sourcery refactored devel branch #2

sourcery-ai · 2023-04-22T06:22:59Z

Branch devel refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the devel branch, then run:

git fetch origin sourcery/devel
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai · 2023-04-22T06:23:01Z

src/fastentrypoints.py

-def get_args(cls, dist, header=None):  # noqa: D205,D400
+def get_args(cls, dist, header=None):    # noqa: D205,D400


Function get_args refactored with the following changes:

Inline variable that is immediately yielded (inline-immediately-yielded-variable)

sourcery-ai · 2023-04-22T06:23:01Z

src/fprime_gds/common/data_types/ch_data.py

-        temp_val = val_obj.val if not isinstance(val_obj, (SerializableType, ArrayType)) else val_obj.formatted_val
+        temp_val = (
+            val_obj.formatted_val
+            if isinstance(val_obj, (SerializableType, ArrayType))
+            else val_obj.val
+        )
        fmt_str = template.get_format_str()
        if temp_val is None:
            return ""
-        if fmt_str:
-            return format_string_template(fmt_str, (temp_val,))
-        return temp_val
+        return format_string_template(fmt_str, (temp_val,)) if fmt_str else temp_val


Function ChData._compute_display_text refactored with the following changes:

Swap if/else branches of if expression to remove negation (swap-if-expression)

Lift code into else after jump in control flow (reintroduce-else)

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-04-22T06:23:01Z

src/fprime_gds/common/data_types/ch_data.py

-        if verbose and csv:
-            return f"{time_str_nice},{raw_time_str},{ch_name},{self.id},{display_text}"
-        if verbose and not csv:
+        if verbose:
+            if csv:
+                return f"{time_str_nice},{raw_time_str},{ch_name},{self.id},{display_text}"
            return (
                f"{time_str_nice}: {ch_name} ({self.id}) {raw_time_str} {display_text}"
            )
-        if not verbose and csv:
+        if csv:


Function ChData.get_str refactored with the following changes:

Hoist a repeated condition into a parent condition (hoist-repeated-if-condition)

Remove redundant conditional [×2] (remove-redundant-if)

sourcery-ai · 2023-04-22T06:23:02Z

src/fprime_gds/common/data_types/cmd_data.py

-        if verbose and csv:
-            return f"{time_str},{raw_time_str},{name},{self.id},{arg_str}"
-        if verbose and not csv:
+        if verbose:
+            if csv:
+                return f"{time_str},{raw_time_str},{name},{self.id},{arg_str}"
            return f"{time_str}: {name} ({self.id}) {raw_time_str} : {arg_str}"
-        if not verbose and csv:
+        if csv:


Function CmdData.get_str refactored with the following changes:

Hoist a repeated condition into a parent condition (hoist-repeated-if-condition)

Remove redundant conditional [×2] (remove-redundant-if)

sourcery-ai · 2023-04-22T06:23:02Z

src/fprime_gds/common/data_types/event_data.py

-        self.display_text = event_temp.description if event_args is None else format_string_template(
-            event_temp.format_str, tuple([arg.val for arg in event_args])
+        self.display_text = (
+            event_temp.description
+            if event_args is None
+            else format_string_template(
+                event_temp.format_str, tuple(arg.val for arg in event_args)
+            )


Function EventData.__init__ refactored with the following changes:

Replace unneeded comprehension with generator (comprehension-to-generator)

sourcery-ai · 2023-04-22T06:23:04Z

src/fprime_gds/common/gds_cli/channels.py

-        channel_list = test_api_utils.get_item_list(
+        return test_api_utils.get_item_list(
            item_dictionary=project_dictionary.channel_id,
            search_filter=filter_predicate,
            template_to_data=ChData.get_empty_obj,
        )
-        return channel_list


Function ChannelsCommand._get_item_list refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:05Z

src/fprime_gds/common/gds_cli/command_send.py

-        closest_matches = difflib.get_close_matches(command_name, known_commands, n=num)
-        return closest_matches
+        return difflib.get_close_matches(command_name, known_commands, n=num)


Function CommandSendCommand._get_closest_commands refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:05Z

src/fprime_gds/common/gds_cli/command_send.py

-        cmd_description = item.get_description()
-        if cmd_description:
+        if cmd_description := item.get_description():


Function CommandSendCommand._get_item_string refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-04-22T06:23:05Z

src/fprime_gds/common/gds_cli/command_send.py

-            close_matches = cls._get_closest_commands(
+            if close_matches := cls._get_closest_commands(
                api.pipeline.dictionaries, command
-            )
-            if close_matches:
+            ):


Function CommandSendCommand._execute_command refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-04-22T06:23:05Z

src/fprime_gds/common/gds_cli/events.py

-        event_list = test_api_utils.get_item_list(
+        return test_api_utils.get_item_list(
            item_dictionary=project_dictionary.event_id,
            search_filter=filter_predicate,
            template_to_data=EventData.get_empty_obj,
        )
-        return event_list


Function EventsCommand._get_item_list refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:09Z

src/fprime_gds/common/gds_cli/filtering_utils.py

-        self.search_string = str(search_string)
+        self.search_string = search_string


Function contains_search_string.__init__ refactored with the following changes:

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

sourcery-ai · 2023-04-22T06:23:09Z

src/fprime_gds/common/gds_cli/test_api_utils.py

-            new_args = func(*args)  # lgtm [py/call/wrong-arguments]
-            if new_args:
+            if new_args := func(*args):


Function repeat_until_interrupt refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

This removes the following comments ( why? ):

# lgtm [py/call/wrong-arguments]

sourcery-ai · 2023-04-22T06:23:10Z

src/fprime_gds/common/models/common/channel_telemetry.py

-        if not ch == False or not ch == True:
-            ch = True
+        ch = True


Function Channel.changed refactored with the following changes:

Remove redundant conditional (remove-redundant-if)

Simplify logical expression using De Morgan identities [×2] (de-morgan)

sourcery-ai · 2023-04-22T06:23:10Z

src/fprime_gds/common/models/common/event.py

-        vals = [0] + vals
-        return vals
+        return [0] + vals


Function Event.deserialize refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:10Z

src/fprime_gds/common/parsers/seq_file_parser.py

-            return [item for item in map(parseArg, args)]
+            return list(map(parseArg, args))


Function SeqFileParser.parse refactored with the following changes:

Replace identity comprehension with call to collection constructor (identity-comprehension)

sourcery-ai · 2023-04-22T06:23:12Z

src/fprime_gds/executables/fprime_cli.py

-        events_parser = parent_parser.add_parser(
+        return parent_parser.add_parser(
            "events",
            description="print out new events that have occurred on the F Prime instance, sorted by timestamp",
        )
-        return events_parser


Function EventsSubparserInjector.create_subparser refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:13Z

src/fprime_gds/executables/run_deployment.py

-    flask_env = os.environ.copy()
-    flask_env.update(
-        {
-            "FLASK_APP": "fprime_gds.flask.app",
-            "STANDARD_PIPELINE_ARGUMENTS": "|".join(reproduced_arguments),
-            "SERVE_LOGS": "YES",
-        }
-    )
+    flask_env = os.environ | {
+        "FLASK_APP": "fprime_gds.flask.app",
+        "STANDARD_PIPELINE_ARGUMENTS": "|".join(reproduced_arguments),
+        "SERVE_LOGS": "YES",
+    }


Function launch_html refactored with the following changes:

Merge dictionary updates via the union operator [×2] (dict-assign-update-to-union)

Remove a redundant constructor in a dictionary union (remove-redundant-constructor-in-dict-union)

sourcery-ai · 2023-04-22T06:23:13Z

src/fprime_gds/executables/tcpserver.py

-        data = tlm_packet_size + packet[4 : 4 + size]
-
-        return data
+        return tlm_packet_size + packet[4 : 4 + size]


Function ThreadedUDPRequestHandler.readData refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:13Z

src/fprime_gds/executables/utils.py

-        except (KeyboardInterrupt, OSError, InterruptedError):
+        except (KeyboardInterrupt, OSError):


Function register_process_assassin refactored with the following changes:

Remove redundant exceptions from an except clause [×3] (remove-redundant-exception)

sourcery-ai · 2023-04-22T06:23:13Z

src/fprime_gds/flask/flask_uploads.py

+
 import sys

 PY3 = sys.version_info[0] == 3

-if PY3:
-    string_types = (str,)
-else:
-    string_types = (basestring,)
-
+string_types = (str, ) if PY3 else (basestring, )


Lines 18-22 refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-04-22T06:23:17Z

src/fprime_gds/flask/flask_uploads.py

-    allow_extns = tuple(config.get(prefix + "ALLOW", ()))
-    deny_extns = tuple(config.get(prefix + "DENY", ()))
-    destination = config.get(prefix + "DEST")
-    base_url = config.get(prefix + "URL")
-
-    if destination is None:
-        # the upload set's destination wasn't given
-        if uset.default_dest:
-            # use the "default_dest" callable
-            destination = uset.default_dest(app)
-        if destination is None:  # still
-            # use the default dest from the config
-            if defaults["dest"] is not None:
-                using_defaults = True
-                destination = os.path.join(defaults["dest"], uset.name)
-            else:
-                raise RuntimeError(f"no destination for set {uset.name}")
+    allow_extns = tuple(config.get(f"{prefix}ALLOW", ()))
+    deny_extns = tuple(config.get(f"{prefix}DENY", ()))
+    destination = config.get(f"{prefix}DEST")
+    base_url = config.get(f"{prefix}URL")
+
+    if destination is None and uset.default_dest:
+        # use the "default_dest" callable
+        destination = uset.default_dest(app)
+    if destination is None:  # still
+        if defaults["dest"] is None:
+            raise RuntimeError(f"no destination for set {uset.name}")

+        using_defaults = True
+        destination = os.path.join(defaults["dest"], uset.name)


Function config_for_set refactored with the following changes:

Use f-string instead of string concatenation [×4] (use-fstring-for-concatenation)

Merge nested if conditions (merge-nested-ifs)

Hoist conditional out of nested conditional (hoist-if-from-if)

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

This removes the following comments ( why? ):

# use the default dest from the config # the upload set's destination wasn't given

sourcery-ai · 2023-04-22T06:23:18Z

src/fprime_gds/flask/json.py

-    jsonable_dict.update({"name": input_type.__name__})
+    jsonable_dict["name"] = input_type.__name__


Function jsonify_base_type refactored with the following changes:

Add single value to dictionary directly rather than using update() (simplify-dictionary-update)

sourcery-ai · 2023-04-22T06:23:18Z

test/fprime_gds/common/gds_cli/filtering_utils_test.py

-    event = EventData([], time_type.TimeType(), sample_template)
-    return event
+    return EventData([], time_type.TimeType(), sample_template)


Function sample_event refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:18Z

test/fprime_gds/common/testing_fw/api_unit_test.py

-        event = EventData(tuple(), TimeType(), temp)
-        return event
+        return EventData(tuple(), TimeType(), temp)


Function APITestCases.get_severity_event refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-04-22T06:23:18Z

test/fprime_gds/common/testing_fw/api_unit_test.py

-            assert True, "api raised the correct error"
+            pass


Function APITestCases.test_assert_telemetry refactored with the following changes:

Remove assert True statements [×2] (remove-assert-true)

sourcery-ai · 2023-04-22T06:23:18Z

test/fprime_gds/common/testing_fw/api_unit_test.py

-            assert True, "api raised the correct error"
+            pass


Function APITestCases.test_assert_telemetry_sequence refactored with the following changes:

Remove assert True statements [×2] (remove-assert-true)

sourcery-ai · 2023-04-22T06:23:18Z

test/fprime_gds/common/testing_fw/api_unit_test.py

-            assert True, "api raised the correct error"
+            pass


Function APITestCases.test_assert_telemetry_count refactored with the following changes:

Remove assert True statements [×2] (remove-assert-true)

sourcery-ai · 2023-04-22T06:23:19Z

test/fprime_gds/common/testing_fw/predicate_unit_test.py

@@ -28,7 +28,6 @@ def check_str(pred):
        try:
            pred.__str__()
            print(pred)
-            assert True, f"predicate provides string summary: {str(pred)}"


Function PredicateTestCases.check_str refactored with the following changes:

Remove assert True statements (remove-assert-true)

sourcery-ai · 2023-04-22T06:23:19Z

test/fprime_gds/common/testing_fw/predicate_unit_test.py

@@ -69,7 +68,6 @@ def test_Implemented():
            str(pred)
        except NotImplementedError:
            assert False, "invoking __str__ on an complete subclass of predicate failed"
-        assert True, "implemented predicate had no problems invoking functions"


Function PredicateTestCases.test_Implemented refactored with the following changes:

Remove assert True statements (remove-assert-true)

src/fprime_gds/executables/utils.py

@@ -62,7 +62,7 @@
            else:
                process.kill(signal.SIGINT)
            time.sleep(1)
-        except (KeyboardInterrupt, OSError, InterruptedError):
+        except (KeyboardInterrupt, OSError):


src/fprime_gds/executables/utils.py

@@ -71,13 +71,13 @@
                process.kill()
            else:
                process.kill(signal.SIGKILL)
-        except (KeyboardInterrupt, OSError, InterruptedError):
+        except (KeyboardInterrupt, OSError):


src/fprime_gds/executables/utils.py

            pass
        # Might as well close the log file because dead men tell no tales.
        try:
            if log is not None:
                log.close()
-        except (KeyboardInterrupt, OSError, InterruptedError):
+        except (KeyboardInterrupt, OSError):


'Refactored by Sourcery'

27804d7

sourcery-ai bot force-pushed the sourcery/devel branch from 823a90b to 27804d7 Compare April 22, 2023 06:23

sourcery-ai bot requested a review from ThiDraft April 22, 2023 06:23

sourcery-ai bot commented Apr 22, 2023

View reviewed changes

github-advanced-security bot found potential problems Apr 22, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored devel branch #2

Sourcery refactored devel branch #2

sourcery-ai bot commented Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

sourcery-ai bot Apr 22, 2023

		def get_args(cls, dist, header=None): # noqa: D205,D400
		def get_args(cls, dist, header=None): # noqa: D205,D400

		self.search_string = str(search_string)
		self.search_string = search_string

		return [item for item in map(parseArg, args)]
		return list(map(parseArg, args))

		except (KeyboardInterrupt, OSError, InterruptedError):
		except (KeyboardInterrupt, OSError):

		jsonable_dict.update({"name": input_type.__name__})
		jsonable_dict["name"] = input_type.__name__

Sourcery refactored devel branch #2

Are you sure you want to change the base?

Sourcery refactored devel branch #2

Conversation

sourcery-ai bot commented Apr 22, 2023

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment

sourcery-ai bot Apr 22, 2023

Choose a reason for hiding this comment