feat: skip syntax errors #17

bm424 · 2022-06-28T13:40:36Z

Directory processing will skip files containing syntax errors with a warning.

Hellebore

Hey @bm424 - I've reviewed your changes and they look great!

General suggestions:

Ensure that the handling of syntax errors is robust and provides enough information for debugging.
Consider the performance implications of creating multiple instances of AstroidManager.
Review the added docstrings for clarity and consistency with the project's documentation style.
Verify that the changes do not introduce any unintended side effects, especially in error handling and logging.
Assess the impact of these changes on the overall architecture and maintainability of the codebase.

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟡 Testing: 3 issues found
🟡 Complexity: 1 issue found
🟡 Docstrings: 8 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

Hellebore · 2024-03-19T16:36:03Z

sourcery_analytics/extractors.py

@@ -107,6 +110,7 @@ class Extractor(typing.Generic[T]):
    """

    visitor: Visitor[typing.Optional[T]] = IdentityVisitor()
+    manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()


suggestion (performance): Consider using a singleton for AstroidManager.

Instantiating AstroidManager directly in the Extractor class might lead to unnecessary memory usage and initialization overhead if multiple Extractor instances are created. AstroidManager is typically used as a singleton, consider accessing it via a class method or a module-level instance.

Suggested change

manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()

manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()

+ manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()

Hellebore · 2024-03-19T16:36:03Z

sourcery_analytics/extractors.py

+        except astroid.AstroidSyntaxError as e:
+            if isinstance(e.error, SyntaxError):
+                error_message = _format_syntax_error_message(
+                    "skipping file", file, e.error
+                )
+            else:
+                error_message = str(e).replace("\n", " ")
+            warning = SyntaxWarning(error_message)
+            warnings.warn(warning)
+            yield from ()


suggestion (code_refinement): Ensure proper handling of syntax errors for robustness.

The addition of syntax error handling in _extract_from_file is a good improvement for robustness. It might be worth considering if there are any specific actions or logging that should occur when a syntax error is encountered, beyond just warning and skipping the file, to aid in debugging or further analysis.

Suggested change

except astroid.AstroidSyntaxError as e:

if isinstance(e.error, SyntaxError):

error_message = _format_syntax_error_message(

"skipping file", file, e.error

)

else:

error_message = str(e).replace("\n", " ")

warning = SyntaxWarning(error_message)

warnings.warn(warning)

yield from ()

except astroid.AstroidSyntaxError as e:

if isinstance(e.error, SyntaxError):

error_message = _format_syntax_error_message(

"Syntax error encountered, skipping file", file, e.error

)

# Log the syntax error for further analysis

logging.error(f"Syntax error in file {file}: {e.error}")

else:

error_message = str(e).replace("\n", " ")

# Log generic astroid errors

logging.error(f"Astroid error in file {file}: {error_message}")

warning = SyntaxWarning(error_message)

warnings.warn(warning)

# Optionally, you could add more specific handling here, such as:

# - Saving the file path and error details to a report for later analysis

# - Attempting to auto-correct known syntax issues and reprocess the file

# - Emitting metrics or alerts for monitoring the frequency of syntax errors

yield from ()

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/main.py

@@ -161,8 +163,7 @@ def cli_assess(
        console.print(f"[bold red]Found {count} errors.")
        raise typer.Exit(1)

-    console.print("[bold green]Assessment Complete")
-    console.print("[green]No issues found.")
+    console.print("[bold green]Assessment Complete", "[green]No issues found.")


nitpick (code_refinement): Combine console print statements for cleaner output.

Combining the two messages into a single console.print call in cli_assess is a neat way to streamline the output. However, ensure that the intended formatting is preserved, as this change might concatenate the messages without the intended newline or separation.

Suggested change

console.print("[bold green]Assessment Complete", "[green]No issues found.")

console.print("[bold green]Assessment Complete\n[green]No issues found.")

Hellebore · 2024-03-19T16:36:04Z

tests/test_extractors.py

+            """,
+        ],
+    )
+    def test_extract_with_syntax_error(self, extractor, file_path, file, caplog):


suggestion (testing): Consider adding a test case for handling multiple syntax errors in a single file.

This test currently covers the scenario where a file with a syntax error is processed. It would be beneficial to also test how the extractor behaves when multiple syntax errors are present in a single file, ensuring that all errors are appropriately logged or warned.

Hellebore · 2024-03-19T16:36:04Z

tests/test_extractors.py

+            """,
+        ],
+    )
+    def test_extract_with_syntax_error(self, extractor, file_path, file, caplog):


suggestion (testing): Test case for syntax error does not verify the content of the warning message.

While the test ensures a warning is raised when encountering a syntax error, it does not verify the content of the warning message. It's important to check that the warning message accurately reflects the error encountered, including the file path and the specific syntax error message.

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/metrics/utils.py

    return method.lineno


 @nodedispatch
 @validate_node_type(astroid.nodes.FunctionDef)
 def method_file(method: astroid.nodes.FunctionDef) -> str:
+    """Returns the file name the method is in.


suggestion (docstrings): Please update the docstring for function: method_file

Reason for update: Addition of examples and a more detailed description.

Suggested new docstring:

"""Returns the file name the method is in. Not very useful by itself, but can be combined with other metrics for convenience. Examples: Inline code doesn't have a file. >>> method_file("def foo(): pass") '<>' """

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/settings.py

    thresholds: ThresholdSettings = ThresholdSettings()

    @classmethod
    def from_toml_file(cls, toml_file_path: pathlib.Path):
+        """Construct settings from a toml file.


suggestion (docstrings): Please update the docstring for function: from_toml_file

Reason for update: Addition of detailed argument and return type descriptions.

Suggested new docstring:

"""Construct settings from a toml file. Args: toml_file_path: Relative or fully-qualified path to a toml file containing sourcery-analytics settings. Returns: A Settings instance. """

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/cli/partials.py

@@ -99,6 +99,11 @@ def aggregate_csv_output(aggregation_method, method_metric, methods, metrics):


 def read_settings(settings_file: pathlib.Path, console: Console) -> Settings:
+    """Loads settings in the CLI.


suggestion (docstrings): Please update the docstring for function: read_settings

Reason for update: Clarification of the function's purpose and behavior.

Suggested new docstring:

"""Loads settings in the CLI. Wraps the basic settings loader in order to print relevant error messages and exit with correct codes. """

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/cli/data.py

@@ -19,7 +22,8 @@ def from_dict(
        cls,
        d: typing.Dict[str, typing.Any],
        threshold_settings: ThresholdSettings,
-    ):
+    ) -> "ThresholdBreach":


suggestion (docstrings): Please update the docstring for function: from_dict

Reason for update: Clarification of the construction process from a dictionary.

Suggested new docstring:

"""Constructs a ThresholdBreach instance from a dictionary. """

Hellebore · 2024-03-19T16:36:04Z

sourcery_analytics/metrics/utils.py

@@ -38,12 +38,30 @@ def method_name(method: astroid.nodes.FunctionDef) -> str:
 @nodedispatch
 @validate_node_type(astroid.nodes.FunctionDef)
 def method_lineno(method: astroid.nodes.FunctionDef) -> int:
+    """Returns the line number of the method.
+
+    Not very useful by itself, but can be combined with other metrics for convenience.


issue (complexity): Consider simplifying the implementation for consistency and readability.

While the added functionality is appreciated, I suggest simplifying the implementation to maintain consistency and readability across the codebase. For instance, the extensive docstrings for relatively straightforward functions like method_lineno and method_file could be made more concise. Additionally, the nested function definition within method_file adds unnecessary complexity. Consider integrating the logic directly into the method_file function to streamline the flow and improve readability. Simplifying these aspects would make the codebase easier to maintain and understand.

bm424 added 11 commits June 27, 2022 14:44

refactor: extract manager to instance variable

f228d83

refactor: use astroid manager for string parsing in extraction

e3c4f5b

feat: implement skips with warning

75c712c

refactor: extract logging set-up and handle output types

29e6d99

test: add a test for the analysis log

8adbb18

refactor: switch to plain logs in place of syntax warnings

a3d34d8

revert: use a syntax warning in place of logs

848a7d8

test: remove flaky logs test

1de31bf

style: move things around to please mypy

ba4adcd

style: make a type variable covariant to please mypy

fdadae2

docs: fix missing docstrings

a97979e

bm424 merged commit 2a137a8 into main Jun 28, 2022

bm424 deleted the ben/feat/skip-syntax-errors branch June 28, 2022 13:40

bm424 mentioned this pull request Jul 4, 2022

Skip/Ignore files with syntax errors #1

Closed

This comment was marked as resolved.

Sign in to view

This comment was marked as outdated.

Sign in to view

Hellebore reviewed Mar 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: skip syntax errors #17

feat: skip syntax errors #17

bm424 commented Jun 28, 2022

This comment was marked as resolved.

This comment was marked as outdated.

Hellebore left a comment

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

Hellebore Mar 19, 2024

	manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()
	manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()
	+ manager: astroid.manager.AstroidManager = astroid.manager.AstroidManager()

	console.print("[bold green]Assessment Complete", "[green]No issues found.")
	console.print("[bold green]Assessment Complete\n[green]No issues found.")

		@@ -99,6 +99,11 @@ def aggregate_csv_output(aggregation_method, method_metric, methods, metrics):


		def read_settings(settings_file: pathlib.Path, console: Console) -> Settings:
		"""Loads settings in the CLI.

feat: skip syntax errors #17

feat: skip syntax errors #17

Conversation

bm424 commented Jun 28, 2022

This comment was marked as resolved.

This comment was marked as outdated.

Hellebore left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment