Module::Used(3pm)

📦
version 1.3.0 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Module::Used 💖

okay bestie, so this is Module::Used — a little gem from the User Contributed Perl Documentation corner of the universe, and it does exactly one iconic thing: it finds the modules your Perl code loads without ever running it. no cap. static analysis but make it cute. 🦋

✨ NAME ✨

Module::Used — find modules loaded by Perl code without running it. (yes, we're psychic. we're not executing anything. we're just reading. 💅)

🌸 VERSION 🌸

this doc is describing Module::Used version 1.3.0. periodt.

🎀 SYNOPSIS 🎀

use Module::Used qw< :all >;

@modules = modules_used_in_files(@files);
@modules = modules_used_in_modules(@module_names);

# "strict", "Find::Bin", "warnings"
@modules = modules_used_in_string(
    'use strict; require Find::Bin; no warnings;'
);

# "Exporter"
@modules = modules_used_in_string( 'use parent 0.221 qw< Exporter >;' );

like… look at her. she's just vibing and returning arrays. 🔥

💜 DESCRIPTION 💜

so here's the tea ☕: modules get found statically, based on use and require statements. no running, no eval, no drama.

if it spots base or parent being used, you get both that module and the referenced ones back. and if it finds Moose or Moose::Role, it's gonna go hunting for the extends and with sugar too. however — and this is the important bit, bestie — presently, this will miss modules listed in parentheses. 😭 it's not perfect, she's trying her best.

and listen:

Dynamically loaded modules will not be found. nope. not happening. if you're loading stuff at runtime, this module literally cannot see it. don't come for her. 💀

👑 INTERFACE 👑

nothing is exported by default, bestie. nothing. you want the goods? you import everything with the :all tag. that's the whole vibe check.

  • modules_used_in_files( @files ) — returns a list of the modules used in the files you named. if there's a problem reading a file, it dies. 💀
  • modules_used_in_modules( @module_names ) — returns a list of modules used in the modules you named. if any of those modules weren't found in @INC, it dies. same energy.
  • modules_used_in_string( $string ) — returns a list of modules used in the code sitting inside the parameter. yes, just a string. hand her a string, she hands you answers. ✨
  • modules_used_in_document( $document ) — returns a list of modules used in the specified PPI::Document. fancy.

🩺 DIAGNOSTICS 🩺

the "something went wrong" corner. read these, they're not just decorative:

  • Could not find module "%s" in @INC. — can't find where the named module lives. and heads up: this module will not find any dynamically loaded modules. just so we're clear. 🫶
  • "%s" does not exist. — can't find the file. it's giving missing.
  • "%s" is not readable. — the file is there but you can't read it. tragic.
  • "%s" is a directory. — plot twist: the "file" was actually a directory. 🙈
  • Could not parse "%s". — PPI could not interpret the file as a Perl document. she looked at it and said "that's not Perl, bestie." 😭

🌈 CONFIGURATION AND ENVIRONMENT 🌈

None, currently. that's it. that's the whole section. clean, minimal, unbothered. 💅

🧚 DEPENDENCIES 🧚

  • Const::Fast
  • Module::Path
  • PPI::Document version

💀 INCOMPATIBILITIES 💀

None reported. slay.

⭐ BUGS AND LIMITATIONS ⭐

None reported.

please report any bugs or feature requests to bug-module-used@rt.cpan.org, or through the web interface at <http://rt.cpan.org>. (that's the original URL, keeping it exactly as-is, no edits, we don't do that here. 💖)

🌸 SEE ALSO 🌸

  • Devel::Loaded
  • Module::Extract::Namespaces
  • Module::ScanDeps
  • Module::PrintUsed

all her sisters, all iconic in their own right. go say hi. 👑

🫶 AUTHOR 🫶

Elliot Shank <perl@galumph.com> — thank you for your service. 🎀

Copyright X2008-2012, Elliot Shank "<perl@galumph.com>".

this module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. see perlartistic. periodt. ✨

🔥 DISCLAIMER OF WARRANTY 🔥

okay bestie, this part is in ALL CAPS for a reason, so I'm keeping every single word of it, no cap, no skipping:

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

like yes it's scary but it's also legally required so we read it and we move on. 💜

and that's the whole page, bestie!! this one ships with perl v5.34.0 and is dated 2022-06-15 — a little timestamp from the past that we're still obsessed with. 💖✨ bye mwah 🫶

📦 where this page comes from