Perl::...kedOpen(3pm)

✨ NAME ✨

okay so bestie, this is the Perl::...kedOpen(3pm) page from User Contributed Perl Documentation, and the policy is Perl::Critic::Policy::InputOutput::RequireCheckedOpen — write my $error = open $fh, $mode, $filename; instead of open $fh, $mode, $filename;. That’s the assignment, no cap 🎀

🌈 AFFILIATION 🌈

This Policy is part of the core Perl::Critic distribution — core distribution energy, periodt 🦋

🔍 DESCRIPTION 🔍

The perl builtin I/O function open returns a false value on failure. That value should always be checked to ensure that the open was successful. Like, always always 👑

my $error = open( $filehandle, $mode, $filename );                  # ok
open( $filehandle, $mode, $filename ) or die "unable to open: $!";  # ok
open( $filehandle, $mode, $filename );                              # not ok

use autodie;
open $filehandle, $mode, $filename;                                 # ok

You can use autodie, Fatal, or Fatal::Exception to get around this. Currently, autodie is not properly treated as a pragma; its lexical effects aren't taken into account. That’s a real caveat, so don’t let the autodie vibe fool you 🙈

🛠️ CONFIGURATION 🛠️

If you create a module that exports autodie you can tell this policy about it with the autodie_modules setting:

[InputOutput::RequireCheckedSyscalls]
autodie_modules = My::Thing

💖 AUTHOR 💖

Andrew Moore <amoore@mooresystems.com> — icon behavior 🫶

🌸 ACKNOWLEDGMENTS 🌸

This policy module is based heavily on policies written by Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>. Shoutout to the source material, fr fr 💜

👑 COPYRIGHT 👑

Copyright (c) 2007-2011 Andrew Moore. 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.

byeee bestie — this page is from User Contributed Perl Documentation with perl v5.42.0, dated 2024-10-23 💅✨