GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PERL::CRITIC::POLICY::SUBROUTINES::PROHIBITEXPLICITRETURNUNDEF (3)

.ds Aq ’

NAME

Perl::Critic::Policy::Subroutines::ProhibitExplicitReturnUndef - Return failure with bare "return" instead of "return undef".

CONTENTS

AFFILIATION

This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

Returning undef upon failure from a subroutine is pretty common. But if the subroutine is called in list context, an explicit return undef; statement will return a one-element list containing (undef). Now if that list is subsequently put in a boolean context to test for failure, then it evaluates to true. But you probably wanted it to be false.



  sub read_file {
      my $file = shift;
      -f $file || return undef;  #file doesnt exist!

      #Continue reading file...
  }

  #and later...

  if ( my @data = read_file($filename) ){

      # if $filename doesnt exist,
      # @data will be (undef),
      # but Ill still be in here!

      process(@data);
  }
  else{

      # This is my error handling code.
      # I probably want to be in here
      # if $filname doesnt exist.

      die "$filename not found";
  }



The solution is to just use a bare return statement whenever you want to return failure. In list context, Perl will then give you an empty list (which is false), and undef in scalar context (which is also false).



  sub read_file {
      my $file = shift;
      -f $file || return;  #DWIM!

      #Continue reading file...
  }



CONFIGURATION

This Policy is not configurable except for the standard options.

NOTES

You can fool this policy pretty easily by hiding undef in a boolean expression. But don’t bother trying. In fact, using return values to indicate failure is pretty poor technique anyway. Consider using die or croak with eval, or the Error module for a much more robust exception-handling model. Conway has a real nice discussion on error handling in chapter 13 of PBP.

SEE ALSO

There’s a discussion of the appropriateness of this policy at <http://perlmonks.org/index.pl?node_id=741847>.

AUTHOR

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

Copyright (c) 2005-2011 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PERL::CRITIC::POLICY::SUBROUTINES::PROHIBITEXPLICITRETURNUNDEF (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.