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

yara_x/__init__.pyi

@@ -1,10 +1,16 @@
 import typing
+import collections
 
 class Compiler:
     r"""
     Compiles YARA source code producing a set of compiled [`Rules`].
     """
-    def new(self, relaxed_re_syntax: bool, error_on_slow_pattern: bool) -> Compiler:
+    def __new__(
+        cls,
+        relaxed_re_syntax: bool = False,
+        error_on_slow_pattern: bool = False,
+        includes_enabled: bool = True,
+    ) -> Compiler:
         r"""
         Creates a new [`Compiler`].
 
@@ -22,6 +28,9 @@ class Compiler:
 
         The `error_on_slow_pattern` argument tells the compiler to treat slow
         patterns as errors, instead of warnings.
+
+        The `includes_enabled` argument controls whether the compiler should
+        enable or disable the inclusion of files with the `include` directive.
         """
         ...
 
@@ -140,12 +149,79 @@ class Compiler:
         """
         ...
 
+class Scanner:
+    r"""
+    Scans data with already compiled YARA rules.
+
+    The scanner receives a set of compiled [`Rules`] and scans data with those
+    rules. The same scanner can be used for scanning multiple files or in-memory
+    data sequentially, but you need multiple scanners for scanning in parallel.
+    """
+
+    def __new__(cls, rules: Rules) -> Scanner:
+        r"""
+        Creates a new [`Scanner`] with a given set of [`Rules`].
+        """
+        ...
+
+    def scan(self, data: bytes) -> ScanResults:
+        r"""
+        Scans in-memory data.
+        """
+        ...
+
+    def scan_file(self, file: str) -> ScanResults:
+        r"""
+        Scans a file
+        """
+        ...
+
+    def set_global(self, ident: str, value: typing.Any):
+        r"""
+        Sets the value of a global variable.
+
+        The variable must has been previously defined by calling
+        [`Compiler::define_global`], and the type it has during the definition
+        must match the type of the new value.
+
+        The variable will retain the new value in subsequent scans, unless this
+        function is called again for setting a new value.
+
+        The type of `value` must be: `bool`, `str`, `bytes`, `int` or `float`.
+
+        # Raises
+
+        [TypeError](https://docs.python.org/3/library/exceptions.html#TypeError)
+        if the type of `value` is not one of the supported ones.
+        """
+        ...
+
+    def set_timeout(self, seconds: int):
+        r"""
+        Sets a timeout for each scan.
+
+        After setting a timeout scans will abort after the specified `seconds`.
+        """
+        ...
+
+    def console_log(self, callback: collections.abc.Callable[str]):
+        r"""
+        Sets a callback that is invoked every time a YARA rule calls the
+        `console` module.
+
+        The `callback` function is invoked with a string representing the
+        message being logged. The function can print the message to stdout,
+        append it to a file, etc. If no callback is set these messages are
+        ignored.
+        """
+        ...
+
 class Formatter:
     r"""
     Formats YARA rules.
     """
-    def new(
-        self,
+    def __new__(
+        cls,
         align_metadata: bool,
         align_patterns: bool,
         indent_section_headers: bool,
@@ -268,7 +344,7 @@ class Rules:
         ...
 
     @staticmethod
-    def deserialize_from(self, file: typing.Any) -> Rules:
+    def deserialize_from(file: typing.Any) -> Rules:
         r"""
         Deserializes rules from a file-like object.
         """
@@ -301,9 +377,9 @@ def compile(src: str) -> Rules:
 
 class Module:
     r"""A YARA-X module."""
-    def new(self, name: str) -> 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(data: str) -> dict:
+    def invoke(self, data: str) -> dict:
         r"""Parse the data and collect module metadata."""
-        ...
+        ...

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yara-x
-Version: 1.4.0
+Version: 1.5.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -8,7 +8,6 @@ Classifier: License :: OSI Approved :: BSD License
 Summary: Python bindings for YARA-X
 Keywords: pattern-matching,cybersecurity,forensics,malware,yara
 Home-Page: https://virustotal.github.io/yara-x
-License: BSD-3-Clause
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: homepage, https://virustotal.github.io/yara-x

yara_x-1.5.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+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,,

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

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

yara_x-1.4.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-yara_x/__init__.py,sha256=nMyCIYe2XAcE0xoh-kWfMlEZjVx9_cnT6O6Iaxh9JoM,107
-yara_x/__init__.pyi,sha256=XHHI2JILfrN55nB7Mf2ySKBF2vLGrp6LijAkCQESekc,9621
-yara_x/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yara_x/yara_x.pypy310-pp73-aarch64-linux-gnu.so,sha256=Dj-YV6DCR47gCe3lzwvUunU6OxgngT9Hb6zoWy4FDmY,27696104
-yara_x-1.4.0.dist-info/METADATA,sha256=XVKyoxe5wKEIcIWJMX7ZTW8a5QtnHIkrvLkkoV4CL7s,1853
-yara_x-1.4.0.dist-info/WHEEL,sha256=Z4zTVTi5r1QTBrbF9jjHkDUGWaL1FPOqxIXfrI-LFG8,117
-yara_x-1.4.0.dist-info/RECORD,,