WIP New lint: borrowed_option #11463

tom-anders · 2023-09-04T14:28:35Z

This is inspired by this excellent video: https://www.youtube.com/watch?v=6c7pZYP_iIE

Some things I'd appreciate feedback on:

I've added this to the borrowed_box.rs check, since these two lints would share a lot of common code. We should probably rename that file, but to what? borrowed_box_or_option.rs? (same goes for the tests) (Edit: looks like the corresponding issue has been closed for now, so let's keep it like it is for now?
There's a special case for ignoring &Box<Any> (see borrowed_box lint and Any #1884), I'm not sure if this is needed for &Option<Any> as well.
The wording of What it does and Why is this bad could probably use some improvements, suggestions are welcome!

changelog: new lint: [borrowed_option]
#11463

rustbot · 2023-09-04T14:28:40Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @blyxyas (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

Centri3 · 2023-09-04T19:37:12Z

Regarding &Option<dyn Any>, we don't need the same check since T must be Sized. It's impossible to use &Option<dyn Any>, only &Option<Box<dyn Any>> (or anything else that introduces indirection). This will then suggest Option<&Box<dyn Any>> which is already checked for in the borrowed_box lint.

The lint documentation should provide examples of why it does this (this i.e. exposes implementation details). The example given is fine, but some who aren't too familiar with the borrow checker may question why this exposes implementation details.

blyxyas · 2023-09-07T13:26:29Z

I've added this to the borrowed_box.rs check, since these two lints would share a lot of common code. We should probably rename that file, but to what? borrowed_box_or_option.rs? (same goes for the tests)

We should probably make a new lint type for borrows and references. cc #11464
I currently have a mildly long review queue, so it will take some days. Until that lint type is created, I'll review this independently ^w^

clippy_lints/src/types/mod.rs

bors · 2023-10-23T15:01:47Z

☔ The latest upstream changes (presumably #11460) made this pull request unmergeable. Please resolve the merge conflicts.

…e::get_placeholders_with_values` <rust-lang/rust-clippy#11463>

* Take `&str` instead of `&String` in `ParamValue::get_placeholders_with_values` <https://rust-lang.github.io/rust-clippy/master/index.html#/ptr_arg> * Take `Option<&DataType>` instead of `&Option<DataType>` in `ParamValue::get_placeholders_with_values` <rust-lang/rust-clippy#11463> * Take `&[_]` instead of `&Vec<_>` in `ParamValues::verify` <https://rust-lang.github.io/rust-clippy/master/index.html#/ptr_arg> --------- Co-authored-by: Andrew Lamb <[email protected]>

xFrednet · 2024-03-29T12:26:15Z

Hey @tom-anders, this is a ping from triage, since there hasn't been any activity in some time. Could you rebase the branch on master?

If you have any questions, you're always welcome to ask them in this PR or on Zulip.

@rustbot author

tom-anders · 2024-03-29T15:02:38Z

@xFrednet Thanks for the reminder! I rebased and also incorporated @blyxyas's suggestions

tom-anders · 2024-03-29T15:26:25Z

(fixed formatting)

xFrednet · 2024-03-29T19:43:01Z

Perfect, thank you for the swift update :D

@rustbot ready

xFrednet · 2024-06-20T20:13:27Z

Hey, this is a ping from triage. @blyxyas can you give this PR a review? It's totally fine if you don't have the time right now, you can reassign the PR to a random team member using r? clippy.

@rustbot ready

xFrednet · 2024-07-23T07:57:16Z

Hey, this is triage: It looks like @blyxyas is currently busy, let's pick a new reviewer.

r? clippy

Alexendoo · 2024-07-24T16:58:44Z

tests/ui/borrow_box.rs

@@ -9,7 +9,7 @@

 use std::fmt::Display;

-pub fn test1(foo: &mut Box<bool>) {
+pub fn test1(foo: &mut Box<bool>, bar: &mut Option<bool>) {


The tests for borrowed_option should go in a new test file

Alexendoo · 2024-07-24T17:13:55Z

clippy_lints/src/types/mod.rs

+    /// An `&Option<T>` parameter prevents calling the function if the caller holds a different type, e.g. `Result<T, E>`.
+    /// Using `Option<&T>` generalizes the function, e.g. allowing to pass `res.ok().as_ref()`
+    /// Returning `&Option<T>` needlessly exposes implementation details and has no advantage over `Option<&T>`.


You could mention that &Option<T> requires dereferencing to determine the variant whereas Option<&T> does not

Alexendoo · 2024-07-24T18:03:39Z

clippy_lints/src/types/mod.rs

+    /// ```rust,compile_fail
+    /// fn foo(bar: &Option<i32>) -> &Option<i32> { bar }
+    /// fn call_foo(bar: &Result<i32, ()>) {
+    ///     foo(bar.ok()); // does not work
+    /// }
+    /// ```
+    ///
+    /// Use instead:
+    ///
+    /// ```rust
+    /// fn foo(bar: Option<&i32>) -> Option<&i32> { bar }
+    /// fn call_foo(bar: &Result<i32, ()>) {
+    ///     foo(bar.ok().as_ref()); // works!
+    /// }
+    /// ```


Let's go with a String or anything !Copy rather than i32 to demonstrate the issue

bors · 2024-09-25T03:04:30Z

☔ The latest upstream changes (presumably #13442) made this pull request unmergeable. Please resolve the merge conflicts.

rustbot assigned blyxyas Sep 4, 2023

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Sep 4, 2023

blyxyas marked this pull request as draft September 4, 2023 15:36

blyxyas reviewed Sep 8, 2023

View reviewed changes

clippy_lints/src/types/mod.rs Outdated Show resolved Hide resolved

clippy_lints/src/types/mod.rs Outdated Show resolved Hide resolved

clippy_lints/src/types/mod.rs Outdated Show resolved Hide resolved

kawadakk mentioned this pull request Dec 21, 2023

Change the parameter types of ParamValues's methods to avoid expensive conversion apache/datafusion#8612

Closed

kawadakk added a commit to kawadakk/arrow-datafusion that referenced this pull request Dec 21, 2023

Take Option<&DataType> instead of &Option<DataType> in `ParamValu…

5acf9a0

…e::get_placeholders_with_values` <rust-lang/rust-clippy#11463>

rustbot added S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Mar 29, 2024

tom-anders force-pushed the borrowed_option branch from 7f5486e to 09929e1 Compare March 29, 2024 15:01

New lint: borrowed_option

6919b2c

tom-anders force-pushed the borrowed_option branch from 09929e1 to 6919b2c Compare March 29, 2024 15:26

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties and removed S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) labels Mar 29, 2024

rustbot assigned Alexendoo and unassigned blyxyas Jul 23, 2024

Alexendoo reviewed Jul 24, 2024

View reviewed changes

Alexendoo added S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Sep 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP New lint: borrowed_option #11463

WIP New lint: borrowed_option #11463

tom-anders commented Sep 4, 2023 •

edited by xFrednet

Loading

rustbot commented Sep 4, 2023

Centri3 commented Sep 4, 2023 •

edited

Loading

blyxyas commented Sep 7, 2023

bors commented Oct 23, 2023

xFrednet commented Mar 29, 2024

tom-anders commented Mar 29, 2024

tom-anders commented Mar 29, 2024

xFrednet commented Mar 29, 2024

xFrednet commented Jun 20, 2024

xFrednet commented Jul 23, 2024

Alexendoo Jul 24, 2024

Alexendoo Jul 24, 2024

Alexendoo Jul 24, 2024

bors commented Sep 25, 2024

WIP New lint: borrowed_option #11463

Are you sure you want to change the base?

WIP New lint: borrowed_option #11463

Conversation

tom-anders commented Sep 4, 2023 • edited by xFrednet Loading

rustbot commented Sep 4, 2023

Centri3 commented Sep 4, 2023 • edited Loading

blyxyas commented Sep 7, 2023

bors commented Oct 23, 2023

xFrednet commented Mar 29, 2024

tom-anders commented Mar 29, 2024

tom-anders commented Mar 29, 2024

xFrednet commented Mar 29, 2024

xFrednet commented Jun 20, 2024

xFrednet commented Jul 23, 2024

Alexendoo Jul 24, 2024

Choose a reason for hiding this comment

Alexendoo Jul 24, 2024

Choose a reason for hiding this comment

Alexendoo Jul 24, 2024

Choose a reason for hiding this comment

bors commented Sep 25, 2024

tom-anders commented Sep 4, 2023 •

edited by xFrednet

Loading

Centri3 commented Sep 4, 2023 •

edited

Loading