Parse::PMFile(3)

✨ NAME ✨

Parse::PMFile — parses a .pm file as PAUSE does 💅

Hiii bestie, welcome to the Parse::PMFile(3) page — yes, the manual name is right there, no cap. It's a User Contributed Perl Documentation situation, and we're gonna make it make sense. 🫶

---

🌸 SYNOPSIS 🌸

use Parse::PMFile;

my $parser = Parse::PMFile->new($metadata, {VERBOSE => 1});
my $packages_info = $parser->parse($pmfile);

# if you need info about invalid versions
my ($packages_info, $errors) = $parser->parse($pmfile);

# to check permissions
my $parser = Parse::PMFile->new($metadata, {
    USERID => 'ISHIGAKI',
    PERMISSIONS => PAUSE::Permissions->new,
});

---

🦋 DESCRIPTION 🦋

Okay so here's the tea: most of this module's code is taken from the PAUSE code as of April 2013, almost verbatim. That means the heart of this module should be quite stable. The author did make it not use pipe (-|), and stripped out database-related code. So if you hit any issue, it's most probably because of that modification — not because PAUSE lost its main-character energy. 😭

This module doesn't provide features to extract a distribution or parse meta files intentionally. Periodt.

---

🎀 METHODS 🎀

💖 new 💖

Creates an object. You can also pass a hashref taken from META.yml etc, and an optional hashref. The options are:

• ALLOW_DEV_VERSION — Parse::PMFile usually ignores a version with an underscore, just like PAUSE does (because it's for a developer release, and should not be indexed). Set this option to true if you happen to need to keep such a version for better analysis. 💅
• VERBOSE — set this to true if you need to know some details.
• FORK — as of version 0.17, Parse::PMFile stops forking while parsing a version for better performance. Parse::PMFile should return the same result no matter how this option is set, but if you do care, set this to true to fork as PAUSE does.
• USERID, PERMISSIONS — as of version 0.21, Parse::PMFile checks permissions of a package if both USERID and PERMISSIONS (which should be an instance of PAUSE::Permissions) are provided. Unauthorized packages are removed.
• UNSAFE — Parse::PMFile usually parses a module version in a Safe compartment. However, this approach doesn't work smoothly under older perls (prior to 5.10) plus some combinations of recent versions of Safe.pm (2.24 and above) and version.pm (0.9905 and above) for various reasons. As of version 0.27, Parse::PMFile simply uses eval to parse a version under older perls. If you want it to use always eval (even under recent perls), set this to true. 🫶

💅 parse 💅

Takes a path to a .pm file, and returns a hash reference that holds information for package(s) found in the file. Slay. ✨

---

🌈 SEE ALSO 🌈

• Parse::LocalDistribution, PAUSE::Permissions

Most part of this module is derived from PAUSE and CPAN::Version.

• <https://github.com/andk/pause>
• <https://github.com/andk/cpanpm>

---

👑 AUTHOR 👑

Andreas Koenig <andreas.koenig@anima.de>

Kenichi Ishigaki, <ishigaki@cpan.org>

---

💜 COPYRIGHT AND LICENSE 💜

Legal moment, bestie — keep it cute but exact:

Copyright 1995 - 2013 by Andreas Koenig <andk@cpan.org> for most of the code. Copyright 2013 by Kenichi Ishigaki for some. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

🫶 POD ERRORS 🫶

Hey! The above document had some coding errors, which are explained below:

Around line 381:

=pod directives shouldn't be over one line long!  Ignoring all 10 lines of content

---

Sending you a lil kiss from perl v5.42.0, dated 2024-04-22 — mwah 💋✨