ruff_linter 0.16.3

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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

use crate::rules::isort::sorting::ImportStyle;
use crate::rules::isort::{ImportSection, ImportType};
use itertools::Itertools;

use super::settings::Settings;
use super::sorting::{MemberKey, ModuleKey};
use super::types::EitherImport::{self, Import, ImportFrom};
use super::types::{AliasData, ImportBlock, ImportFromCommentSet, ImportFromStatement};

pub(crate) fn order_imports<'a>(
    block: ImportBlock<'a>,
    section: &ImportSection,
    settings: &Settings,
) -> Vec<EitherImport<'a>> {
    let straight_imports = block.import.into_iter();

    // Include all non-re-exports.
    let from_imports = block
        .import_from
        .into_iter()
        .chain(
            // Include all re-exports.
            block
                .import_from_as
                .into_iter()
                .map(|((import_from, ..), body)| (import_from, body)),
        )
        .chain(
            // Include all star imports.
            block.import_from_star,
        )
        .map(
            |(
                import_from,
                ImportFromStatement {
                    first_index,
                    comments,
                    aliases,
                    trailing_comma,
                },
            )| {
                // Within each `Stmt::ImportFrom`, sort the members.
                (
                    import_from,
                    first_index.unwrap_or_default(),
                    comments,
                    trailing_comma,
                    aliases
                        .into_iter()
                        .sorted_by_cached_key(|(alias, _)| {
                            MemberKey::from_member(alias.name, alias.asname, settings)
                        })
                        .collect::<Vec<(AliasData, ImportFromCommentSet)>>(),
                )
            },
        );

    if matches!(section, ImportSection::Known(ImportType::Future)) {
        let ordered_from_imports = from_imports
            .sorted_by_cached_key(|(import_from, first_index, _, _, aliases)| {
                (
                    ModuleKey::from_module(
                        import_from.module,
                        None,
                        import_from.level,
                        aliases.first().map(|(alias, _)| (alias.name, alias.asname)),
                        ImportStyle::From,
                        settings,
                    ),
                    *first_index,
                )
            })
            .collect::<Vec<_>>();
        let mut eager_from_imports = vec![];
        let mut lazy_from_imports = vec![];
        for import_from in ordered_from_imports {
            if import_from.0.is_lazy {
                lazy_from_imports.push(import_from);
            } else {
                eager_from_imports.push(import_from);
            }
        }

        let ordered_straight_imports = straight_imports
            .sorted_by_cached_key(|(alias, comments)| {
                (
                    ModuleKey::from_module(
                        Some(alias.name),
                        alias.asname,
                        0,
                        None,
                        ImportStyle::Straight,
                        settings,
                    ),
                    comments.first_index.unwrap_or_default(),
                )
            })
            .collect::<Vec<_>>();
        let mut eager_straight_imports = vec![];
        let mut lazy_straight_imports = vec![];
        for import in ordered_straight_imports {
            if import.0.is_lazy {
                lazy_straight_imports.push(import);
            } else {
                eager_straight_imports.push(import);
            }
        }

        eager_from_imports
            .into_iter()
            .map(|(import_from, _, comments, trailing_comma, aliases)| {
                ImportFrom((import_from, comments, trailing_comma, aliases))
            })
            .chain(eager_straight_imports.into_iter().map(Import))
            .chain(lazy_from_imports.into_iter().map(
                |(import_from, _, comments, trailing_comma, aliases)| {
                    ImportFrom((import_from, comments, trailing_comma, aliases))
                },
            ))
            .chain(lazy_straight_imports.into_iter().map(Import))
            .collect()
    } else if settings.force_sort_within_sections {
        let ordered_imports = straight_imports
            .map(|(alias, comments)| {
                let first_index = comments.first_index.unwrap_or_default();
                (Import((alias, comments)), first_index)
            })
            .chain(from_imports.map(
                |(import_from, first_index, comments, trailing_comma, aliases)| {
                    (
                        ImportFrom((import_from, comments, trailing_comma, aliases)),
                        first_index,
                    )
                },
            ))
            .sorted_by_cached_key(|(import, first_index)| match import {
                Import((alias, _)) => (
                    ModuleKey::from_module(
                        Some(alias.name),
                        alias.asname,
                        0,
                        None,
                        ImportStyle::Straight,
                        settings,
                    ),
                    *first_index,
                ),
                ImportFrom((import_from, _, _, aliases)) => (
                    ModuleKey::from_module(
                        import_from.module,
                        None,
                        import_from.level,
                        aliases.first().map(|(alias, _)| (alias.name, alias.asname)),
                        ImportStyle::From,
                        settings,
                    ),
                    *first_index,
                ),
            })
            .collect::<Vec<_>>();

        let mut eager_imports = vec![];
        let mut lazy_imports = vec![];
        for (import, first_index) in ordered_imports {
            let is_lazy = match &import {
                Import((alias, _)) => alias.is_lazy,
                ImportFrom((import_from, _, _, _)) => import_from.is_lazy,
            };
            if is_lazy {
                lazy_imports.push((import, first_index));
            } else {
                eager_imports.push((import, first_index));
            }
        }

        eager_imports
            .into_iter()
            .chain(lazy_imports)
            .map(|(import, _)| import)
            .collect()
    } else {
        let ordered_straight_imports = straight_imports
            .sorted_by_cached_key(|(alias, comments)| {
                (
                    ModuleKey::from_module(
                        Some(alias.name),
                        alias.asname,
                        0,
                        None,
                        ImportStyle::Straight,
                        settings,
                    ),
                    comments.first_index.unwrap_or_default(),
                )
            })
            .collect::<Vec<_>>();
        let mut eager_straight_imports = vec![];
        let mut lazy_straight_imports = vec![];
        for import in ordered_straight_imports {
            if import.0.is_lazy {
                lazy_straight_imports.push(import);
            } else {
                eager_straight_imports.push(import);
            }
        }

        let ordered_from_imports = from_imports
            .sorted_by_cached_key(|(import_from, first_index, _, _, aliases)| {
                (
                    ModuleKey::from_module(
                        import_from.module,
                        None,
                        import_from.level,
                        aliases.first().map(|(alias, _)| (alias.name, alias.asname)),
                        ImportStyle::From,
                        settings,
                    ),
                    *first_index,
                )
            })
            .collect::<Vec<_>>();
        let mut eager_from_imports = vec![];
        let mut lazy_from_imports = vec![];
        for import_from in ordered_from_imports {
            if import_from.0.is_lazy {
                lazy_from_imports.push(import_from);
            } else {
                eager_from_imports.push(import_from);
            }
        }
        if settings.from_first {
            eager_from_imports
                .into_iter()
                .map(|(import_from, _, comments, trailing_comma, aliases)| {
                    ImportFrom((import_from, comments, trailing_comma, aliases))
                })
                .chain(eager_straight_imports.into_iter().map(Import))
                .chain(lazy_from_imports.into_iter().map(
                    |(import_from, _, comments, trailing_comma, aliases)| {
                        ImportFrom((import_from, comments, trailing_comma, aliases))
                    },
                ))
                .chain(lazy_straight_imports.into_iter().map(Import))
                .collect()
        } else {
            eager_straight_imports
                .into_iter()
                .map(Import)
                .chain(eager_from_imports.into_iter().map(
                    |(import_from, _, comments, trailing_comma, aliases)| {
                        ImportFrom((import_from, comments, trailing_comma, aliases))
                    },
                ))
                .chain(lazy_straight_imports.into_iter().map(Import))
                .chain(lazy_from_imports.into_iter().map(
                    |(import_from, _, comments, trailing_comma, aliases)| {
                        ImportFrom((import_from, comments, trailing_comma, aliases))
                    },
                ))
                .collect()
        }
    }
}