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
Perl::Critic::Policy::Modules::ProhibitUseQuotedVersion(3) User Contributed Perl Documentation Perl::Critic::Policy::Modules::ProhibitUseQuotedVersion(3)

Perl::Critic::Policy::Modules::ProhibitUseQuotedVersion - avoid quoted version number string in a "use" statement

This policy is part of the "Perl::Critic::Pulp" add-on. It asks you not to quote a version number string as the sole argument to a "use" or "no" statement.

    use Foo::Bar '1.50';      # bad
    use Foo::Bar 1.50;        # ok

    no Abc::Def '2.000_010';  # bad
    no Abc::Def 2.000_010;    # ok

The unquoted form uses Perl's builtin module version check (Perl 5.004 up) and is always enforced. The quoted form is passed to the module's "import()" and relies on it to do the check. If there's no "import()" then the quoted form is silently ignored.

"Exporter" as used by many modules provides an "import()" which checks a version number arg, so those modules are fine. But the idea of this policy is to do what works always and on that basis is under the "bugs" theme (see "POLICY THEMES" in Perl::Critic).

The builtin module version check is new in Perl 5.004. For earlier versions both forms behave the same, with the string or number going through to the module "import" and so may or may not be checked. But even in code supporting older Perl it's good to write the unquoted number so later Perl will be certain to enforce it.

The policy only applies to a single number string argument, anything else is taken to be a module parameters.

    no Abc::Def '123', 'ABC';   # ok
    use lib '..';               # ok

If you're a bit nervous about unquoting because floating point version numbers are often not exactly representable in binary, well, yes, that's true, but in practice it works, either by converting the same way everywhere in the program or by treated as a string to the "version.pm" module anyway.

If you're confident about the "import()" in modules you use and prefer the string form you can always disable "ProhibitUseQuotedVersion" from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),

    [-Modules::ProhibitUseQuotedVersion]

Perl::Critic::Pulp, Perl::Critic

Perl::Critic::Policy::ValuesAndExpressions::ProhibitVersionStrings

<http://user42.tuxfamily.org/perl-critic-pulp/index.html>

Copyright 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde

Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.

2021-02-27 perl v5.32.1

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

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