yara-x 1.5.0__pp310-pypy310_pp73-manylinux_2_28_aarch64.whl → 1.6.0__pp310-pypy310_pp73-manylinux_2_28_aarch64.whl

yara_x/__init__.pyi

@@ -1,6 +1,23 @@
-import typing
 import collections
 
+from typing import Any, Dict, BinaryIO, TextIO, Optional, Tuple, final
+
+class CompileError(Exception):
+    r"""
+    Error occurred while compiling rules.
+    """
+
+class ScanError(Exception):
+    r"""
+    Error occurred during a scan operation.
+    """
+
+class TimeoutError(Exception):
+    r"""
+    Error indicating that a timeout occurred during a scan operation.
+    """
+
+@final
 class Compiler:
     r"""
     Compiles YARA source code producing a set of compiled [`Rules`].
@@ -34,7 +51,7 @@ class Compiler:
         """
         ...
 
-    def add_source(self, src: str, origin: typing.Optional[str]) -> None:
+    def add_source(self, src: str, origin: Optional[str] = None) -> None:
         r"""
         Adds a YARA source code to be compiled.
 
@@ -56,7 +73,20 @@ class Compiler:
         """
         ...
 
-    def define_global(self, ident: str, value: typing.Any) -> None:
+    def add_include_dir(self, dir: str) -> None:
+        r"""
+        Adds a directory to the list of directories where the compiler should
+        look for included files.
+        """
+        ...
+
+    def enable_includes(self, yes: bool) -> None:
+        r"""
+        Enables or disables the inclusion of files with the `include` directive.
+        """
+        ...
+
+    def define_global(self, ident: str, value: Any) -> None:
         r"""
         Defines a global variable and sets its initial value.
 
@@ -105,7 +135,7 @@ class Compiler:
         """
         ...
 
-    def errors(self) -> typing.Any:
+    def errors(self) -> Any:
         r"""
         Retrieves all errors generated by the compiler.
 
@@ -114,7 +144,7 @@ class Compiler:
         """
         ...
 
-    def warnings(self) -> typing.Any:
+    def warnings(self) -> Any:
         r"""
         Retrieves all warnings generated by the compiler.
 
@@ -135,20 +165,7 @@ class Compiler:
         """
         ...
 
-    def required_metadata(self, regexp: typing.Dict[str, str]) -> None:
-        r"""
-        Specify required metadata identifiers and types for the values in each
-        rule. Any rule which does not meet these requirements will result in a
-        compiler warning.
-
-        The key in your dictionary corresponds to the metadata identifier and
-        the value in your dictionary corresponds to the required type for that
-        metadata in the rule.
-
-        Acceptable values are documented in [the config file](https://virustotal.github.io/yara-x/docs/cli/config-file/).
-        """
-        ...
-
+@final
 class Scanner:
     r"""
     Scans data with already compiled YARA rules.
@@ -170,13 +187,13 @@ class Scanner:
         """
         ...
 
-    def scan_file(self, file: str) -> ScanResults:
+    def scan_file(self, path: str) -> ScanResults:
         r"""
         Scans a file
         """
         ...
 
-    def set_global(self, ident: str, value: typing.Any):
+    def set_global(self, ident: str, value: Any) -> None:
         r"""
         Sets the value of a global variable.
 
@@ -196,7 +213,7 @@ class Scanner:
         """
         ...
 
-    def set_timeout(self, seconds: int):
+    def set_timeout(self, seconds: int) -> None:
         r"""
         Sets a timeout for each scan.
 
@@ -204,7 +221,7 @@ class Scanner:
         """
         ...
 
-    def console_log(self, callback: collections.abc.Callable[str]):
+    def console_log(self, callback: collections.abc.Callable[[str], Any]) -> None:
         r"""
         Sets a callback that is invoked every time a YARA rule calls the
         `console` module.
@@ -216,20 +233,21 @@ class Scanner:
         """
         ...
 
+@final
 class Formatter:
     r"""
     Formats YARA rules.
     """
     def __new__(
         cls,
-        align_metadata: bool,
-        align_patterns: bool,
-        indent_section_headers: bool,
-        indent_section_contents: bool,
-        indent_spaces: int,
-        newline_before_curly_brace: bool,
-        empty_line_before_section_header: bool,
-        empty_line_after_section_header: bool,
+        align_metadata: bool = True,
+        align_patterns: bool = True,
+        indent_section_headers: bool = True,
+        indent_section_contents: bool = True,
+        indent_spaces: int = 2,
+        newline_before_curly_brace: bool = False,
+        empty_line_before_section_header: bool = True,
+        empty_line_after_section_header: bool = False,
     ) -> Formatter:
         r"""
         Creates a new [`Formatter`].
@@ -245,73 +263,87 @@ class Formatter:
         """
         ...
 
-    def format(self, input: typing.Any, output: typing.Any) -> str:
+    def format(self, input: TextIO, output: TextIO) -> None:
         r"""
         Format a YARA rule
         """
         ...
 
+@final
 class Match:
     r"""
     Represents a match found for a pattern.
     """
+    @property
     def offset(self) -> int:
         r"""
         Offset where the match occurred.
         """
         ...
 
+    @property
     def length(self) -> int:
         r"""
         Length of the match in bytes.
         """
         ...
 
-    def xor_key(self) -> typing.Optional[int]:
+    @property
+    def xor_key(self) -> Optional[int]:
         r"""
         XOR key used for decrypting the data if the pattern had the xor
         modifier, or None if otherwise.
         """
         ...
 
+@final
 class Pattern:
     r"""
     Represents a pattern in a YARA rule.
     """
+
+    @property
     def identifier(self) -> str:
         r"""
         Pattern identifier (e.g: '$a', '$foo').
         """
         ...
 
+    @property
     def matches(self) -> tuple:
         r"""
         Matches found for this pattern.
         """
         ...
 
+@final
 class Rule:
     r"""
     Represents a rule that matched while scanning some data.
     """
+
+    @property
     def identifier(self) -> str:
         r"""
         Returns the rule's name.
         """
         ...
 
+    @property
     def namespace(self) -> str:
         r"""
         Returns the rule's namespace.
         """
         ...
 
+    @property
     def tags(self) -> tuple:
         r"""
         Returns the rule's tags.
         """
         ...
 
+    @property
     def metadata(self) -> tuple:
         r"""
         A tuple of pairs `(identifier, value)` with the metadata associated to
@@ -319,12 +351,14 @@ class Rule:
         """
         ...
 
+    @property
     def patterns(self) -> tuple:
         r"""
         Patterns defined by the rule.
         """
         ...
 
+@final
 class Rules:
     r"""
     A set of YARA rules in compiled form.
@@ -337,30 +371,34 @@ class Rules:
         """
         ...
 
-    def serialize_into(self, file: typing.Any) -> None:
+    def serialize_into(self, file: BinaryIO) -> None:
         r"""
         Serializes the rules into a file-like object.
         """
         ...
 
     @staticmethod
-    def deserialize_from(file: typing.Any) -> Rules:
+    def deserialize_from(file: BinaryIO) -> Rules:
         r"""
         Deserializes rules from a file-like object.
         """
         ...
 
+@final
 class ScanResults:
     r"""
     Results produced by a scan operation.
     """
-    def matching_rules(self) -> tuple:
+
+    @property
+    def matching_rules(self) -> Tuple[Rule, ...]:
         r"""
         Rules that matched during the scan.
         """
         ...
 
-    def module_outputs(self) -> dict:
+    @property
+    def module_outputs(self) -> Dict[str, Any]:
         r"""
         Module output from the scan.
         """
@@ -375,11 +413,12 @@ def compile(src: str) -> Rules:
     """
     ...
 
+@final
 class Module:
     r"""A YARA-X module."""
     def __new__(cls, name: str) -> Module:
         r"""Creates a new [`Module`] with the given name, which must be a valid YARA-X module name."""
         ...
-    def invoke(self, data: str) -> dict:
+    def invoke(self, data: str) -> Any:
         r"""Parse the data and collect module metadata."""
         ...

{yara_x-1.5.0.dist-info → yara_x-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yara-x
-Version: 1.5.0
+Version: 1.6.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy

yara_x-1.6.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+yara_x/__init__.py,sha256=nMyCIYe2XAcE0xoh-kWfMlEZjVx9_cnT6O6Iaxh9JoM,107
+yara_x/__init__.pyi,sha256=DVMCd5-GS1-Hm2Ib0DpW7OWWF6AOg7mNDXaV0MfRN9s,12469
+yara_x/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+yara_x/yara_x.pypy310-pp73-aarch64-linux-gnu.so,sha256=v2ouy1oCqkyyXIW9km1H8NeB82oS0c-PXahoTb4EF-I,29890608
+yara_x-1.6.0.dist-info/METADATA,sha256=SKakLaVrPLSAsxlTaGVTeEuxTR-Csa2pKQCcQ3CbaTA,1831
+yara_x-1.6.0.dist-info/WHEEL,sha256=bejOP9jECZ1K1j8okReeOUF9FLD5EvfOR8rWrOeANFc,117
+yara_x-1.6.0.dist-info/RECORD,,

{yara_x-1.5.0.dist-info → yara_x-1.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.3)
+Generator: maturin (1.9.4)
 Root-Is-Purelib: false
 Tag: pp310-pypy310_pp73-manylinux_2_28_aarch64
 

yara_x-1.5.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-yara_x/__init__.py,sha256=nMyCIYe2XAcE0xoh-kWfMlEZjVx9_cnT6O6Iaxh9JoM,107
-yara_x/__init__.pyi,sha256=T4g5Ujdu3fJ0Zeh5zoeeCZz7Aw1cIaaRjCoTkmclDzI,12055
-yara_x/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yara_x/yara_x.pypy310-pp73-aarch64-linux-gnu.so,sha256=h80MRpAhaf2vzZi35V-b-sOcvx5WVJx46PoUpWRJ2p8,29247160
-yara_x-1.5.0.dist-info/METADATA,sha256=R8xh9lqnmE-9i-RuvjJsBPnq8obnorzdn7Lqm9dAkxs,1831
-yara_x-1.5.0.dist-info/WHEEL,sha256=qqxQaU7qryPifNM-G4vC-ENTroHr8lOojZ3f0EjlvEs,117
-yara_x-1.5.0.dist-info/RECORD,,