rustpython-doc 0.3.0

Python __doc__ database.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use once_cell::sync::Lazy;
use std::collections::HashMap;

pub type Result<'a> = std::result::Result<Option<&'a str>, ()>;

pub struct Database<'a> {
    inner: HashMap<&'a str, Option<&'a str>>,
}

impl<'a> Database<'a> {
    pub fn shared() -> &'static Self {
        static DATABASE: Lazy<Database> = Lazy::new(|| {
            let data = include!("../docs.inc.rs");
            let mut map = HashMap::with_capacity(data.len());
            for (item, doc) in data {
                map.insert(item, doc);
            }
            Database { inner: map }
        });
        &DATABASE
    }

    pub fn try_path(&self, path: &str) -> Result {
        self.inner.get(path).copied().ok_or(())
    }

    pub fn try_module_item(&self, module: &str, item: &str) -> Result {
        self.try_path(&format!("{}.{}", module, item))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_module_item() {
        let doc = Database::shared()
            .try_module_item("array", "_array_reconstructor")
            .unwrap();
        assert!(doc.is_some());
    }
}