feat: enable ty; upgrade uv.lock (#42)

feat: enable ty; upgrade uv.lock

Author: kevin-acsc

azul_plugin_yara/main.py

@@ -93,22 +93,22 @@ class AzulPluginYara(BinaryPlugin):
     ]
     _cached_rules = None
 
-    def __init__(self, config: settings.Settings | dict = None) -> None:
+    def __init__(self, config: settings.Settings | dict | None = None) -> None:
         """Check correct config and load/cache rules."""
         super().__init__(config)
-        if not self.cfg.yara_rules_path or not self.cfg.name_suffix or not self.cfg.version_suffix:
+        if not self.cfg.yara_rules_path or not self.cfg.name_suffix or not self.cfg.version_suffix:  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
             raise Exception("Plugin requires 'yara_rules_path', 'name_suffix' and 'version_suffix' config to be set")
 
         if not self.cfg.security_override:
             raise Exception("Plugin requires 'security_override' to be defined")
 
         # handle config override with env string
-        blacklist = self.cfg.yara_namespace_blacklist
+        blacklist = self.cfg.yara_namespace_blacklist  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
         if isinstance(blacklist, str):
             blacklist = blacklist.split(",")
 
         # Handle a list of regex to only load certain file types
-        yara_file_to_load_regex = self.cfg.yara_only_load_files_named
+        yara_file_to_load_regex = self.cfg.yara_only_load_files_named  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
         if isinstance(yara_file_to_load_regex, list) and len(yara_file_to_load_regex) > 0:
             yara_file_to_load_regex = [re.compile(expression) for expression in yara_file_to_load_regex]
         elif isinstance(yara_file_to_load_regex, str):
@@ -117,10 +117,12 @@ def __init__(self, config: settings.Settings | dict = None) -> None:
             yara_file_to_load_regex = None
 
         self.namespace_to_rule_path: dict[str, str] = list_rules(
-            self.cfg.yara_rules_path, blacklist, yara_file_to_load_regex
+            self.cfg.yara_rules_path,  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
+            blacklist,
+            yara_file_to_load_regex,
         )
         if not self.namespace_to_rule_path:
-            raise Exception("No yara rules found in %s path" % self.cfg.yara_rules_path)
+            raise Exception("No yara rules found in %s path" % self.cfg.yara_rules_path)  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
 
         self.logger.info(f"Loaded {len(self.namespace_to_rule_path)} files containing yara rules.")
         if len(self.namespace_to_rule_path) < 20:
@@ -144,13 +146,15 @@ def execute(self, job: Job):
                 if "." in fname:
                     ext = fname.rsplit(".", 1)[-1]
 
+        if self._cached_rules is None:
+            raise TypeError("Expected self._cached_rules to be Rules. got None")
         scanner = yara_x.Scanner(self._cached_rules)
         scanner.set_global("filename", fname)
         scanner.set_global("filepath", fpath)
         scanner.set_global("extension", ext)
         scanner.set_global("filetype", ftype)
         # if binary over certain size, write to disk first
-        if job.event.entity.size > self.cfg.size_before_disk:
+        if job.event.entity.size > self.cfg.size_before_disk:  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
             matches = scanner.scan_file(job.get_data().get_filepath())  # type: yara_x.ScanResults
         else:
             matches = scanner.scan(job.get_data().read())  # type: yara_x.ScanResults
@@ -182,7 +186,7 @@ def execute(self, job: Job):
                 if new_rule not in seen_rules_md5s:
                     seen_rules_md5s.append(new_rule)
                     # Add the original yara rule that hit as an augmented stream. Stop at max allowed Augmented streams.
-                    if yara_rule_streams_added < self.cfg.max_yara_hit_streams_to_keep:
+                    if yara_rule_streams_added < self.cfg.max_yara_hit_streams_to_keep:  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
                         raw_rule_with_header = (
                             f"// plugin: {self.NAME}, namespace_identifier: {rule}\n".encode() + raw_rule
                         )
@@ -228,7 +232,10 @@ def execute(self, job: Job):
         self.add_feature_values("yararule_match_name", names)
         self.add_feature_values(
             "yararule_match",
-            [FV(val, label=rule, offset=offset, size=len(val)) for rule, offset, _, val in match_tuples],
+            [
+                FV(val, label=rule, offset=offset, size=len(val) if val is not None else 0)
+                for rule, offset, _, val in match_tuples
+            ],
         )
 
         if not all(found_raw_rule.values()):
@@ -299,7 +306,7 @@ def fetch_original_rule(self, rule_path: str, rule_identifier: str, logger: logg
         if not start_of_rule:
             # Ensure recursive yara includes don't end in an infinite loop
             self.yara_include_depth += 1
-            if self.yara_include_depth >= self.cfg.max_yara_include_depth:
+            if self.yara_include_depth >= self.cfg.max_yara_include_depth:  # ty: ignore[unresolved-attribute] ty doesn't understand add_settings
                 return b""
             # Search included yara files.
             for included_path in included_yara_rule_paths:

pyproject.toml

@@ -152,3 +152,6 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 docstring-code-format = false
 docstring-code-line-length = "dynamic"
+
+[tool.ty.src]
+exclude = ["tests"]

tox.ini

@@ -27,7 +27,7 @@ setenv =
 commands =
     ruff check
     ruff format --check
-    ty check --exit-zero
+    ty check
 
 [testenv:test]
 # index-url is passed by default, trusted-host is not