add unnecessary_self_imports lint #7072

ebobrow · 2021-04-13T01:47:32Z

changelog: add unnecessary_self_imports lint

rust-highfive · 2021-04-13T01:47:35Z

(rust-highfive has picked a reviewer for you, use r? to override)

flip1995

The functions you implement to check if something is in scope seem really resource intensive to me. Have you looked in rustc if there is a query to determine if a item is in scope?

clippy_lints/src/unnecessary_self_imports.rs

flip1995 · 2021-04-14T08:19:56Z

TL;DR: Implement this lint on the AST, not the HIR. It'll be way easier.

I just noticed that you can't really implement this lint on the HIR, since the information if a self was involved in an import isn't available there anymore. It just gets lowered to

use path::to::module::{}; 
use path::to::module;

However on the AST you should be able to determine if it is an import of just self and if it has a as something pretty easily

AST `use` expansion

        Item {
            attrs: [],
            id: NodeId(4294967040),
            span: main.rs:5:1: 5:15 (#0),
            vis: Visibility {
                kind: Inherited,
                span: main.rs:5:1: 5:1 (#0),
                tokens: None,
            },
            ident: #0,
            kind: Use(
                UseTree {
                    prefix: Path {
                        span: main.rs:5:5: 5:6 (#0),
                        segments: [
                            PathSegment {
                                ident: a#0,
                                id: NodeId(4294967040),
                                args: None,
                            },
                        ],
                        tokens: None,
                    },
                    kind: Nested(
                        [
                            (
                                UseTree {
                                    prefix: Path {
                                        span: main.rs:5:9: 5:13 (#0),
                                        segments: [
                                            PathSegment {
                                                ident: self#0,
                                                id: NodeId(4294967040),
                                                args: None,
                                            },
                                        ],
                                        tokens: None,
                                    },
                                    kind: Simple(
                                        None,
                                        NodeId(4294967040),
                                        NodeId(4294967040),
                                    ),
                                    span: main.rs:5:9: 5:13 (#0),
                                },
                                NodeId(4294967040),
                            ),
                        ],
                    ),
                    span: main.rs:5:5: 5:14 (#0),
                },
            ),
            tokens: None,
        },

UseTree Documentation

You'll then have the problem to determine if the imported module is already there in form of another item (at least I think that is what you try to do with the other 2 functions?). But this isn't really a problem. rustc will already error if it is. And if you have an alias, you can just remove the self and use use path::to::module as alias directly.

camsteffen · 2021-04-14T13:50:08Z

It's a bit more complicated.

use a::b::{self} -> import the module a::b
use a::b; -> import the module and/or item a::b

So changing to the latter may cause "b is defined multiple times". (playground)

I think a late pass will be necessary to detect this. And UseKind::ListStem can maybe be used to detect ::{self}? Not sure. Seems hacky.

flip1995 · 2021-04-14T15:26:32Z

* `use a::b;` -> import the module and/or item `a::b`

Checking another case which shouldn't be a concern for this lint: Playground

So you only have to check which items are loaded in the current module. So instead of checking every use item you can just check on module level and walk over all items and lint on use items iff they aren't in scope in another form.

(That is on the AST. I really don't think we can implement this lint on the HIR reliably)

ebobrow · 2021-04-15T04:06:39Z

Couldn't self still be removed if an item with the same name exists in scope but not in the module? I'm not sure how to check modules in the AST.

flip1995 · 2021-04-16T14:28:52Z

Oh yeah, your right. The item could still be in scope from the surrounding scope... I'm starting to think that there is no feasible way to implement this. Your method works, but I hope that you agree that going over all defined items multiple times is too performance heavy.

Determining what would happen if we change code without recompiling is just really hard in general.

I see two ways going forward:

Not adding this lint. I'm not sure how helpful this lint is in the first place. When someone uses ::{self} it is either intentional or just a refactor artifact. It doesn't hurt to have it. An expensive lint for code style isn't justified IMO.
Ignore that the item could already be in scope and implement it as a restriction lint with a statement in the documentation that this lint isn't meant to be permanently enabled, but only to quickly check, e.g. after refactoring, if there are artifacts like this in the code.

camsteffen · 2021-04-16T16:46:01Z

if an item with the same name exists in scope but not in the module

I'm not following...

ebobrow · 2021-04-16T17:49:59Z

Playground

I think @flip1995 is right. On the HIR, this lint is too resource intensive and it might not be possible on the AST. I don't know if it's worthwhile to have.

camsteffen · 2021-04-16T18:08:43Z

Hrrrmmm. Yeeahh. mrr

flip1995 · 2021-04-16T18:23:11Z

if an item with the same name exists in scope but not in the module

I'm not following...

Or maybe not... Playground

Anyway, this is way too scuffed to figure out what works and what doesn't when the ::{self} might get removed to make it FP free.

camsteffen · 2021-04-16T18:52:01Z

Yes too scuffed! I can imagine the restriction lint begin useful as in "if removing ::{self} breaks something, you're doing it wrong."

ebobrow · 2021-04-16T19:07:13Z

Good point. I'll change this to a restriction lint and put a warning in the documentation.

camsteffen · 2021-04-16T21:21:38Z

I think we should also

diag.span_note("this will slightly change semantics; any non-module items at the same path will also be imported");

camsteffen · 2021-04-16T23:33:16Z

clippy_lints/src/unnecessary_self_imports.rs

+ /// **Why is this bad?** In most cases, this can be written much more cleanly by omitting `self`.
+ ///
+ /// **Known problems:** Sometimes removing `::{self}` will break code (https:/rust-lang/rustfmt/issues/3568).
+ /// This lint should not be permanently enabled.


It's not necessarily wrong to enable the lint for a project.

camsteffen

Just some nits.

clippy_lints/src/unnecessary_self_imports.rs

tests/ui/unnecessary_self_imports.rs

camsteffen

One more minor suggestion that you can take or leave. Otherwise looks good!

clippy_lints/src/unnecessary_self_imports.rs

ebobrow · 2021-04-21T14:19:19Z

Thanks! I like that.

flip1995

LGTM now. @camsteffen if you're also ok with this PR, please go ahead and merge it.

@ebobrow Thanks for all your work on it, even though you had to delete most of it again. But now we learned what information about imports are available where, which will help us advising on issues about imports in the future,, which is definitely a win.

camsteffen · 2021-04-21T14:47:45Z

@bors r+

bors · 2021-04-21T14:47:46Z

📌 Commit 224881b has been approved by camsteffen

bors · 2021-04-21T14:47:53Z

⌛ Testing commit 224881b with merge 79b9eb5...

bors · 2021-04-21T15:01:39Z

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: camsteffen
Pushing 79b9eb5 to master...

rust-highfive assigned camsteffen Apr 13, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Apr 13, 2021

ebobrow force-pushed the imports-ending-with-self branch from 6b5d46a to 76db21e Compare April 13, 2021 01:50

flip1995 reviewed Apr 13, 2021

View reviewed changes

ebobrow force-pushed the imports-ending-with-self branch 2 times, most recently from cf4223e to cf2b2b9 Compare April 16, 2021 21:14

ebobrow force-pushed the imports-ending-with-self branch from cf2b2b9 to 83fa54e Compare April 16, 2021 21:43

camsteffen reviewed Apr 16, 2021

View reviewed changes

ebobrow force-pushed the imports-ending-with-self branch from 83fa54e to b9cf008 Compare April 17, 2021 02:23

camsteffen suggested changes Apr 18, 2021

View reviewed changes

ebobrow force-pushed the imports-ending-with-self branch from e597832 to 88d60ed Compare April 21, 2021 03:01

ebobrow requested a review from camsteffen April 21, 2021 03:11

camsteffen approved these changes Apr 21, 2021

View reviewed changes

clippy_lints/src/unnecessary_self_imports.rs Outdated Show resolved Hide resolved

add unnecessary_self_imports lint

224881b

ebobrow force-pushed the imports-ending-with-self branch from 88d60ed to 224881b Compare April 21, 2021 14:24

flip1995 approved these changes Apr 21, 2021

View reviewed changes

bors merged commit 79b9eb5 into rust-lang:master Apr 21, 2021

ebobrow deleted the imports-ending-with-self branch April 21, 2021 15:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add unnecessary_self_imports lint #7072

add unnecessary_self_imports lint #7072

ebobrow commented Apr 13, 2021

rust-highfive commented Apr 13, 2021

flip1995 left a comment

flip1995 commented Apr 14, 2021

camsteffen commented Apr 14, 2021 •

edited

Loading

flip1995 commented Apr 14, 2021 •

edited

Loading

ebobrow commented Apr 15, 2021 •

edited

Loading

flip1995 commented Apr 16, 2021

camsteffen commented Apr 16, 2021

ebobrow commented Apr 16, 2021

camsteffen commented Apr 16, 2021

flip1995 commented Apr 16, 2021

camsteffen commented Apr 16, 2021

ebobrow commented Apr 16, 2021

camsteffen commented Apr 16, 2021 •

edited

Loading

camsteffen Apr 16, 2021

camsteffen left a comment

camsteffen left a comment

ebobrow commented Apr 21, 2021

flip1995 left a comment

camsteffen commented Apr 21, 2021

bors commented Apr 21, 2021

bors commented Apr 21, 2021

bors commented Apr 21, 2021

add unnecessary_self_imports lint #7072

add unnecessary_self_imports lint #7072

Conversation

ebobrow commented Apr 13, 2021

rust-highfive commented Apr 13, 2021

flip1995 left a comment

Choose a reason for hiding this comment

flip1995 commented Apr 14, 2021

camsteffen commented Apr 14, 2021 • edited Loading

flip1995 commented Apr 14, 2021 • edited Loading

ebobrow commented Apr 15, 2021 • edited Loading

flip1995 commented Apr 16, 2021

camsteffen commented Apr 16, 2021

ebobrow commented Apr 16, 2021

camsteffen commented Apr 16, 2021

flip1995 commented Apr 16, 2021

camsteffen commented Apr 16, 2021

ebobrow commented Apr 16, 2021

camsteffen commented Apr 16, 2021 • edited Loading

camsteffen Apr 16, 2021

Choose a reason for hiding this comment

camsteffen left a comment

Choose a reason for hiding this comment

camsteffen left a comment

Choose a reason for hiding this comment

ebobrow commented Apr 21, 2021

flip1995 left a comment

Choose a reason for hiding this comment

camsteffen commented Apr 21, 2021

bors commented Apr 21, 2021

bors commented Apr 21, 2021

bors commented Apr 21, 2021

camsteffen commented Apr 14, 2021 •

edited

Loading

flip1995 commented Apr 14, 2021 •

edited

Loading

ebobrow commented Apr 15, 2021 •

edited

Loading

camsteffen commented Apr 16, 2021 •

edited

Loading