How do I find out the filename of a Perl package?

Question

I would like to translate a Perl package name to the full path of the file.

say package_name_to_path('Foo::Bar::Baz');
/tmp/Foo/Bar/Baz.pm

I know there is a CPAN module to do this? I just can't find it again?

Answer 1

Doh - I just remembered.

use Module::Util qw( :all );

$valid = is_valid_module_name $potential_module;

$relative_path = module_path $module_name;

$file_system_path = module_fs_path $module_name;

Answer 2

Well, perldoc can tell you the filename:

[fayland@alpha ~]$ perldoc -l Catalyst
/home/fayland/perl5/lib/perl5/Catalyst.pm

or look in %INC after you've loaded the module.

Thanks.

Answer 3

If you've loaded the module, just look in %INC but you have to do it by filename.

say $INC{"Foo/Bar/Baz.pm"};

If you haven't, you can use Module::Util or the module_info program which comes with Module::Info.

$ module_info Module::Build

Name:        Module::Build
Version:     0.30
Directory:   /usr/local/lib/site_perl
File:        /usr/local/lib/site_perl/Module/Build.pm
Core module: no

Or you can go through @INC manually.

my $module = "Foo::Bar";

# Convert from Foo::Bar to Foo/Bar.pm
my $file   = $module;
$file =~ s{::}{/};
$file .= ".pm";

my $path;
for my $dir (@INC) {
    $path = "$dir/$file";
    last if -r $path;
    $path = undef;
}

say defined $path ? "$module is found at $path" : "$module not found";

(A fully cross platform solution would use File::Spec instead of joining with slashes.)

If you just need to find a module quick, perldoc -l works well as Fayland mentioned, but it will fail to find a module that has no POD.