Add `undocumented_may_panic_call` lint #15969

hcbarker · 2025-10-28T08:01:04Z

Checks for calls to functions marked with #[clippy::may_panic] or configured in may-panic-functions that lack a // Panic: comment documenting why the panic is acceptable.

fixes #15861

changelog: new_lint: [undocumented_may_panic_call]

rustbot · 2025-10-28T08:01:09Z

r? @Jarcho

rustbot has assigned @Jarcho.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

hcbarker · 2025-10-28T08:01:23Z

r? blyxyas

rustbot · 2025-10-28T08:01:27Z

blyxyas is not on the review rotation at the moment.
They may take a while to respond.

blyxyas · 2025-10-31T01:41:21Z

clippy_lints/src/undocumented_may_panic_call.rs

+    /// #[clippy::may_panic]
+    /// fn my_panicable_func(n: u32) {
+    ///     if n % 2 == 0 {
+    ///         panic!("even number not allowed")


Little typo in the documentation =^w^=

Suggested change

/// panic!("even number not allowed")

/// panic!("even numbers are not allowed")

blyxyas · 2025-10-31T01:42:10Z

clippy_lints/src/undocumented_may_panic_call.rs

+    /// #[clippy::may_panic]
+    /// fn my_panicable_func(n: u32) {
+    ///     if n % 2 == 0 {
+    ///         panic!("even number not allowed")


Suggested change

/// panic!("even number not allowed")

/// panic!("even numbers are not allowed")

blyxyas · 2025-11-11T17:20:48Z

clippy_lints/src/undocumented_may_panic_call.rs

+        if get_unique_attr(cx.sess(), cx.tcx.get_all_attrs(def_id), sym::may_panic).is_some() {
+            return true;
+        }
+
+        self.may_panic_def_ids.contains(&def_id)


Suggested change

if get_unique_attr(cx.sess(), cx.tcx.get_all_attrs(def_id), sym::may_panic).is_some() {

return true;

}

self.may_panic_def_ids.contains(&def_id)

get_unique_attr(cx.sess(), cx.tcx.get_all_attrs(def_id), sym::may_panic).is_some() || self.may_panic_def_ids.contains(&def_id)

blyxyas · 2025-11-11T20:47:15Z

clippy_lints/src/undocumented_may_panic_call.rs

+        && call_line.line > 0
+        && let Some(src) = call_line.sf.src.as_deref()


We need to handle macros (the most difficult portion in the art of lint-making), I've been thinking about this and I think that the best option is to permit this two scenarios:

The macro handles the comment, this is what's going on currently.

The callsite of the macro handles the comment.

So, for macro calls that are not justified in-macro, the user will need to write a PANIC comment.

So, we'll need to recurse through the HIR parents, check if we're in a macro, and if we're not, check for the comment.

The functions to check if we're in a macro are is_from_proc_macro, in_external_macro and from_expansion

blyxyas · 2025-11-11T23:07:59Z

tests/ui/undocumented_may_panic_call.rs

+
+    // Panic: This is safe, just trust me.
+    let _ = t.trait_panic_method();
+}


Some more testing would be much appreciated, note that tests also test that every other lint is working correctly, so doing some extremely weird syntax (and, if it's too weird, explaining where it should lint) is very beneficial for our test suite.

Many of the bugs we receive are from extremely niche use cases, so testing for those before a lint goes into a release is very beneficial.

Suggested change

}

#[allow(clippy::needless_bool, clippy::unnecessary_operation)]

fn weird_exprs(t: &dyn MyTrait) {

// The Panic comment should be in the second If statement

if if if true { true } else { false } {

t.trait_panic_method() == 0

//~^ undocumented_may_panic_call

} else {

false

} {

true

} else {

false

};

if if if true { true } else { false } {

// PANIC: This is safe!

t.trait_panic_method() == 0

} else {

false

} {

true

} else {

false

};

#[clippy::may_panic]

fn panic<T>(val: T) -> T {val}

macro_rules! mac {

($t:tt) => ($t)

}

// Panic comment should go on the line before the panic() function

async {{};({(u8::max)(

// PANIC: Safe!

panic(1)+mac!(2),mac!(2))});

};

}

macro_rules! may_panic {

() => {dangerous(1)}

}

fn on_macro() {

// PANIC: Hi

may_panic!();

// REVIEWER: ^^^^^^^ This currently doesn't work! See other comments

}

blyxyas

Great first patch! Sorry for the delayed response, I took a vacation right after starting to review this (in fact, if you check the comment date for those first review comments, you'll see that I made them 2 weeks ago)

View changes since this review

hcbarker · 2025-11-20T16:58:11Z

@blyxyas Thanks for the review! It was my turn to be on vacation when I got it haha, but I'll be working on an update here over the next few days :)

Checks for calls to functions marked with `#[clippy::may_panic]` or configured in `may-panic-functions` that lack a `// Panic:` comment documenting why the panic is acceptable. changelog: new_lint: [`undocumented_may_panic_call`]

- Fixing typos - Code cleanup and more tests - Adding handling and tests for all kinds of macros

rustbot · 2025-11-25T08:46:26Z

This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

hcbarker · 2025-11-25T08:48:05Z

@blyxyas I had to rebase and push --force-with-lease to fix some conflicts, and I responded to your comments and added handling and tests for macros!

rustbot assigned Jarcho Oct 28, 2025

rustbot added needs-fcp S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Oct 28, 2025

This comment has been minimized.

Sign in to view

rustbot assigned blyxyas and unassigned Jarcho Oct 28, 2025

hcbarker force-pushed the may-panic-attribute branch from bab87c9 to 4bb7fdc Compare October 28, 2025 08:02

blyxyas added the G-Rust-for-Linux Issues related to Rust-for-Linux wants and bugfixes label Oct 28, 2025

This comment has been minimized.

Sign in to view

blyxyas reviewed Nov 11, 2025

View reviewed changes

blyxyas requested changes Nov 11, 2025

View reviewed changes

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 Nov 11, 2025

hcbarker added 2 commits November 24, 2025 23:11

Add undocumented_may_panic_call lint

4806c5e

Checks for calls to functions marked with `#[clippy::may_panic]` or configured in `may-panic-functions` that lack a `// Panic:` comment documenting why the panic is acceptable. changelog: new_lint: [`undocumented_may_panic_call`]

Responding to PR comments

ac41ba9

- Fixing typos - Code cleanup and more tests - Adding handling and tests for all kinds of macros

hcbarker force-pushed the may-panic-attribute branch from 4bb7fdc to ac41ba9 Compare November 25, 2025 08:46

	/// panic!("even number not allowed")
	/// panic!("even numbers are not allowed")

		&& call_line.line > 0
		&& let Some(src) = call_line.sf.src.as_deref()

-}
+#[allow(clippy::needless_bool, clippy::unnecessary_operation)]
+fn weird_exprs(t: &dyn MyTrait) {
+    // The Panic comment should be in the second If statement
+    if if if true { true } else { false } {
+        t.trait_panic_method() == 0
+    //~^ undocumented_may_panic_call
+    } else {
+        false
+    } {
+        true
+    } else {
+        false
+    };
+    if if if true { true } else { false } {
+        // PANIC: This is safe!
+        t.trait_panic_method() == 0
+    } else {
+        false
+    } {
+        true
+    } else {
+        false
+    };
+    #[clippy::may_panic]
+    fn panic<T>(val: T) -> T {val}
+    macro_rules! mac {
+        ($t:tt) => ($t)
+    }
+    // Panic comment should go on the line before the panic() function
+    async {{};({(u8::max)(
+        // PANIC: Safe!
+        panic(1)+mac!(2),mac!(2))});
+    };
+}
+macro_rules! may_panic {
+    () => {dangerous(1)}
+}
+fn on_macro() {
+    // PANIC: Hi
+    may_panic!();
+    // REVIEWER: ^^^^^^^ This currently doesn't work! See other comments
+}

Add undocumented_may_panic_call lint #15969

Are you sure you want to change the base?

Add undocumented_may_panic_call lint #15969

Uh oh!

Conversation

hcbarker commented Oct 28, 2025 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Oct 28, 2025

Uh oh!

This comment has been minimized.

hcbarker commented Oct 28, 2025

Uh oh!

rustbot commented Oct 28, 2025

Uh oh!

This comment has been minimized.

blyxyas Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

blyxyas Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

blyxyas Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

blyxyas Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

blyxyas Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

blyxyas left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hcbarker commented Nov 20, 2025

Uh oh!

rustbot commented Nov 25, 2025

Uh oh!

hcbarker commented Nov 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add `undocumented_may_panic_call` lint #15969

Add `undocumented_may_panic_call` lint #15969

hcbarker commented Oct 28, 2025 •

edited by rustbot

Loading

blyxyas left a comment •

edited by rustbot

Loading