Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Should I use common::sense or just stick with `use strict` and `use warnings`?

Tags:

perl

I recently installed a module from CPAN and noticed one of its dependencies was common::sense, a module that offers to enable all the warnings you want, and none that you don't. From the module's synopsis:

use common::sense;

# supposed to be the same, with much lower memory usage, as:
#
# use strict qw(vars subs);
# use feature qw(say state switch);
# no warnings;
# use warnings qw(FATAL closed threads internal debugging pack substr malloc
#                 unopened portable prototype inplace io pipe unpack regexp
#                 deprecated exiting glob digit printf utf8 layer
#                 reserved parenthesis taint closure semicolon);
# no warnings qw(exec newline);

Save for undef warnings sometimes being a hassle, I've usually found the standard warnings to be good. Is it worth switching to common::sense instead of my normal use strict; use warnings;?

like image 295
Drew Stephens Avatar asked Oct 26 '09 16:10

Drew Stephens


People also ask

What are some differences between strict and warnings?

use strict pragma also works in the same way as use warnings but the only difference is that the strict pragma would abort the execution of program if an error is found, while the warning pragma would only provide the warning, it won't abort the execution.

Why do you use the modules strict and warnings in your code?

A common case is forgetting to rename an instance of a variable when cleaning up or refactoring code. Using use strict; use warnings; catches many errors sooner than they would be caught otherwise, which makes it easier to find the root causes of the errors.

Why we use strict and warnings in Perl?

Strict and Warning are probably the two most commonly used Perl pragmas, and are frequently used to catch “unsafe code.” When Perl is set up to use these pragmas, the Perl compiler will check for, issue warnings against, and disallow certain programming constructs and techniques.

What is use warnings?

What is the use of “use warnings”? It helps you find typing mistakes, it warns you whenever it sees something wrong with your program. It would help you find mistakes in your program faster. Note: The most important point to note here is that “use strict” would abort the execution of program if it finds errors.


2 Answers

While I like the idea of reducing boiler-plate code, I am deeply suspicious of tools like Modern::Perl and common::sense.

The problem I have with modules like this is that they bundle up a group of behaviors and hide behid glib names with changeable meanings.

For example, Modern::Perl today consists of enabling some perl 5.10 features and using strict and warnings. But what happens when Perl 5.12 or 5.14 or 5.24 come out with great new goodies, and the community discovers that we need to use the frobnitz pragma everywhere? Will Modern::Perl provide a consistent set of behaviors or will it remain "Modern". If MP keeps with the times, it will break existing systems that don't keep lock-step with its compiler requirements. It adds extra compatibility testing to upgrade. At least that's my reaction to MP. I'll be the first to admit that chromatic is about 10 times smarter than me and a better programmer as well--but I still disagree with his judgment on this issue.

common::sense has a name problem, too. Whose idea of common sense is involved? Will it change over time?

My preference would be for a module that makes it easy for me to create my own set of standard modules, and even create groups of related modules/pragmas for specific tasks (like date time manipulation, database interaction, html parsing, etc).

I like the idea of Toolkit, but it sucks for several reasons: it uses source filters, and the macro system is overly complex and fragile. I have the utmost respect for Damian Conway, and he produces brilliant code, but sometimes he goes a bit too far (at least for production use, experimentation is good).

I haven't lost enough time typing use strict; use warnings; to feel the need to create my own standard import module. If I felt a strong need for automatically loading a set of modules/pragmas, something similar to Toolkit that allows one to create standard feature groups would be ideal:

use My::Tools qw( standard datetime SQLite );

or

use My::Tools;
use My::Tools::DateTime;
use My::Tools::SQLite;

Toolkit comes very close to my ideal. Its fatal defects are a bummer.

As for whether the choice of pragmas makes sense, that's a matter of taste. I'd rather use the occasional no strict 'foo' or no warnings 'bar' in a block where I need the ability to do something that requires it, than disable the checks over my entire file. Plus, IMO, memory consumption is a red herring. YMMV.

update

It seems that there are many (how many?) different modules of this type floating around CPAN.

  • There is latest, which is no longer the latest. Demonstrates part of the naming problem.
  • Also, uni::perl which adds enabling unicode part of the mix.
  • ToolSet offers a subset of Toolkit's abilities, but without source filters.
  • I'll include Moose here, since it automatically adds strict and warnings to the calling package.
  • And finally Acme::Very::Modern::Perl

The proliferation of these modules and the potential for overlapping requirements, adds another issue.

What happens if you write code like:

use Moose;
use common::sense;

What pragmas are enabled with what options?

like image 182
daotoad Avatar answered Oct 04 '22 23:10

daotoad


I would say stick with warnings and strict for two main reasons.

  1. If other people are going to use or work with your code, they are (almost certainly) used to warnings and strict and their rules. Those represent a community norm that you and other people you work with can count on.
  2. Even if this or that specific piece of code is just for you, you probably don't want to worry about remembering "Is this the project where I adhere to warnings and strict or the one where I hew to common::sense?" Moving back and forth between the two modes will just confuse you.
like image 23
Telemachus Avatar answered Oct 04 '22 23:10

Telemachus