Merge pull request #58 from quesurifn/stopwords_attribute

Add read-only stopwords attribute to Yake python class

Author: bunny-therapist

python/src/lib.rs

@@ -1,4 +1,5 @@
 use std::collections::HashSet;
+use std::ops::Deref;
 
 use pyo3::exceptions::PyTypeError;
 use pyo3::prelude::*;
@@ -58,6 +59,11 @@ impl Yake {
     pub fn get_n_best(&self, py: Python, text: &str, n: usize) -> Vec<(String, f64)> {
         py.allow_threads(|| get_n_best_sequential(n, text, &self._stopwords, &self._config))
     }
+
+    #[getter]
+    fn get_stopwords(&self) -> PyResult<HashSet<String>> {
+        Ok(HashSet::from_iter(self._stopwords.iter().cloned()))
+    }
 }
 
 fn get_n_best_sequential(

python/src/yake_rust/_lib.pyi

@@ -34,3 +34,5 @@ class Yake:
         minimum_chars: int | None = None,
     ) -> None: ...
     def get_n_best(self, text: str, *, n: int) -> list[tuple[str, float]]: ...
+    @property
+    def stopwords(self) -> set[str]: ...

python/tests/test_yake_rust.py

@@ -31,6 +31,23 @@ def test_instantiate_yake_with_custom_stopwords() -> None:
     _ = yake_rust.Yake(stopwords={"stop", "word"})
 
 
+def test_yake_stopwords_attribute__custom() -> None:
+    stopwords = {"stop", "word"}
+    yake = yake_rust.Yake(stopwords=stopwords)
+    assert yake.stopwords == stopwords
+
+
+def test_yake_stopwords_attribute__language() -> None:
+    yake = yake_rust.Yake(language="en")
+    assert yake.stopwords
+
+
+def test_yake_stopwords_attribute__read_only() -> None:
+    yake = yake_rust.Yake(language="en")
+    with pytest.raises(AttributeError, match="stopwords"):
+        yake.stopwords = set()  # type: ignore[misc]
+
+
 @pytest.mark.parametrize(
     "kwargs",
     [{}, {"language": "en", "stopwords": {"stopwords"}}, {"bad": 1}],