1Perl::Critic::Policy::IUnspePuretrOCluo:tn:ptCurrtii:bt:uiRtcee:qd:uPiPoreleriBlcryiD:eo:fcIOunpmpeeunnt(tO3au)ttipount::RequireBriefOpen(3)
2
6 Perl::Critic::Policy::InputOutput::RequireBriefOpen - Close filehandles
7 as soon as possible after opening them.
8
10 This Policy is part of the core Perl::Critic distribution.
11
13 One way that production systems fail unexpectedly is by running out of
14 filehandles. Filehandles are a finite resource on every operating
15 system that I'm aware of, and running out of them is virtually
16 impossible to recover from. The solution is to not run out in the
17 first place. What causes programs to run out of filehandles? Usually,
18 it's leaks: you open a filehandle and forget to close it, or just wait
19 a really long time before closing it.
20 This problem is rarely exposed by test systems, because the tests
22 rarely run long enough or have enough load to hit the filehandle limit.
23 So, the best way to avoid the problem is 1) always close all
24 filehandles that you open and 2) close them as soon as is practical.
25 This policy takes note of calls to "open()" where there is no matching
27 "close()" call within "N" lines of code. If you really need to do a
28 lot of processing on an open filehandle, then you can move that
29 processing to another method like this:
30 sub process_data_file {
32 my ($self, $filename) = @_;
33 open my $fh, '<', $filename
34 or croak 'Failed to read datafile ' . $filename . '; ' . $OS_ERROR;
35 $self->_parse_input_data($fh);
36 close $fh;
37 return;
38 }
39 sub _parse_input_data {
40 my ($self, $fh) = @_;
41 while (my $line = <$fh>) {
42 ...
43 }
44 return;
45 }
46 As a special case, this policy also allows code to return the
48 filehandle after the "open" instead of closing it. Just like the
49 close, however, that "return" has to be within the right number of
50 lines. From there, you're on your own to figure out whether the code
51 is promptly closing the filehandle.
52 The STDIN, STDOUT, and STDERR handles are exempt from this policy.
54
56 This policy allows "close()" invocations to be up to "N" lines after
57 their corresponding "open()" calls, where "N" defaults to 9. You can
58 override this to set it to a different number with the "lines" setting.
59 To do this, put entries in a .perlcriticrc file like this:
60 [InputOutput::RequireBriefOpen]
62 lines = 5
63
65 "IO::File->new"
66 This policy only looks for explicit "open" calls. It does not detect
67 calls to "CORE::open" or "IO::File->new" or the like.
68 Is it the right lexical?
70 We don't currently check for redeclared filehandles. So the following
71 code is false negative, for example, because the outer scoped
72 filehandle is not closed:
73 open my $fh, '<', $file1 or croak;
75 if (open my $fh, '<', $file2) {
76 print <$fh>;
77 close $fh;
78 }
79 This is a contrived example, but it isn't uncommon for people to use
81 $fh for the name of the filehandle every time. Perhaps it's time to
82 think of better variable names...
83
85 Initial development of this policy was supported by a grant from the
86 Perl Foundation.
87
89 Chris Dolan <cdolan@cpan.org>
90
92 Copyright (c) 2007-2011 Chris Dolan. Many rights reserved.
93 This program is free software; you can redistribute it and/or modify it
95 under the same terms as Perl itself. The full text of this license can
96 be found in the LICENSE file included with this module
97perl v5.30.0 Perl::Crit2i0c1:9:-P0o7l-i2c6y::InputOutput::RequireBriefOpen(3)