Mypy hook #1123

jstucke · 2023-09-01T09:05:44Z

added mypy pre-commit hook
added mypy config
fixed all issues in the code base or at least added ignore comments where it wasn't possible

…arison ID type alias

maringuu

Overall lgtm but still some questions.

maringuu · 2023-09-01T17:06:38Z

src/analysis/plugin/plugin.py

        """Analyze a file.
        May return None if nothing was found.

        :param file_handle: :py:class:`io.FileIO` instance of the file to be analyzed
        :param virtual_file_path: The virtual file paths, see :py:class:`~objects.file.FileObject`
        :param analyses: A dictionary of dependent analysis

-        :return: The analysis if anything was found.
+        :return: The analysis results (if there are any).


nit: why use parentheses?

In general? 😅

I don't know, if you want I can remove them. I originally just wanted to specify that analysis results are returned.

I meant that what is written in the parentheses is useful information and reads better without the parantheses.

src/analysis/plugin/plugin.py

maringuu · 2023-09-01T17:08:42Z

src/analysis/plugin/plugin.py

@@ -145,7 +149,7 @@ def get_analysis(self, file_handle: io.FileIO, virtual_file_path: dict, analyses
            'system_version': self.metadata.system_version,
            'summary': summary,
            'tags': tags_dict,
-            'result': result.dict() if result else None,
+            'result': result.dict() if isinstance(result, BaseModel) else None,


Why is this needed?

I think during the time I wasn't sure if the plugin always returns a BaseModel or if it can be a dict if no schema is specified. I think as it is now, the schema is mandatory and the plugin always returns a BaseModel, right?

right?

Exactly!

src/helperFunctions/plugin.py

src/helperFunctions/types.py

src/test/unit/compare/compare_plugin_test_class.py

src/test/unit/helperFunctions/test_task_conversion.py

maringuu

I had a brief look at everything but didn't look in depth.
I hope I found any actual code changes and reviewed them.
For the typing changes I'm happy when mypy is.

src/plugins/analysis/cwe_checker/test/test_cwe_checker.py

src/scheduler/analysis/scheduler.py

maringuu · 2023-10-02T10:51:19Z

src/statistic/analysis_stats.py

-    from multiprocessing import Value
+    from helperFunctions.types import MpValue, MpArray
+
+    pass


dorpvom · 2024-11-25T13:22:50Z

We decided to split this up into smaller PRs to make each one reviewable

jstucke added 30 commits August 2, 2023 16:54

pre-commit: added mypy hook for type checking

01d4e5c

type (hint) fixes

cbcb861

Merge remote-tracking branch 'origin/master' into mypy-hook

b7c406d

object_conversion: type hint fixes + refactoring

3ba3980

added UID type alias and fixed type hints for object classes

d1c910e

fixed typing of remaining helper modules and added new types module

e8d95f0

added type alias for vfp and vfp dict

0e29233

FileObject: typing and type hint fixes

dc2e76d

fixed types and type hints of storage modules

b20e249

test fixes

c18ae62

web interface: typing fixes

0503024

uninitialized FO UID fix

9db887a

fix file tree typing and type hints

9d102b0

Merge remote-tracking branch 'origin/master' into mypy-hook

0821b9c

fix frontend webinterface and intercom typing and type hints

7a92873

fixed typing and types for remaining frontend components

183ff3e

fixed typing and types for rest components

a3d21ea

fixed typing and types for web auth modules

2885bc9

fix typing and type hints of comparison modules

8ab3df5

fix typing and type hints of config.py

a716c21

fix typing and type hints for intercom

84127ca

fix typing and type hints for plugin base classes

94f316a

fix typing and type hints for comparison scheduler and introduce comp…

a12b7c8

…arison ID type alias

fix typing and type hints for comparison scheduler and introduce comp…

57d18e7

…arison ID type alias

fix typing and type hints for task_scheduler.py

6b9750f

fix typing and type hints for scheduler/analysis_status.py

ccb4cea

fixed typing and types for unpacking scheduler

768797c

fix typing and type hints for unpacker modules

9ebb7b7

fix typing and type hints for comparison plugin modules

6be971a

test fixes

e136f29

jstucke added 10 commits August 30, 2023 14:20

mypy config: sorted entries + added exclude paths

2e0a9b7

fix and ignore some plugin typing errors

3ac5ea0

more typing fixes in analysis plugins

57f05f6

integration tests: typing and type hint fixes

fc9ebde

binwalk plugin bugfix

f04a85c

unit tests: typing and type hint fixes

ea14d03

fix typing of remaining (non-plugin) tests

590e635

Merge branch 'mypy-hook' of github.com:fkie-cad/FACT_core into mypy-hook

06a54ae

fixed typing of remaining plugins

9a7b1f8

fixed typing of migration script

4133ffc

jstucke requested a review from maringuu September 1, 2023 09:05

jstucke self-assigned this Sep 1, 2023

jstucke added 5 commits September 1, 2023 12:06

sphinx: new sqlalchemy base style fix

404a192

typing: python<3.10 compat fix

75c15da

input_vectors: installation refactoring + type hint compa fixes

552204e

typing: python<3.9 compat fixes

9b2809c

typing: even more compatibility fixes

2b86c2d

maringuu requested changes Sep 1, 2023

View reviewed changes

jstucke added 2 commits September 11, 2023 13:31

requested review changes #1123

4380f44

Merge remote-tracking branch 'origin/master' into mypy-hook

0cb10ae

maringuu reviewed Oct 2, 2023

View reviewed changes

helper/plugin: ignore spec_from_loader() possibly returning None

191ddd6

maringuu pushed a commit to maringuu/FACT_core that referenced this pull request Oct 12, 2023

requested review changes fkie-cad#1123

25d2e1e

maringuu mentioned this pull request Oct 12, 2023

Add typehints and make mypy happy #1142

Closed

maringuu pushed a commit that referenced this pull request Oct 18, 2023

requested review changes #1123

ecef321

maringuu pushed a commit that referenced this pull request Oct 18, 2023

requested review changes #1123

fbfa1fa

jstucke mentioned this pull request Jun 3, 2024

Mypy: fix helper functions #1224

Open

dorpvom closed this Nov 25, 2024

maringuu mentioned this pull request Nov 27, 2024

ruff fixes #1295

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mypy hook #1123

Mypy hook #1123

jstucke commented Sep 1, 2023 •

edited

Loading

maringuu left a comment

maringuu Sep 1, 2023

jstucke Sep 11, 2023

maringuu Sep 18, 2023

maringuu Sep 1, 2023

jstucke Sep 11, 2023

maringuu Sep 18, 2023 •

edited

Loading

maringuu left a comment

maringuu Oct 2, 2023

dorpvom commented Nov 25, 2024

Mypy hook #1123

Mypy hook #1123

Conversation

jstucke commented Sep 1, 2023 • edited Loading

maringuu left a comment

Choose a reason for hiding this comment

maringuu Sep 1, 2023

Choose a reason for hiding this comment

jstucke Sep 11, 2023

Choose a reason for hiding this comment

maringuu Sep 18, 2023

Choose a reason for hiding this comment

maringuu Sep 1, 2023

Choose a reason for hiding this comment

jstucke Sep 11, 2023

Choose a reason for hiding this comment

maringuu Sep 18, 2023 • edited Loading

Choose a reason for hiding this comment

maringuu left a comment

Choose a reason for hiding this comment

maringuu Oct 2, 2023

Choose a reason for hiding this comment

dorpvom commented Nov 25, 2024

jstucke commented Sep 1, 2023 •

edited

Loading

maringuu Sep 18, 2023 •

edited

Loading