Skip to content

Commit 2ae183b

Browse files
committed
chore: fixup comments and typing flags
Signed-off-by: Ben Selwyn-Smith <[email protected]>
1 parent a49c526 commit 2ae183b

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

src/macaron/malware_analyzer/pypi_heuristics/sourcecode/pypi_sourcecode_analyzer.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import json
1212
import logging
1313
import os
14-
import subprocess # nosec
14+
import subprocess # nosec B404
1515
import tempfile
1616

1717
import yaml
@@ -120,7 +120,7 @@ def _load_defaults(self, resources_path: str) -> tuple[str, str | None, set[str]
120120

121121
semgrep_commands: list[str] = ["semgrep", "scan", "--validate", "--oss-only", "--config", custom_rule_path]
122122
try:
123-
process = subprocess.run(semgrep_commands, check=True, capture_output=True) # nosec
123+
process = subprocess.run(semgrep_commands, check=True, capture_output=True) # nosec B603
124124
except (subprocess.CalledProcessError, subprocess.TimeoutExpired) as semgrep_error:
125125
error_msg = (
126126
f"Unable to run semgrep validation on {custom_rule_path} with arguments "
@@ -185,8 +185,8 @@ def _extract_rule_ids(self, path: str, target_files: set[str]) -> set[str]:
185185
If any Semgrep rule file could not be safely loaded, or if their format was not in the expected Semgrep
186186
format, or if there were any files in 'target_files' not found when searching in 'path'.
187187
"""
188-
# We keep a record of any file paths we coulnd't find to provide a more useful error message, rather than raising
189-
# an error on the first missing file we see.
188+
# We keep a record of any file paths we couldn't find to provide a more useful error message, rather than
189+
# raising an error on the first missing file we see.
190190
missing_files: list[str] = []
191191
target_file_paths: list[str] = []
192192
rule_ids: set[str] = set()
@@ -211,7 +211,7 @@ def _extract_rule_ids(self, path: str, target_files: set[str]) -> set[str]:
211211
logger.debug(error_msg)
212212
raise ConfigurationError(error_msg) from yaml_error
213213

214-
# should be a top-level key "rules", and then a list of rules (dictionaries) with "id" entries
214+
# Should be a top-level key "rules", and then a list of rules (dictionaries) with "id" entries.
215215
try:
216216
for semgrep_rule in semgrep_ruleset["rules"]:
217217
rule_ids.add(semgrep_rule["id"])
@@ -243,7 +243,7 @@ def analyze(self, pypi_package_json: PyPIPackageJsonAsset) -> tuple[HeuristicRes
243243
if there is no source code available.
244244
"""
245245
analysis_result: dict = {}
246-
# since we have to run them anyway, return disabled rule findings for debug information
246+
# Since we have to run them anyway, return disabled rule findings for debug information.
247247
disabled_results: dict = {}
248248
# Here, we disable 'nosemgrep' ignoring so that this is not an evasion method of our scan (i.e. malware includes
249249
# 'nosemgrep' comments to prevent our scan detecting those code lines). Read more about the 'nosemgrep' feature
@@ -266,7 +266,7 @@ def analyze(self, pypi_package_json: PyPIPackageJsonAsset) -> tuple[HeuristicRes
266266
semgrep_commands.append(f"--json-output={output_json_file.name}")
267267
logger.debug("executing: %s.", semgrep_commands)
268268
try:
269-
process = subprocess.run(semgrep_commands, check=True, capture_output=True) # nosec
269+
process = subprocess.run(semgrep_commands, check=True, capture_output=True) # nosec B603
270270
except (subprocess.CalledProcessError, subprocess.TimeoutExpired) as semgrep_error:
271271
error_msg = (
272272
f"Unable to run semgrep on {source_code_path} with arguments {semgrep_commands}: {semgrep_error}"
@@ -320,7 +320,7 @@ def analyze(self, pypi_package_json: PyPIPackageJsonAsset) -> tuple[HeuristicRes
320320
analysis_result[rule_id] = {"message": message, "detections": []}
321321
analysis_result[rule_id]["detections"].append({"file": file, "start": start, "end": end})
322322

323-
# some semgrep rules were triggered, even after removing disabled ones
323+
# Some semgrep rules were triggered, even after removing disabled ones.
324324
if analysis_result:
325325
result = HeuristicResult.FAIL
326326

src/macaron/parsers/pomparser.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Copyright (c) 2024 - 2024, Oracle and/or its affiliates. All rights reserved.
1+
# Copyright (c) 2024 - 2025, Oracle and/or its affiliates. All rights reserved.
22
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
33

44
"""This module contains the parser for POM files."""
55
import logging
6-
from xml.etree.ElementTree import Element # nosec
6+
from xml.etree.ElementTree import Element # nosec B405
77

88
import defusedxml.ElementTree
99
from defusedxml.ElementTree import fromstring

src/macaron/repo_finder/repo_finder_java.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import logging
66
import re
77
import urllib.parse
8-
from xml.etree.ElementTree import Element # nosec
8+
from xml.etree.ElementTree import Element # nosec B405
99

1010
from packageurl import PackageURL
1111

0 commit comments

Comments
 (0)