ruff_linter 0.16.4

This is an internal component crate of Ruff
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use std::fmt::{Debug, Formatter};
use std::ops::Deref;

use ruff_python_ast::{self as ast, StringFlags};
use ruff_python_semantic::Definition;
use ruff_source_file::LineRanges;
use ruff_text_size::{Ranged, TextRange, TextSize};

pub(crate) mod extraction;
pub(crate) mod google;
pub(crate) mod numpy;
pub(crate) mod sections;
pub(crate) mod styles;

#[derive(Debug)]
pub(crate) struct Docstring<'a> {
    pub(crate) definition: &'a Definition<'a>,
    /// The literal AST node representing the docstring.
    pub(crate) expr: &'a ast::StringLiteral,
    /// The source file the docstring was defined in.
    pub(crate) source: &'a str,
}

impl<'a> Docstring<'a> {
    fn flags(&self) -> ast::StringLiteralFlags {
        self.expr.flags
    }

    /// The contents of the docstring, including the opening and closing quotes.
    pub(crate) fn contents(&self) -> &'a str {
        &self.source[self.range()]
    }

    /// The contents of the docstring, excluding the opening and closing quotes.
    pub(crate) fn body(&self) -> DocstringBody<'_> {
        DocstringBody { docstring: self }
    }

    /// Compute the start position of the docstring's opening line
    pub(crate) fn line_start(&self) -> TextSize {
        self.source.line_start(self.start())
    }

    /// Return the slice of source code that represents the indentation of the docstring's opening quotes.
    pub(crate) fn compute_indentation(&self) -> &'a str {
        &self.source[TextRange::new(self.line_start(), self.start())]
    }

    pub(crate) fn quote_style(&self) -> ast::str::Quote {
        self.flags().quote_style()
    }

    pub(crate) fn is_raw_string(&self) -> bool {
        self.flags().prefix().is_raw()
    }

    pub(crate) fn is_u_string(&self) -> bool {
        self.flags().prefix().is_unicode()
    }

    pub(crate) fn is_triple_quoted(&self) -> bool {
        self.flags().is_triple_quoted()
    }

    /// The docstring's prefixes as they exist in the original source code.
    pub(crate) fn prefix_str(&self) -> &'a str {
        // N.B. This will normally be exactly the same as what you might get from
        // `self.flags().prefix().as_str()`, but doing it this way has a few small advantages.
        // For example, the casing of the `u` prefix will be preserved if it's a u-string.
        &self.source[TextRange::new(
            self.start(),
            self.start() + self.flags().prefix().text_len(),
        )]
    }

    /// The docstring's "opener" (the string's prefix, if any, and its opening quotes).
    pub(crate) fn opener(&self) -> &'a str {
        &self.source[TextRange::new(self.start(), self.start() + self.flags().opener_len())]
    }

    /// The docstring's closing quotes.
    pub(crate) fn closer(&self) -> &'a str {
        &self.source[TextRange::new(self.end() - self.flags().closer_len(), self.end())]
    }
}

impl Ranged for Docstring<'_> {
    fn range(&self) -> TextRange {
        self.expr.range()
    }
}

#[derive(Copy, Clone)]
pub(crate) struct DocstringBody<'a> {
    docstring: &'a Docstring<'a>,
}

impl<'a> DocstringBody<'a> {
    pub(crate) fn as_str(self) -> &'a str {
        &self.docstring.source[self.range()]
    }
}

impl Ranged for DocstringBody<'_> {
    fn range(&self) -> TextRange {
        self.docstring.expr.content_range()
    }
}

impl Deref for DocstringBody<'_> {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        self.as_str()
    }
}

impl Debug for DocstringBody<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("DocstringBody")
            .field("text", &self.as_str())
            .field("range", &self.range())
            .finish()
    }
}