Perl::...Carping(3pm)

📦
version 1.156.0 · 12 versions
, in opensuse-leap 16.0

💅 Perl::...Carping(3pm) — aka the Perl::Critic::Policy::ErrorHandling::RequireCarping glow-up

okay so this is a page from the User Contributed Perl Documentation set, and honestly? it's a bop. sit down, bestie, we're talking about not being That Person who dies all over everyone's stack trace. 🎀

✨ NAME ✨

Perl::Critic::Policy::ErrorHandling::RequireCarping — use functions from Carp instead of warn or die. literally that's the whole vibe. no cap. 🫶

🌸 AFFILIATION 🌸

This Policy is part of the core Perl::Critic distribution. so it's, like, official official. 👑

💖 DESCRIPTION 💖

okay so picture this: the die and warn functions both report the file and line number where the exception occurred. sounds great, right? WRONG (well, not wrong, but hear me out 🙈).

the thing is, if someone else is using your subroutine, they usually do not care where your code blew up. like, at all. they want to know where their code invoked the subroutine. main character energy is their file, not yours, periodt. 💅

and that's exactly what the Carp module gives you — alternative methods that report the exception from the caller's file and line number. slay. ✨

by default, this policy will not complain about die or warn if it can determine that the message will always result in a terminal newline. why? because since perl suppresses file names and line numbers in this situation, it's assumed that no stack traces are desired either — and none of the Carp functions are necessary. it's giving "we don't need to fix what isn't broken." 🦋

die "oops" if $explosion;             #not ok
warn "Where? Where?!" if $tiger;      #not ok

open my $mouth, '<', 'food'
    or die 'of starvation';           #not ok

if (! $dentist_appointment) {
    warn "You have bad breath!\n";    #ok
}

die "$clock not set.\n" if $no_time;  #ok

my $message = "$clock not set.\n";
die $message if $no_time;             #not ok, not obvious

look at that last one. #not ok, not obvious 😭 the policy is not psychic, bestie, it can't read your variable's mind. iykyk.

🎀 CONFIGURATION 🎀

by default, this policy allows uses of die and warn ending in an explicit newline. but if you give this policy an allow_messages_ending_with_newlines option in your .perlcriticrc with a false value, then this policy will prohibit such uses. highkey strict. 🔥

[ErrorHandling::RequireCarping]
allow_messages_ending_with_newlines = 0

and if you give this policy an allow_in_main_unless_in_subroutine option in your .perlcriticrc with a true value, then this policy will allow die and warn in name space main:: unless they appear in a subroutine — even if they do not end in an explicit newline. so generous. so kind. 🧚

[ErrorHandling::RequireCarping]
allow_in_main_unless_in_subroutine = 1

💀 BUGS 💀

should allow die when it is obvious that the "message" is a reference. that's the whole note. go off, i guess. 🌈

⭐ SEE ALSO ⭐

  • Carp::Always

that's it, that's the list. iconic minimalism. 💜

🦋 AUTHOR 🦋

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> — legend behavior fr fr. 👑

Copyright (c) 2005-2023 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

no cap, that license line is important — same terms as Perl itself, LICENSE file, all of it. don't skip the boring bits, bestie, they're load-bearing. 🫶

and that's the whole page!! 💖 shoutout to perl v5.42.0, dated 2024-10-23 — she's serving Perl::...Carping(3pm) realness from the User Contributed Perl Documentation, and she ate. 🔥✨🎀

📦 where this page comes from