In Perl, what is the difference between use and require for loading a module?

Question

What is the difference between doing use My::Module and require My::Module?

Solution 1

The use function:

use ModuleName;

is equivalent to the following code using the require function:

BEGIN {
    require ModuleName;
    ModuleName->import;
}

The BEGIN block causes this code to run as soon as the parser sees it. The require loads the module or dies trying. And then the import function of the module is called. The import function may do all sorts of things, but it is common for it to load functions into the namespace that used it (often with the Exporter module).

It is important to note that import will not be called in this case:

use ModuleName ();

In that case, it is equivalent to

BEGIN {
    require ModuleName;
}

Solution 2

From perldoc -q "difference between require and use":

use Module is like require Module, except that use

4.1: loads the module at compile time, not run-time.

4.2: imports symbols and semantics from that package to the current one.

Solution 3

Perl comes with great documentation. Everyone would benefit from reading the entire documentation at least once every few months.

C:\> perldoc -f require

Otherwise require demands that a library file be included if it hasn't already been included. The file is included via the do-FILE mechanism, which is essentially just a variety of eval with the caveat that lexical variables in the invoking script will be invisible to the included code. Has semantics similar to the following subroutine:

... etc. Similarly,

C:\> perldoc -f use

Imports some semantics into the current package from the named module, generally by aliasing certain subroutine or variable names into your package. It is exactly equivalent to

BEGIN { require Module; Module->import( LIST ); }

except that Module must be a bareword.

... etc

There is also the perlfaq entry although I think it is less informative than the above.

Solution 4

use runs at compile time, and require runs at run time.

View more solutions

Comments

[Chas. Owens]

Don't forget the calling of import.

[Chas. Owens]

In addition to the wonderful perldoc command, you can access all of the same documentation through perldoc.perl.org

[ysth]

Ah. Your kbd tags make it harder to tell what's a link (as well as rendering not very prettily).

[Hawk]

This is the answer they are looking for on Perl tests and job interviews. You need to memorize this!