feat: expose all classes in python module

Author: vthib

boreal-py/src/lib.rs

@@ -11,7 +11,6 @@ use pyo3::{create_exception, ffi, intern};
 use ::boreal::compiler;
 
 // TODO: all clone impls should be efficient...
-// TODO: should all pyclasses have names and be exposed in the module?
 // TODO: check GIL handling in all functions (especially match)
 
 mod rule;
@@ -31,6 +30,20 @@ fn boreal(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add("ScanError", m.py().get_type::<scanner::ScanError>())?;
     m.add("TimeoutError", m.py().get_type::<scanner::TimeoutError>())?;
 
+    m.add("Rule", m.py().get_type::<rule::Rule>())?;
+    m.add("Match", m.py().get_type::<rule_match::Match>())?;
+    m.add("Scanner", m.py().get_type::<scanner::Scanner>())?;
+    m.add("RulesIter", m.py().get_type::<scanner::RulesIter>())?;
+    m.add(
+        "StringMatchInstance",
+        m.py()
+            .get_type::<string_match_instance::StringMatchInstance>(),
+    )?;
+    m.add(
+        "StringMatches",
+        m.py().get_type::<string_matches::StringMatches>(),
+    )?;
+
     Ok(())
 }
 

boreal-py/src/rule.rs

@@ -5,7 +5,7 @@ use ::boreal::scanner;
 use ::boreal::{Metadata, MetadataValue};
 
 /// A matching rule
-#[pyclass(frozen)]
+#[pyclass(frozen, module = "boreal")]
 pub struct Rule {
     /// Name of the rule
     #[pyo3(get)]

boreal-py/src/rule_match.rs

@@ -10,7 +10,7 @@ use crate::rule::convert_metadata;
 use crate::string_matches::StringMatches;
 
 /// A matching rule
-#[pyclass(frozen)]
+#[pyclass(frozen, module = "boreal")]
 pub struct Match {
     /// Name of the matching rule
     #[pyo3(get)]

boreal-py/src/scanner.rs

@@ -14,7 +14,7 @@ use crate::rule_match::Match;
 create_exception!(boreal, ScanError, PyException, "error when scanning");
 create_exception!(boreal, TimeoutError, PyException, "scan timed out");
 
-#[pyclass(frozen)]
+#[pyclass(frozen, module = "boreal")]
 pub struct Scanner {
     scanner: scanner::Scanner,
 
@@ -151,7 +151,7 @@ impl Scanner {
     }
 }
 
-#[pyclass]
+#[pyclass(module = "boreal")]
 pub struct RulesIter {
     rules_iter: std::vec::IntoIter<crate::rule::Rule>,
 }

boreal-py/src/string_match_instance.rs

@@ -5,7 +5,7 @@ use pyo3::prelude::*;
 use ::boreal::scanner;
 
 /// Match instance of a YARA string
-#[pyclass(frozen)]
+#[pyclass(frozen, module = "boreal")]
 #[derive(Clone)]
 pub struct StringMatchInstance {
     /// Offset of the match.

boreal-py/src/string_matches.rs

@@ -7,7 +7,7 @@ use ::boreal::scanner;
 use crate::string_match_instance::StringMatchInstance;
 
 /// List of match instances of a YARA string
-#[pyclass(frozen)]
+#[pyclass(frozen, module = "boreal")]
 #[derive(Clone)]
 pub struct StringMatches {
     /// Name of the matching string.