Made retrievers accessible in python

Author: Divy1211

docs/pages/reference/types/base_struct.md

@@ -4,6 +4,7 @@
             "ver",
             "__new__",
             "__reconstruct__",
+            "retrievers",
             "from_stream",
             "to_bytes",
             "from_base",

src/retrievers/retriever.rs

@@ -28,21 +28,30 @@ pub enum RetState {
 #[pyclass(module = "bfp_rs")]
 #[derive(Debug, Clone)]
 pub struct Retriever {
+    #[pyo3(get)]
     pub idx: usize,
-    
+
+    #[pyo3(get)]
     pub data_type: BfpType,
 
+    #[pyo3(get)]
     min_ver: Version,
+
+    #[pyo3(get)]
     max_ver: Version,
 
+    #[pyo3(get)]
     pub repeat: isize,
+
+    #[pyo3(get)]
     pub remaining_compressed: bool,
 
+    #[pyo3(get)]
     pub name: String,
 
     on_read: Option<Arc<Vec<CombinatorType>>>,
     on_write: Option<Arc<Vec<CombinatorType>>>,
-    
+
     default: Option<Arc<PyObject>>,
     default_factory: Option<Arc<PyObject>>,
 

src/types/base_struct.rs

@@ -8,7 +8,7 @@ use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
 use pyo3::exceptions::{PyAttributeError, PyTypeError};
 use pyo3::intern;
 use pyo3::prelude::*;
-use pyo3::types::{PyBytes, PyDict, PyTuple, PyType};
+use pyo3::types::{PyBytes, PyDict, PyList, PyTuple, PyType};
 use serde::de::DeserializeSeed;
 use serde_json::Deserializer;
 
@@ -220,6 +220,15 @@ impl BaseStruct {
         slf.raw.read().expect("GIL bound read").ver.clone()
     }
 
+    #[classmethod]
+    fn retrievers<'py>(cls: &Bound<'py, PyType>) -> PyResult<Bound<'py, PyList>> {
+        let struct_ = StructBuilder::get_struct(&cls)?;
+        Ok(PyList::new_bound(
+            cls.py(),
+            struct_.retrievers().iter().map(|x| x.clone().into_py(cls.py()))
+        ))
+    }
+
     #[new]
     #[classmethod]
     #[pyo3(signature = (*_args, ver = Version::new(vec![-1]), ctx = ContextPtr::new(), init_defaults = true, **retriever_inits))]

stubs/bfp_rs/retrievers/retriever.pyi

@@ -13,6 +13,14 @@ class Retriever:
     allowing setting constraints and hooks
     """
 
+    idx: int
+    data_type: Any
+    min_ver: Version
+    max_ver: Version
+    repeat: int
+    remaining_compressed: bool
+    name: str
+
     def __new__(
         cls,
         data_type: Any,

stubs/bfp_rs/types/base_struct.pyi

@@ -1,5 +1,6 @@
 from typing import Any, Self
 
+from bfp_rs.retrievers import Retriever
 from bfp_rs.types.byte_stream import ByteStream
 from bfp_rs.types.context import Context
 from bfp_rs.types.version import Version
@@ -13,6 +14,10 @@ class BaseStruct:
     ver: Version
     "The version of the struct"
 
+    @classmethod
+    def retrievers(cls) -> list[Retriever]:
+        ...
+
     def __new__(cls, *args, ver: Version = Version(-1), ctx: Context = Context(), init_defaults: bool = True, **retriever_inits: Any) -> Self:
         """
         Default initialise and create a new instance of this struct