pydocstring 0.4.0

A zero-dependency Rust parser for Python docstrings (Google and NumPy styles) with a unified syntax tree and byte-precise source locations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

//! Convert a plain-style AST into the style-independent [`Docstring`] model.

use crate::model::Docstring;
use crate::parse::plain::nodes::PlainDocstring;
use crate::syntax::Parsed;

/// Build a [`Docstring`] from a plain-style [`Parsed`] result.
///
/// Returns `None` if the docstring was not parsed as
/// [`Style::Plain`](crate::parse::Style::Plain).
pub fn to_model(parsed: &Parsed) -> Option<Docstring> {
    if parsed.style() != crate::parse::Style::Plain {
        return None;
    }
    let root = PlainDocstring::cast(parsed, parsed.root())?;

    Some(Docstring {
        summary: root.summary().map(|t| t.text().to_owned()),
        extended_summary: root.extended_summary().map(|t| t.text().to_owned()),
        directives: Vec::new(),
        sections: Vec::new(),
    })
}