PERLMODLIB(1perl)

๐Ÿ“ฆ
version 5.44.0 ยท 2 versions
, in arch rolling

๐Ÿ’– perlmodlib(1perl) ๐Ÿ’–

Perl Programmers Reference Guide


โœจ NAME โœจ

perlmodlib โ€” constructing new Perl modules and finding existing ones ๐Ÿซถ


๐Ÿ“š THE PERL MODULE LIBRARY ๐Ÿ“š

okay so like, the Perl distribution comes with SO many modules, and they're all described down below. they all end in .pm ๐Ÿ’…. you might also stumble upon compiled library files (usually ending in .so) or little bits of modules that get autoloaded (ending in .al) โ€” those were auto-generated when you installed stuff. you might also see files in the library directory ending in .pl or .ph. these are like, the old-school libraries kept around so your ancient programs still run. the .pl files are gonna get converted into standard modules eventually, and the .ph files made by h2ph will probably become extension modules made by h2xs. (some .ph values might already be available through the POSIX, Errno, or Fcntl modules.) the pl2pm file in the distribution can help you convert, but it's just a mechanical process so it's far from bulletproof ๐Ÿ’€.

๐Ÿง  Pragmatic Modules ๐Ÿง 

so these work kinda like compiler directives (pragmata) โ€” they mess with how your program compiles, so you usually gotta use them inside a use or no. most of them are lexically scoped, which means an inner BLOCK can override them by saying:

no integer;
no strict 'refs';
no warnings;

and that lasts until the end of that BLOCK โœจ.

some pragmas are lexically scoped โ€” typically the ones that mess with the $^H hints variable. others affect the current package instead, like use vars and use subs, which let you predeclare variables or subroutines for a whole file, not just a block. those declarations stick for the entire file they're declared in. and you can't take them back with no vars or no subs ๐Ÿ™…โ€โ™€๏ธ.

here are all the defined pragmas (they each have their own docs, too) ๐Ÿ‘‡

  • attributes โ€” get/set subroutine or variable attributes ๐Ÿ’…
  • autodie โ€” replaces functions with ones that either succeed or die, with lexical scope ๐Ÿ’€
  • autodie::exception โ€” exceptions from autodying functions. ๐Ÿ˜ญ
  • autodie::exception::system โ€” exceptions from autodying system(). ๐Ÿ–ฅ๏ธ
  • autodie::hints โ€” provide hints about user subroutines to autodie ๐Ÿง
  • autodie::skip โ€” skip a package when throwing autodie exceptions ๐Ÿ™ˆ
  • autouse โ€” postpone load of modules until a function is used โณ
  • base โ€” establish an ISA relationship with base classes at compile time ๐Ÿ‘‘
  • bigfloat โ€” transparent big floating point number support for Perl ๐ŸŽˆ
  • bigint โ€” transparent big integer support for Perl ๐Ÿ”ข
  • bignum โ€” transparent big number support for Perl ๐Ÿ”ข
  • bigrat โ€” transparent big rational number support for Perl ๐Ÿงฎ
  • blib โ€” use MakeMaker's uninstalled version of a package ๐Ÿ“ฆ
  • builtin โ€” import built-in utility functions ๐Ÿ› ๏ธ
  • bytes โ€” expose the individual bytes of characters ๐Ÿ”ค
  • charnames โ€” access to Unicode character names and named character sequences; also define character names ๐Ÿท๏ธ
  • constant โ€” declare constants ๐Ÿ”’
  • deprecate โ€” Perl pragma for deprecating the inclusion of a module in core ๐Ÿšซ
  • diagnostics โ€” produce verbose warning diagnostics ๐Ÿ“ข
  • encoding โ€” allows you to write your script in non-ASCII and non-UTF-8 ๐ŸŒ
  • encoding::warnings โ€” warn on implicit encoding conversions โš ๏ธ
  • experimental โ€” experimental features made easy ๐Ÿงช
  • feature โ€” enable new features โœจ
  • fields โ€” compile-time class fields ๐Ÿ—๏ธ
  • filetest โ€” control the filetest permission operators ๐Ÿ”
  • if โ€” use a Perl module if a condition holds ๐Ÿค”
  • integer โ€” use integer arithmetic instead of floating point ๐Ÿ”ข
  • less โ€” request less of something ๐Ÿค
  • lib โ€” manipulate @INC at compile time ๐Ÿ“š
  • locale โ€” use or avoid POSIX locales for built-in operations ๐ŸŒ
  • mro โ€” Method Resolution Order ๐Ÿ”Ž
  • ok โ€” alternative to Test::More::use_ok โœ…
  • open โ€” set default PerlIO layers for input and output ๐Ÿ“‚
  • ops โ€” restrict unsafe operations when compiling ๐Ÿšง
  • overload โ€” package for overloading Perl operations ๐ŸŽญ
  • overloading โ€” lexically control overloading ๐Ÿ”„
  • parent โ€” establish an ISA relationship with base classes at compile time ๐Ÿ‘ช
  • re โ€” alter regular expression behaviour ๐Ÿ”
  • sigtrap โ€” enable simple signal handling ๐Ÿšจ
  • sort โ€” control sort() behaviour ๐Ÿ”ค
  • source::encoding โ€” declare Perl source code encoding ๐Ÿ“
  • stable โ€” experimental features made easy, once we know they're stable ๐Ÿ›๏ธ
  • strict โ€” restrict unsafe constructs ๐Ÿšซ
  • subs โ€” predeclare subroutine names ๐Ÿ“
  • threads โ€” Perl interpreter-based threads ๐Ÿงต
  • threads::shared โ€” Perl extension for sharing data structures between threads ๐Ÿค
  • utf8 โ€” enable/disable UTF-8 (or UTF-EBCDIC) in source code ๐ŸŒˆ
  • vars โ€” predeclare global variable names ๐Ÿ“Œ
  • version โ€” Perl extension for Version Objects ๐Ÿ“ฆ
  • vmsish โ€” control VMS-specific language features ๐Ÿ–ฅ๏ธ
  • warnings โ€” control optional warnings โš ๏ธ
  • warnings::register โ€” warnings import function ๐Ÿ“ฅ

๐Ÿ“ฆ Standard Modules ๐Ÿ“ฆ

these standard, bundled modules are all supposed to behave super well and not pollute namespaces because they use the Exporter module. check their own docs for the tea โ˜•.

just a heads up: not all of these might be installed on your system. like, GDBM_File won't be there if you don't have the gdbm library ๐Ÿ’….

  • Amiga::ARexx โ€” Perl extension for ARexx support ๐ŸŽ›๏ธ
  • Amiga::Exec โ€” Perl extension for low level amiga support ๐Ÿ–ฅ๏ธ
  • AnyDBM_File โ€” provide framework for multiple DBMs ๐Ÿ—„๏ธ
  • App::Cpan โ€” easily interact with CPAN from the command line ๐Ÿ’ป
  • App::Prove โ€” implements the "prove" command. ๐Ÿงช
  • App::Prove::State โ€” state storage for the "prove" command. ๐Ÿ—ƒ๏ธ
  • App::Prove::State::Result โ€” individual test suite results. ๐Ÿ“Š
  • App::Prove::State::Result::Test โ€” individual test results. ๐Ÿงพ
  • Archive::Tar โ€” module for manipulations of tar archives ๐Ÿ“ฆ
  • Archive::Tar::File โ€” a subclass for in-memory extracted file from Archive::Tar ๐Ÿ“„
  • Attribute::Handlers โ€” simpler definition of attribute handlers ๐Ÿท๏ธ
  • AutoLoader โ€” load subroutines only on demand โณ
  • AutoSplit โ€” split a package for autoloading โœ‚๏ธ
  • B โ€” the Perl Compiler Backend ๐Ÿง 
  • B::Concise โ€” walk Perl syntax tree, printing concise info about ops ๐ŸŒณ
  • B::Deparse โ€” Perl compiler backend to produce perl code ๐Ÿ”„
  • B::Op_private โ€” OP op_private flag definitions ๐Ÿšฉ
  • B::Showlex โ€” show lexical variables used in functions or files ๐Ÿ”
  • B::Terse โ€” walk Perl syntax tree, printing terse info about ops ๐ŸŒฒ
  • B::Xref โ€” generates cross reference reports for Perl programs ๐Ÿ“ˆ
  • Benchmark โ€” benchmark running times of Perl code โฑ๏ธ
  • CORE โ€” namespace for Perl's core routines ๐Ÿงฌ
  • CPAN โ€” query, download and build perl modules from CPAN sites ๐ŸŒ
  • CPAN::API::HOWTO โ€” a recipe book for programming with CPAN.pm ๐Ÿ“–
  • CPAN::Debug โ€” internal debugging for CPAN.pm ๐Ÿž
  • CPAN::Distroprefs โ€” read and match distroprefs ๐Ÿ”
  • CPAN::FirstTime โ€” utility for CPAN::Config file Initialization โš™๏ธ
  • CPAN::HandleConfig โ€” internal configuration handling for CPAN.pm ๐Ÿ› ๏ธ
  • CPAN::Kwalify โ€” interface between CPAN.pm and Kwalify.pm ๐Ÿ”—
  • CPAN::Meta โ€” the distribution metadata for a CPAN dist ๐Ÿ“‹
  • CPAN::Meta::Converter โ€” convert CPAN distribution metadata structures ๐Ÿ”„
  • CPAN::Meta::Feature โ€” an optional feature provided by a CPAN distribution โœจ
  • CPAN::Meta::History โ€” history of CPAN Meta Spec changes ๐Ÿ“œ
  • CPAN::Meta::History::Meta_1_0 โ€” version 1.0 metadata specification for META.yml ๐Ÿ“„
  • CPAN::Meta::History::Meta_1_1 โ€” version 1.1 metadata specification for META.yml ๐Ÿ“„
  • CPAN::Meta::History::Meta_1_2 โ€” version 1.2 metadata specification for META.yml ๐Ÿ“„
  • CPAN::Meta::History::Meta_1_3 โ€” version 1.3 metadata specification for META.yml ๐Ÿ“„
  • CPAN::Meta::History::Meta_1_4 โ€” version 1.4 metadata specification for META.yml ๐Ÿ“„
  • CPAN::Meta::Merge โ€” merging CPAN Meta fragments ๐Ÿงฉ
  • CPAN::Meta::Prereqs โ€” a set of distribution prerequisites by phase and type ๐Ÿ“‹
  • CPAN::Meta::Requirements โ€” a set of version requirements for a CPAN dist ๐Ÿ“Œ
  • CPAN::Meta::Requirements::Range โ€” a set of version requirements for a CPAN dist ๐Ÿ“Œ
  • CPAN::Meta::Spec โ€” specification for CPAN distribution metadata ๐Ÿ“œ
  • CPAN::Meta::Validator โ€” validate CPAN distribution metadata structures โœ…
  • CPAN::Meta::YAML โ€” read and write a subset of YAML for CPAN Meta files ๐Ÿ“
  • CPAN::Nox โ€” wrapper around CPAN.pm without using any XS module ๐Ÿšซ
  • CPAN::Plugin โ€” base class for CPAN shell extensions ๐Ÿ”Œ
  • CPAN::Plugin::Specfile โ€” proof of concept implementation of a trivial CPAN::Plugin ๐Ÿงช
  • CPAN::Queue โ€” internal queue support for CPAN.pm ๐Ÿ—‚๏ธ
  • CPAN::Tarzip โ€” internal handling of tar archives for CPAN.pm ๐Ÿ“ฆ
  • CPAN::Version โ€” utility functions to compare CPAN versions ๐Ÿ”ข
  • Carp โ€” alternative warn and die for modules ๐ŸŸ
  • Class::Struct โ€” declare struct-like datatypes as Perl classes ๐Ÿ—๏ธ
  • Compress::Raw::Bzip2 โ€” low-level interface to bzip2 compression library ๐Ÿ—œ๏ธ
  • Compress::Raw::Zlib โ€” low-level interface to zlib or zlib-ng compression library ๐Ÿ—œ๏ธ
  • Compress::Zlib โ€” interface to zlib compression library ๐Ÿ—œ๏ธ
  • Config โ€” access Perl configuration information โš™๏ธ
  • Config::Extensions โ€” hash lookup of which core extensions were built. ๐Ÿ”
  • Config::Perl::V โ€” structured data retrieval of perl -V output ๐Ÿ“Š
  • Cwd โ€” get pathname of current working directory ๐Ÿ“‚
  • DB โ€” programmatic interface to the Perl debugging API ๐Ÿž
  • DBM_Filter โ€” filter DBM keys/values ๐Ÿ”
  • DBM_Filter::compress โ€” filter for DBM_Filter ๐Ÿ—œ๏ธ
  • DBM_Filter::encode โ€” filter for DBM_Filter ๐Ÿ”ค
  • DBM_Filter::int32 โ€” filter for DBM_Filter ๐Ÿ”ข
  • DBM_Filter::null โ€” filter for DBM_Filter ๐Ÿšซ
  • DBM_Filter::utf8 โ€” filter for DBM_Filter ๐ŸŒˆ
  • DB_File โ€” Perl access to Berkeley DB 1.x ๐Ÿ—„๏ธ
  • Data::Dumper โ€” stringified perl data structures, suitable for both printing and "eval" ๐Ÿ“ฆ
  • Devel::PPPort โ€” Perl/Pollution/Portability ๐Ÿงช
  • Devel::Peek โ€” a data debugging tool for the XS programmer ๐Ÿ‘€
  • Devel::SelfStubber โ€” generate stubs for a SelfLoading module ๐Ÿง™
  • Digest โ€” modules that calculate message digests ๐Ÿ”
  • Digest::MD5 โ€” Perl interface to the MD5 Algorithm ๐Ÿ”
  • Digest::SHA โ€” Perl extension for SHA-1/224/256/384/512 ๐Ÿ”
  • Digest::base โ€” Digest base class ๐Ÿงฌ
  • Digest::file โ€” calculate digests of files ๐Ÿ“

okay so continuing the great module tour, bestie, we're literally in it now ๐Ÿ’–

  • DirHandle โ€” (obsolete) โ€” throws object methods at directory handles, like a lil time capsule. it's giving legacy energy ngl ๐Ÿซถ
  • Dumpvalue โ€” literally dumps your Perl data to the screen so you can see what's inside. a whole data photoshoot โœจ
  • DynaLoader โ€” yanks C libraries into your Perl code at runtime. dynamic, dramatic, iconic ๐Ÿ’…
  • Encode โ€” the whole character-encoding situation in Perl. the queen bee of bytes ๐Ÿ‘‘
  • Encode::Alias โ€” maps aliases onto encodings. nickname registry fr fr ๐ŸŽ€
  • Encode::Byte โ€” single byte encodings. baby steps, one byte at a time ๐ŸŒธ
  • Encode::CJKConstants โ€” used internally by Encode::??::ISO_2022_*. behind the scenes, no notes ๐Ÿงš
  • Encode::CN โ€” China-based Chinese encodings ๐Ÿ‡จ๐Ÿ‡ณโœจ
  • Encode::CN::HZ โ€” used internally by Encode::CN. secret helper vibes ๐Ÿ™ˆ
  • Encode::Config โ€” used internally by Encode. the config bestie ๐Ÿ’œ
  • Encode::EBCDIC โ€” EBCDIC encodings, the vintage aesthetic of character sets ๐Ÿ’€
  • Encode::Encoder โ€” an object oriented encoder. main character energy fr ๐Ÿฆ‹
  • Encode::Encoding โ€” the base class for implementing Encode stuff. it's giving foundational ๐Ÿ’–
  • Encode::GSM0338 โ€” ETSI GSM 03.38 encoding. yes, the phone-texting one ๐Ÿ“ฑ๐Ÿ’…
  • Encode::Guess โ€” sniffs out the encoding from your data. detective mode, no cap ๐Ÿ”
  • Encode::JP โ€” Japanese encodings ๐Ÿ‡ฏ๐Ÿ‡ต๐ŸŒธ
  • Encode::JP::H2Z โ€” used internally by Encode::JP::2022_JP*. undercover helper โœจ
  • Encode::JP::JIS7 โ€” used internally by Encode::JP. another secret agent ๐Ÿฆ‹
  • Encode::KR โ€” Korean encodings ๐Ÿ‡ฐ๐Ÿ‡ท๐Ÿ’œ
  • Encode::KR::2022_KR โ€” used internally by Encode::KR. living in the shadows ๐Ÿ™ˆ
  • Encode::MIME::Header โ€” MIME encoding for an unstructured email header. email glamour ๐Ÿ’Œ
  • Encode::MIME::Name โ€” used internally by Encode. quiet lil worker bee ๐Ÿ
  • Encode::PerlIO โ€” a detailed document about Encode and PerlIO. the lore drop ๐Ÿ“–
  • Encode::Supported โ€” all the encodings Encode supports. the full roster, periodt ๐Ÿ‘‘
  • Encode::Symbol โ€” symbol encodings. cute and symbolic ๐ŸŽ€
  • Encode::TW โ€” Taiwan-based Chinese encodings ๐Ÿ‡น๐Ÿ‡ผโœจ
  • Encode::Unicode โ€” various Unicode Transformation Formats. UTF-everything ๐ŸŒˆ
  • Encode::Unicode::UTF7 โ€” UTF-7 encoding. the retro cousin ๐Ÿ’€
  • English โ€” lets you use nice English (or awk) names for those ugly punctuation variables. say $INPUT_RECORD_SEPARATOR instead of $/ โ€” glow up ๐Ÿ’…
  • Env โ€” imports environment variables as scalars or arrays. your env vars, but cuter ๐Ÿซถ
  • Errno โ€” system errno constants. all the error codes, cataloged โœจ
  • Exporter โ€” implements the default import method for modules. the reason use actually does stuff ๐Ÿ”ฅ
  • Exporter::Heavy โ€” the guts of Exporter. the internal organs, respectfully ๐Ÿ’€
  • ExtUtils::CBuilder โ€” compiles and links C code for Perl modules ๐Ÿ› ๏ธ
  • ExtUtils::CBuilder::Platform::Windows โ€” the builder class for Windows platforms ๐ŸชŸ
  • ExtUtils::Command โ€” utilities to replace common UNIX commands in Makefiles etc. ๐Ÿ‡บ๐Ÿ‡ณ
  • ExtUtils::Command::MM โ€” commands for the MM's to use in Makefiles. teamwork fr fr ๐Ÿค
  • ExtUtils::Constant โ€” generates XS code to import C header constants. code gen magic โœจ
  • ExtUtils::Constant::Base โ€” base class for ExtUtils::Constant objects. foundation laid ๐Ÿ’–
  • ExtUtils::Constant::Utils โ€” helper functions for ExtUtils::Constant. the lil helpers ๐Ÿงš
  • ExtUtils::Constant::XS โ€” generates C code for XS modules' constants. C code goes brrr ๐Ÿ’…
  • ExtUtils::Embed โ€” utilities for embedding Perl in C/C++ applications ๐Ÿซถ
  • ExtUtils::Install โ€” installs files from here to there. literally the moving truck ๐Ÿšš
  • ExtUtils::Installed โ€” inventory management of installed modules. a lil librarian ๐Ÿ“š
  • ExtUtils::Liblist โ€” decides which libraries to use and how. the whole selection process ๐ŸŽ€
  • ExtUtils::MM โ€” OS-adjusted ExtUtils::MakeMaker subclass. adapts to your platform ๐ŸŒ
  • ExtUtils::MM_AIX โ€” AIX-specific subclass of ExtUtils::MM_Unix ๐Ÿ’ 
  • ExtUtils::MM_Any โ€” platform-agnostic MM methods. works everywhere, iconic ๐ŸŒˆ
  • ExtUtils::MM_BeOS โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐Ÿงก
  • ExtUtils::MM_Cygwin โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐Ÿง
  • ExtUtils::MM_DOS โ€” DOS-specific subclass of ExtUtils::MM_Unix ๐Ÿ’พ
  • ExtUtils::MM_Darwin โ€” special behaviors for OS X ๐ŸŽ
  • ExtUtils::MM_MacOS โ€” once produced Makefiles for MacOS Classic. retired legend ๐Ÿ•ฐ๏ธ
  • ExtUtils::MM_NW5 โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐ŸŸฅ
  • ExtUtils::MM_OS2 โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐Ÿ”ต
  • ExtUtils::MM_OS390 โ€” OS390-specific subclass of ExtUtils::MM_Unix ๐Ÿข
  • ExtUtils::MM_QNX โ€” QNX-specific subclass of ExtUtils::MM_Unix ๐Ÿ
  • ExtUtils::MM_UWIN โ€” U/WIN-specific subclass of ExtUtils::MM_Unix ๐ŸŒŠ
  • ExtUtils::MM_Unix โ€” the methods used by ExtUtils::MakeMaker. the OGs ๐Ÿ’œ
  • ExtUtils::MM_VMS โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐Ÿ’ซ
  • ExtUtils::MM_VOS โ€” VOS-specific subclass of ExtUtils::MM_Unix ๐ŸŒ™
  • ExtUtils::MM_Win32 โ€” methods to override UN*X behaviour in ExtUtils::MakeMaker ๐ŸชŸ
  • ExtUtils::MM_Win95 โ€” a method to customize MakeMaker for Win9X ๐Ÿ’€
  • ExtUtils::MY โ€” the ExtUtils::MakeMaker subclass for customization. your personal touch ๐Ÿ’…
  • ExtUtils::MakeMaker โ€” creates a module Makefile. the whole build pipeline bestie โœจ
  • ExtUtils::MakeMaker::Config โ€” a wrapper around Config.pm ๐ŸŽ
  • ExtUtils::MakeMaker::FAQ โ€” frequently asked questions about MakeMaker. your questions, answered ๐Ÿ™‹
  • ExtUtils::MakeMaker::Locale โ€” bundled Encode::Locale ๐Ÿ“ฆ
  • ExtUtils::MakeMaker::Tutorial โ€” writing a module with MakeMaker. the tutorial arc ๐Ÿ“–
  • ExtUtils::Manifest โ€” utilities to write and check a MANIFEST file ๐Ÿ“
  • ExtUtils::Miniperl โ€” writes the C code for miniperlmain.c and perlmain.c ๐Ÿฃ
  • ExtUtils::Mkbootstrap โ€” makes a bootstrap file for use by DynaLoader ๐Ÿฅพ
  • ExtUtils::Mksymlists โ€” writes linker options files for dynamic extension ๐Ÿ”—
  • ExtUtils::PL2Bat โ€” batch file creation to run Perl scripts on Windows ๐Ÿฆ‡
  • ExtUtils::Packlist โ€” manages .packlist files ๐Ÿ“‹
  • ExtUtils::ParseXS โ€” converts Perl XS code into C code. the translator, ate ๐Ÿ”ฅ
  • ExtUtils::ParseXS::Constants โ€” initialization values for some globals ๐Ÿงฎ
  • ExtUtils::ParseXS::Eval โ€” a clean package to evaluate code in ๐Ÿงผ
  • ExtUtils::ParseXS::Node โ€” classes for nodes of an Abstract Syntax Tree. tree branches fr ๐ŸŒณ
  • ExtUtils::ParseXS::Utilities โ€” subroutines used with ExtUtils::ParseXS ๐Ÿงฐ
  • ExtUtils::Typemaps โ€” read, write and modify Perl/XS typemap files ๐Ÿ’พ
  • ExtUtils::Typemaps::Cmd โ€” quick commands for handling typemaps โšก
  • ExtUtils::Typemaps::InputMap โ€” an entry in the INPUT section of a typemap ๐Ÿ“ฅ
  • ExtUtils::Typemaps::OutputMap โ€” an entry in the OUTPUT section of a typemap ๐Ÿ“ค
  • ExtUtils::Typemaps::Type โ€” an entry in the TYPEMAP section of a typemap ๐Ÿ”ค
  • ExtUtils::XSSymSet โ€” keeps sets of symbol names palatable to the VMS linker ๐Ÿ˜‹
  • ExtUtils::testlib โ€” adds blib/* directories to @INC ๐Ÿงช
  • Fatal โ€” swaps functions for equivalents that succeed or die. all or nothing, periodt ๐Ÿ’€
  • Fcntl โ€” various flag constants and helper functions from C's fcntl.h ๐Ÿšฉ
  • File::Basename โ€” parses file paths into directory, filename and suffix. paths get dissected ๐Ÿ”ช
  • File::Compare โ€” compares files or filehandles ๐Ÿ†š
  • File::Copy โ€” copies files or filehandles. copy-paste but make it Perl ๐Ÿ“„
  • File::DosGlob โ€” DOS-like globbing and then some ๐Ÿ’พโœจ
  • File::Fetch โ€” a generic file fetching mechanism ๐Ÿ•
  • File::Find โ€” traverses a directory tree. going on an adventure ๐ŸŒฒ
  • File::Glob โ€” a Perl extension for the BSD glob routine ๐ŸŒ
  • File::GlobMapper โ€” extends file glob to allow input and output files ๐Ÿ—บ๏ธ
  • File::Path โ€” creates or removes directory trees. landscaping, but for dirs ๐ŸŒณ
  • File::Spec โ€” portably performs operations on file names. cross-platform slay ๐ŸŒˆ
  • File::Spec::AmigaOS โ€” File::Spec for AmigaOS ๐ŸŸก
  • File::Spec::Cygwin โ€” methods for Cygwin file specs ๐Ÿง
  • File::Spec::Epoc โ€” methods for Epoc file specs ๐Ÿ“ฑ
  • File::Spec::Functions โ€” portably performs operations on file names. same vibe, function-flavored ๐Ÿ’–
  • File::Spec::Mac โ€” File::Spec for Mac OS (Classic) ๐ŸŽ
  • File::Spec::OS2 โ€” methods for OS/2 file specs ๐Ÿ”ต
  • File::Spec::Unix โ€” File::Spec for Unix, and the base for the other File::Spec modules. the blueprint ๐Ÿ’…
  • File::Spec::VMS โ€” methods for VMS file specs ๐Ÿ’ซ
  • File::Spec::Win32 โ€” methods for Win32 file specs ๐ŸชŸ
  • File::Temp โ€” returns the name and handle of a temporary file, safely. temp but trustworthy ๐Ÿซถ
  • File::stat โ€” a by-name interface to Perl's built-in stat() functions ๐Ÿ•ต๏ธ
  • FileCache โ€” keeps more files open than the system permits. breaking the rules (legally) ๐Ÿ”ฅ
  • FileHandle โ€” supplies object methods for filehandles ๐Ÿ’…
  • Filter::Simple โ€” simplified source filtering. filtering but make it easy โœจ
  • Filter::Util::Call โ€” the Perl Source Filter Utility Module ๐Ÿงฐ
  • FindBin โ€” locates the directory of the original Perl script. finding your roots ๐ŸŒฑ
  • GDBM_File โ€” Perl5 access to the gdbm library. ๐Ÿ—„๏ธ
  • Getopt::Long โ€” extended processing of command line options. options got range ๐Ÿ”ฅ
  • Getopt::Long::Parser โ€” the Getopt::Long object-oriented interface ๐Ÿ’–
  • Getopt::Std โ€” processes single-character switches with switch clustering ๐ŸŽ›๏ธ
  • HTTP::Tiny โ€” a small, simple, correct HTTP/1.1 client. tiny but mighty ๐Ÿœโœจ
  • Hash::Util โ€” a selection of general-utility hash subroutines ๐Ÿ”‘
  • Hash::Util::FieldHash โ€” support for inside-out classes ๐Ÿ™ƒ
  • I18N::Collate โ€” compares 8-bit scalar data according to the current locale ๐ŸŒ
  • I18N::LangTags โ€” functions for dealing with RFC3066-style language tags ๐Ÿท๏ธ
  • I18N::LangTags::Detect โ€” detects the user's language preferences ๐Ÿ”
  • I18N::LangTags::List โ€” tags and names for human languages ๐Ÿ—ฃ๏ธ
  • I18N::Langinfo โ€” queries locale information ๐Ÿ“Š
  • IO โ€” loads various IO modules ๐Ÿ“ฆ
  • IO::Compress โ€” read and write compressed data in multiple formats. compression buffet ๐Ÿฝ๏ธ
  • IO::Compress::Base โ€” base class for IO::Compress modules ๐Ÿงฑ
  • IO::Compress::Bzip2 โ€” writes bzip2 files and buffers ๐Ÿ—œ๏ธ
  • IO::Compress::Deflate โ€” writes RFC 1950 files and buffers ๐Ÿ“„
  • IO::Compress::FAQ โ€” frequently asked questions about IO::Compress ๐Ÿ™‹
  • IO::Compress::Gzip โ€” writes RFC 1952 files and buffers ๐Ÿ—œ๏ธ
  • IO::Compress::RawDeflate โ€” writes RFC 1951 files and buffers ๐Ÿ“ฆ
  • IO::Compress::Zip โ€” writes zip files and buffers ๐Ÿค
  • IO::Dir โ€” supplies object methods for directory handles. (hi again, same energy as DirHandle) ๐Ÿ’…
  • IO::File โ€” supplies object methods for filehandles ๐Ÿ“
  • IO::Handle โ€” supplies object methods for I/O handles ๐ŸŽ€
  • IO::Pipe โ€” supplies object methods for pipes ๐Ÿšฐ
  • IO::Poll โ€” an object interface to the system poll call ๐Ÿ—ณ๏ธ
  • IO::Seekable โ€” supplies seek-based methods for I/O objects ๐Ÿ”Ž
  • IO::Select โ€” an OO interface to the "select" system call ๐ŸŽฏ
  • IO::Socket โ€” an object interface to socket communications ๐Ÿ”Œ
  • IO::Socket::INET โ€” an object interface for AF_INET domain sockets ๐ŸŒ
  • IO::Socket::IP โ€” a family-neutral IP socket supporting both IPv4 and IPv6. bi-lingual networking ๐Ÿ”ฅ
  • IO::Socket::UNIX โ€” an object interface for AF_UNIX domain sockets ๐Ÿง
  • IO::Uncompress::AnyInflate โ€” uncompresses zlib-based (zip, gzip) files and buffers ๐ŸŽˆ
  • IO::Uncompress::AnyUncompress โ€” uncompresses gzip, zip, bzip2, zstd, xz, lzma, lzip, lzf or lzop files and buffers. the whole squad ๐Ÿ’–
  • IO::Uncompress::Base โ€” base class for IO::Uncompress modules ๐Ÿงฑ
  • IO::Uncompress::Bunzip2 โ€” reads bzip2 files and buffers ๐Ÿ—œ๏ธ
  • IO::Uncompress::Gunzip โ€” reads RFC 1952 files and buffers ๐Ÿ“„
  • IO::Uncompress::Base โ€” (same as above, base class energy) ๐Ÿงฑ

and bestie we're not done yet โ€” hold on, the tour continues ๐Ÿ’œ

  • IO::Uncompress::Inflate โ€” read RFC 1950 files/buffers ๐Ÿ’–
  • IO::Uncompress::RawInflate โ€” read RFC 1951 files/buffers, raw and unfiltered, no cap โœจ
  • IO::Uncompress::Unzip โ€” read zip files/buffers, unzipping the drama away ๐Ÿฆ‹
  • IO::Zlib โ€” the IO::-style interface to Compress::Zlib, serving looks ๐Ÿ‘‘
  • IPC::Cmd โ€” finding and running system commands made easy. literally the bestie who handles the scary subprocess stuff for you ๐Ÿซถ
  • IPC::Msg โ€” SysV Msg IPC object class ๐Ÿ’Œ
  • IPC::Open2 โ€” open a process for both reading and writing using open2() ๐Ÿ”
  • IPC::Open3 โ€” open a process for reading, writing, and error handling using open3(). three-way bind, main character behavior ๐Ÿ’…
  • IPC::Semaphore โ€” SysV Semaphore IPC object class ๐Ÿšฆ
  • IPC::SharedMem โ€” SysV Shared Memory IPC object class ๐Ÿง 
  • IPC::SysV โ€” System V IPC constants and system calls, the OGs ๐Ÿ›๏ธ
  • Internals โ€” reserved special namespace for internals related functions. do not touch unless you know, iykyk ๐Ÿ™ˆ
  • JSON::PP โ€” a JSON::XS-compatible pure-Perl module โญ
  • JSON::PP::Boolean โ€” dummy module providing JSON::PP::Boolean ๐ŸŽ€
  • List::Util โ€” a selection of general-utility list subroutines, like the little spoon of your module list ๐Ÿ“
  • List::Util::XS โ€” indicates if List::Util was compiled with a C compiler ๐Ÿ”ฅ
  • Locale::Maketext โ€” framework for localization ๐ŸŒ
  • Locale::Maketext::Cookbook โ€” recipes for using Locale::Maketext ๐Ÿ‘ฉโ€๐Ÿณ
  • Locale::Maketext::Guts โ€” deprecated module to load Locale::Maketext utf8 code ๐Ÿ’€
  • Locale::Maketext::GutsLoader โ€” deprecated module to load Locale::Maketext utf8 code ๐Ÿ’€
  • Locale::Maketext::Simple โ€” simple interface to Locale::Maketext::Lexicon ๐ŸŒธ
  • Locale::Maketext::TPJ13 โ€” an article about software localization ๐Ÿ“
  • MIME::Base64 โ€” encoding and decoding of base64 strings ๐Ÿ”ค
  • MIME::QuotedPrint โ€” encoding and decoding of quoted-printable strings ๐Ÿ–จ๏ธ
  • Math::BigFloat โ€” arbitrary size floating point math package ๐ŸŽˆ
  • Math::BigInt โ€” arbitrary size integer math package ๐Ÿ”ข
  • Math::BigInt::Calc โ€” pure Perl module to support Math::BigInt ๐Ÿงฎ
  • Math::BigInt::FastCalc โ€” Math::BigInt::Calc with some XS for more speed โœจ
  • Math::BigInt::Lib โ€” virtual parent class for Math::BigInt libraries ๐Ÿ‘‘
  • Math::BigRat โ€” arbitrary size rational number math package ๐Ÿ€
  • Math::Complex โ€” complex numbers and associated mathematical functions ๐ŸŒˆ
  • Math::Trig โ€” trigonometric functions. sin, cos, tan, the whole squad ๐Ÿ“
  • Memoize โ€” make functions faster by trading space for time. the classic deal-with-the-devil arc ๐Ÿ”ฅ
  • Memoize::AnyDBM_File โ€” glue to provide EXISTS for AnyDBM_File for Storable use ๐Ÿฉน
  • Memoize::Expire โ€” plug-in module for automatic expiration of memoized values โณ
  • Memoize::NDBM_File โ€” glue to provide EXISTS for NDBM_File for Storable use ๐Ÿฉน
  • Memoize::SDBM_File โ€” DEPRECATED compatibility shim ๐Ÿชฆ
  • Memoize::Storable โ€” store memoized data in a Storable database ๐Ÿ“ฆ
  • Module::CoreList โ€” what modules shipped with versions of perl ๐Ÿ—‚๏ธ
  • Module::CoreList::Utils โ€” what utilities shipped with versions of perl ๐Ÿ› ๏ธ
  • Module::Load โ€” runtime require of both modules and files ๐Ÿš€
  • Module::Load::Conditional โ€” looking up module information / loading at runtime ๐Ÿ”Ž
  • Module::Loaded โ€” mark modules as loaded or unloaded โœ…
  • Module::Metadata โ€” gather package and POD information from perl module files ๐Ÿ•ต๏ธ
  • NDBM_File โ€” tied access to ndbm files ๐Ÿ—„๏ธ
  • NEXT โ€” provide a pseudo-class NEXT (et al) that allows method redispatch โญ๏ธ
  • Net::Cmd โ€” Network Command class (as used by FTP, SMTP etc) ๐Ÿ“ก
  • Net::Config โ€” local configuration data for libnet โš™๏ธ
  • Net::Domain โ€” attempt to evaluate the current host's internet name and domain ๐Ÿ 
  • Net::FTP โ€” FTP Client class ๐Ÿ“
  • Net::FTP::dataconn โ€” FTP Client data connection class ๐Ÿ”Œ
  • Net::NNTP โ€” NNTP Client class ๐Ÿ“ฐ
  • Net::Netrc โ€” OO interface to users netrc file ๐Ÿ“œ
  • Net::POP3 โ€” Post Office Protocol 3 Client class (RFC1939) ๐Ÿ“ฌ
  • Net::Ping โ€” check a remote host for reachability ๐Ÿ“
  • Net::SMTP โ€” Simple Mail Transfer Protocol Client โœ‰๏ธ
  • Net::Time โ€” time and daytime network client interface ๐Ÿ•ฐ๏ธ
  • Net::hostent โ€” by-name interface to Perl's built-in gethost*() functions ๐Ÿ–ฅ๏ธ
  • Net::libnetFAQ โ€” libnet Frequently Asked Questions โ“
  • Net::netent โ€” by-name interface to Perl's built-in getnet*() functions ๐ŸŒ
  • Net::protoent โ€” by-name interface to Perl's built-in getproto*() functions ๐Ÿ“‹
  • Net::servent โ€” by-name interface to Perl's built-in getserv*() functions ๐Ÿšช

okay bestie, we're entering the section of the list where everything is named after one letter or a vague concept. stay with me. ๐Ÿ’œ
  • O โ€” generic interface to Perl Compiler backends ๐Ÿ”ญ
  • ODBM_File โ€” tied access to odbm files ๐Ÿ—„๏ธ
  • Opcode โ€” disable named opcodes when compiling perl code ๐Ÿšซ
  • POSIX โ€” Perl interface to IEEE Std 1003.1 ๐Ÿ“
  • Params::Check โ€” a generic input parsing/checking mechanism ๐Ÿ”
  • Parse::CPAN::Meta โ€” parse META.yml and META.json CPAN metadata files ๐Ÿงพ
  • Perl::OSType โ€” map Perl operating system names to generic types ๐Ÿ—บ๏ธ
  • PerlIO โ€” on demand loader for PerlIO layers and root of PerlIO::* name space ๐ŸŒฑ
  • PerlIO::encoding โ€” encoding layer ๐Ÿ”ก
  • PerlIO::mmap โ€” memory mapped IO ๐Ÿง 
  • PerlIO::scalar โ€” in-memory IO, scalar IO ๐Ÿ’ญ
  • PerlIO::via โ€” helper class for PerlIO layers implemented in perl ๐Ÿงฐ
  • PerlIO::via::QuotedPrint โ€” PerlIO layer for quoted-printable strings ๐Ÿ–จ๏ธ
  • Pod::Checker โ€” check pod documents for syntax errors ๐Ÿฉบ
  • Pod::Escapes โ€” for resolving Pod E<...> sequences ๐Ÿ”“
  • Pod::Functions โ€” group Perl's functions a la perlfunc.pod ๐Ÿ“š
  • Pod::Html โ€” module to convert pod files to HTML ๐ŸŒ
  • Pod::Html::Util โ€” helper functions for Pod-Html ๐Ÿงท
  • Pod::Man โ€” convert POD data to formatted *roff input ๐Ÿ“–
  • Pod::ParseLink โ€” parse an L<> formatting code in POD text ๐Ÿ”—
  • Pod::Perldoc โ€” look up Perl documentation in Pod format ๐Ÿ”
  • Pod::Perldoc::BaseTo โ€” base for Pod::Perldoc formatters ๐Ÿงฑ
  • Pod::Perldoc::GetOptsOO โ€” customized option parser for Pod::Perldoc ๐ŸŽ›๏ธ
  • Pod::Perldoc::ToANSI โ€” render Pod with ANSI color escapes ๐ŸŒˆ
  • Pod::Perldoc::ToChecker โ€” let Perldoc check Pod for errors โœ…
  • Pod::Perldoc::ToMan โ€” let Perldoc render Pod as man pages ๐Ÿ“„
  • Pod::Perldoc::ToNroff โ€” let Perldoc convert Pod to nroff ๐Ÿ–จ๏ธ
  • Pod::Perldoc::ToPod โ€” let Perldoc render Pod as ... Pod! ๐Ÿ’… iconic, honestly
  • Pod::Perldoc::ToRtf โ€” let Perldoc render Pod as RTF ๐Ÿ“
  • Pod::Perldoc::ToTerm โ€” render Pod with terminal escapes ๐Ÿ’ป
  • Pod::Perldoc::ToText โ€” let Perldoc render Pod as plaintext ๐Ÿ“ƒ
  • Pod::Perldoc::ToTk โ€” let Perldoc use Tk::Pod to render Pod ๐ŸชŸ
  • Pod::Perldoc::ToXml โ€” let Perldoc render Pod as XML ๐Ÿท๏ธ
  • Pod::Simple โ€” framework for parsing Pod ๐Ÿงš
  • Pod::Simple::Checker โ€” check the Pod syntax of a document ๐Ÿฉบ
  • Pod::Simple::Debug โ€” put Pod::Simple into trace/debug mode ๐Ÿ›
  • Pod::Simple::DumpAsText โ€” dump Pod-parsing events as text ๐Ÿ“ค
  • Pod::Simple::DumpAsXML โ€” turn Pod into XML ๐Ÿ”„
  • Pod::Simple::HTML โ€” convert Pod to HTML ๐ŸŒ
  • Pod::Simple::HTMLBatch โ€” convert several Pod files to several HTML files ๐Ÿ“ฆ
  • Pod::Simple::JustPod โ€” just the Pod, the whole Pod, and nothing but the Pod ๐ŸŽฏ
  • Pod::Simple::LinkSection โ€” represent "section" attributes of L codes ๐Ÿ”—
  • Pod::Simple::Methody โ€” turn Pod::Simple events into method calls ๐Ÿ“ž
  • Pod::Simple::PullParser โ€” a pull-parser interface to parsing Pod ๐Ÿงฒ
  • Pod::Simple::PullParserEndToken โ€” end-tokens from Pod::Simple::PullParser ๐Ÿ
  • Pod::Simple::PullParserStartToken โ€” start-tokens from Pod::Simple::PullParser ๐Ÿšฉ
  • Pod::Simple::PullParserTextToken โ€” text-tokens from Pod::Simple::PullParser ๐Ÿ”ค
  • Pod::Simple::PullParserToken โ€” tokens from Pod::Simple::PullParser ๐ŸŽŸ๏ธ
  • Pod::Simple::RTF โ€” format Pod as RTF ๐Ÿ“
  • Pod::Simple::Search โ€” find POD documents in directory trees ๐Ÿ”Ž
  • Pod::Simple::SimpleTree โ€” parse Pod into a simple parse tree ๐ŸŒณ
  • Pod::Simple::Subclassing โ€” write a formatter as a Pod::Simple subclass ๐Ÿ‘ฉโ€๐Ÿ’ป
  • Pod::Simple::Text โ€” format Pod as plaintext ๐Ÿ“„
  • Pod::Simple::TextContent โ€” get the text content of Pod ๐Ÿ“
  • Pod::Simple::XHTML โ€” format Pod as validating XHTML โœ…
  • Pod::Simple::XMLOutStream โ€” turn Pod into XML ๐Ÿ”„
  • Pod::Text โ€” convert POD data to formatted text ๐Ÿ“ƒ
  • Pod::Text::Color โ€” convert POD data to formatted color ASCII text ๐ŸŒˆ
  • Pod::Text::Overstrike โ€” convert POD data to formatted overstrike text ๐Ÿ’ฅ
  • Pod::Text::Termcap โ€” convert POD data to ASCII text with format escapes ๐Ÿ’ป
  • Pod::Usage โ€” extracts POD documentation and shows usage information ๐Ÿ“ข
  • SDBM_File โ€” tied access to sdbm files ๐Ÿ—„๏ธ
  • Safe โ€” compile and execute code in restricted compartments ๐Ÿ”’
  • Scalar::List::Utils โ€” a distribution of general-utility subroutines ๐Ÿงฐ
  • Scalar::Util โ€” a selection of general-utility scalar subroutines โœจ
  • Search::Dict โ€” Look - search for key in dictionary file ๐Ÿ“–
  • SelectSaver โ€” save and restore selected file handle ๐Ÿ’พ
  • SelfLoader โ€” load functions only on demand ๐Ÿช„
  • Socket โ€” networking constants and support functions ๐Ÿ”Œ
  • Storable โ€” persistence for Perl data structures ๐Ÿ“ฆ
  • Sub::Util โ€” a selection of utility subroutines for subs and CODE references ๐Ÿ› ๏ธ
  • Symbol โ€” manipulate Perl symbols and their names ๐Ÿ”ฃ
  • Sys::Hostname โ€” try every conceivable way to get hostname ๐Ÿ 
  • Sys::Syslog โ€” Perl interface to the UNIX syslog(3) calls ๐Ÿ“‹
  • Sys::Syslog::Win32 โ€” Win32 support for Sys::Syslog ๐ŸชŸ
  • TAP::Base โ€” base class that provides common functionality to TAP::Parser ๐Ÿงฑ
  • TAP::Formatter::Base โ€” base class for harness output delegates ๐ŸŽ›๏ธ
  • TAP::Formatter::Color โ€” run Perl test scripts with color ๐ŸŒˆ
  • TAP::Formatter::Console โ€” harness output delegate for default console output ๐Ÿ–ฅ๏ธ
  • TAP::Formatter::Console::ParallelSession โ€” harness output delegate for parallel console output โšก
  • TAP::Formatter::Console::Session โ€” harness output delegate for default console output ๐Ÿ–ฅ๏ธ
  • TAP::Formatter::File โ€” harness output delegate for file output ๐Ÿ“
  • TAP::Formatter::File::Session โ€” harness output delegate for file output ๐Ÿ“
  • TAP::Formatter::Session โ€” abstract base class for harness output delegate ๐Ÿงฑ
  • TAP::Harness โ€” run test scripts with statistics ๐Ÿ“Š
  • TAP::Harness::Env โ€” parsing harness related environmental variables where appropriate ๐ŸŒฟ
  • TAP::Object โ€” base class that provides common functionality to all "TAP::*" modules ๐Ÿ‘‘
  • TAP::Parser โ€” the main character that parses TAP output, no cap ๐Ÿ’…
  • TAP::Parser::Aggregator โ€” bundles up a whole bunch of TAP::Parser results into one, lowkey essential
  • TAP::Parser::Grammar โ€” a grammar for the Test Anything Protocol. that's it, that's the vibe โœจ
  • TAP::Parser::Iterator โ€” base class for TAP source iterators, the parent of the whole iterator fam
  • TAP::Parser::Iterator::Array โ€” iterator for TAP sources that live in arrays
  • TAP::Parser::Iterator::Process โ€” iterator for TAP sources that come from a process
  • TAP::Parser::Iterator::Stream โ€” iterator for TAP sources coming off a filehandle
  • TAP::Parser::IteratorFactory โ€” figures out which SourceHandler objects to use for a given Source, like a little matchmaker ๐ŸŽ€
  • TAP::Parser::Multiplexer โ€” multiplex multiple TAP::Parsers, i.e. keep several parsers going at once
  • TAP::Parser::Result โ€” base class for TAP::Parser output objects
  • TAP::Parser::Result::Bailout โ€” the bailout result token.
  • TAP::Parser::Result::Comment โ€” the comment result token.
  • TAP::Parser::Result::Plan โ€” the plan result token.
  • TAP::Parser::Result::Pragma โ€” the TAP pragma token.
  • TAP::Parser::Result::Test โ€” the test result token.
  • TAP::Parser::Result::Unknown โ€” the unknown result token.
  • TAP::Parser::Result::Version โ€” the TAP syntax version token.
  • TAP::Parser::Result::YAML โ€” the YAML result token.
  • TAP::Parser::ResultFactory โ€” the factory for creating TAP::Parser output objects ๐Ÿญ
  • TAP::Parser::Scheduler โ€” schedules tests while you're doing parallel testing
  • TAP::Parser::Scheduler::Job โ€” one single testing job.
  • TAP::Parser::Scheduler::Spinner โ€” a no-op job. it just sits there. slay โœจ
  • TAP::Parser::Source โ€” a TAP source, plus meta data about it
  • TAP::Parser::SourceHandler โ€” base class for the different TAP source handlers
  • TAP::Parser::SourceHandler::Executable โ€” streams output from an executable TAP source
  • TAP::Parser::SourceHandler::File โ€” streams TAP from a text file.
  • TAP::Parser::SourceHandler::Handle โ€” streams TAP from an IO::Handle or a GLOB.
  • TAP::Parser::SourceHandler::Perl โ€” streams TAP from a Perl executable ๐Ÿช
  • TAP::Parser::SourceHandler::RawTAP โ€” streams output from raw TAP sitting in a scalar or array ref.
  • TAP::Parser::YAMLish::Reader โ€” reads YAMLish data from an iterator
  • TAP::Parser::YAMLish::Writer โ€” writes YAMLish data
  • Term::ANSIColor โ€” colors your screen output using ANSI escape sequences ๐ŸŒˆ
  • Term::Cap โ€” the Perl termcap interface
  • Term::Complete โ€” the Perl word completion module
  • Term::Complete... no wait, Term::ReadLine โ€” the Perl interface to various "readline" packages.
  • Term::Table โ€” formats a header and rows into a table
  • Term::Table::Cell โ€” the representation of a cell in a table.
  • Term::Table::CellStack โ€” combines several cells into one (vertical).
  • Term::Table::HashBase โ€” builds hash based classes.
  • Term::Table::LineBreak โ€” breaks up lines so they fit in tables.
  • Term::Table::Util โ€” utilities for Term::Table.
  • Test โ€” provides a simple framework for writing test scripts ๐Ÿงช
  • Test2 โ€” a framework for writing test tools that all work together.
  • Test2::API โ€” the primary interface for writing Test2 based testing tools.
  • Test2::API::Breakage โ€” what breaks at what version ๐Ÿ’€
  • Test2::API::Context โ€” an object to represent a testing context.
  • Test2::API::Instance โ€” the object Test2::API uses under the hood
  • Test2::API::InterceptResult โ€” the representation of a list of events.
  • Test2::API::InterceptResult::Event โ€” representation of an event for use in โ€ฆand yeah bestie the manpage literally cuts off right there, that's all it gives us ๐Ÿ˜ญ
  • Test2::API::InterceptResult::Hub โ€” the hub used by InterceptResult.
  • Test2::API::InterceptResult::Squasher โ€” encapsulation of the algorithm that โ€ฆ(also cut off, the page is like that, not my fault ๐Ÿ™ˆ)
  • Test2::API::Stack โ€” an object to manage a stack of Test2::Hub
  • Test2::AsyncSubtest โ€” an object representing an async subtest.
  • Test2::AsyncSubtest::Event::Attach โ€” the event that attaches a subtest to the parent.
  • Test2::AsyncSubtest::Event::Detach โ€” the event that detaches a subtest from the parent.
  • Test2::AsyncSubtest::Hub โ€” the hub used by async subtests.
  • Test2::Bundle โ€” documentation for bundles.
  • Test2::Bundle::Extended โ€” the old name for Test2::V0
  • Test2::Bundle::More โ€” ALMOST a drop-in replacement for Test::More. ALMOST, okay, read the fine print ๐Ÿ‘€
  • Test2::Bundle::Simple โ€” ALMOST a drop-in replacement for Test::Simple.
  • Test2::Compare โ€” the Test2 extension for writing deep comparison tools.
  • Test2::Compare::Array โ€” the internal representation of an array comparison.
  • Test2::Compare::Bag โ€” the internal representation of a bag comparison.
  • Test2::Compare::Base โ€” the base class for comparison classes.
  • Test2::Compare::Bool โ€” compares two values as booleans
  • Test2::Compare::Custom โ€” a custom field check for comparisons.
  • Test2::Compare::DeepRef โ€” ref comparison
  • Test2::Compare::Delta โ€” the representation of differences between nested data
  • Test2::Compare::Event โ€” the event specific Object subclass.
  • Test2::Compare::EventMeta โ€” the meta class for events in deep comparisons
  • Test2::Compare::Float โ€” compares two values as numbers, but with tolerance.
  • Test2::Compare::Hash โ€” the representation of a hash in a deep comparison.
  • Test2::Compare::Isa โ€” checks whether the value is an instance of the class.
  • Test2::Compare::Meta โ€” the check library for meta-checks
  • Test2::Compare::Negatable โ€” a poor man's 'role' for compare objects that can be negated.
  • Test2::Compare::Number โ€” compares two values as numbers
  • Test2::Compare::Object โ€” the representation of an object during deep โ€ฆ(cut off again, the original literally ends there ๐Ÿ’€)
  • Test2::Compare::OrderedSubset โ€” the internal representation of an ordered subset.
  • Test2::Compare::Pattern โ€” uses a pattern to validate values in a deep โ€ฆ(yep, truncated, moving on ๐Ÿฆ‹)
  • Test2::Compare::Ref โ€” ref comparison
  • Test2::Compare::Regex โ€” regex direct comparison
  • Test2::Compare::Scalar โ€” the representation of a Scalar Ref in deep โ€ฆ(cut off, but you get it)
  • Test2::Compare::Set โ€” allows a field to be matched against a set of โ€ฆ(also truncated!)
  • Test2::Compare::String โ€” compares two values as strings
  • Test2::Compare::Undef โ€” checks that something is undefined
  • Test2::Compare::Wildcard โ€” a placeholder check.
  • Test2::Env โ€” documentation for the environment variables used or set by Test2.
  • Test2::Event โ€” the base class for events
  • Test2::Event::Bail โ€” bailout! ๐Ÿšจ
  • Test2::Event::Diag โ€” the diag event type
  • Test2::Event::Encoding โ€” sets the encoding for the output stream
  • Test2::Event::Exception โ€” the exception event
  • Test2::Event::Fail โ€” the event for a simple failed assertion
  • Test2::Event::Generic โ€” the generic event type.
  • Test2::Event::Note โ€” the note event type
  • Test2::Event::Ok โ€” the ok event type
  • Test2::Event::Pass โ€” the event for a simple passing assertion โœจ
  • Test2::Event::Plan โ€” the event of a plan
  • Test2::Event::Skip โ€” the skip event type
  • Test2::Event::Subtest โ€” the event for subtest types
  • Test2::Event::TAP::Version โ€” the event for the TAP version.
  • Test2::Event::V2 โ€” the second generation event.
  • Test2::Event::Waiting โ€” tells all procs and threads that it is time to be done
  • Test2::EventFacet โ€” the base class for all event facets.
  • Test2::EventFacet::About โ€” the facet with event details.
  • Test2::EventFacet::Amnesty โ€” the facet for assertion amnesty. (a full pardon, bestie ๐Ÿซถ)
  • Test2::EventFacet::Assert โ€” the facet representing an assertion.
  • Test2::EventFacet::Control โ€” the facet for hub actions and behaviors.
  • Test2::EventFacet::Error โ€” the facet for errors that need to be shown.
  • Test2::EventFacet::Hub โ€” the facet for the hubs an event passes through.
  • Test2::EventFacet::Info โ€” the facet for information a developer might care about.
  • Test2::EventFacet::Info::Table โ€” the intermediary representation of a table.
  • Test2::EventFacet::Meta โ€” the facet for meta-data
  • Test2::EventFacet::Parent โ€” the facet for events that contains other events
  • Test2::EventFacet::Plan โ€” the facet for setting the plan
  • Test2::EventFacet::Render โ€” the facet that dictates how to render an event.
  • Test2::EventFacet::Trace โ€” the debug information for events
  • Test2::Formatter โ€” the namespace for formatters.
  • Test2::Formatter::TAP โ€” the standard TAP formatter
  • Test2::Handle โ€” the base class for Test2 handles used in V# bundles.
  • Test2::Hub โ€” the conduit through which all events flow. iconic โœจ
  • Test2::Hub::Interceptor โ€” the hub used by the interceptor to grab results.
  • Test2::Hub::Interceptor::Terminator โ€” an exception class used by โ€ฆ(truncated, rip ๐Ÿ’€)
  • Test2::Hub::Subtest โ€” the hub used by subtests
  • Test2::IPC โ€” turns on IPC so you get threading or forking support.
  • Test2::IPC::Driver โ€” the base class for Test2 IPC drivers.
  • Test2::IPC::Driver::Files โ€” the temp dir + files concurrency model.
  • Test2::Manual โ€” the documentation hub for Test2 and Test2-Suite.
  • Test2::Manual::Anatomy โ€” the hub for documentation of the inner workings of โ€ฆ(cut off, again, I know ๐Ÿ˜ญ)
  • Test2::Manual::Anatomy::API โ€” internals documentation for the API.
  • Test2::Manual::Anatomy::Context โ€” internals documentation for the Context
  • Test2::Manual::Anatomy::EndToEnd โ€” an overview of Test2 from load to finish.
  • Test2::Manual::Anatomy::Event โ€” the internals of events
  • Test2::Manual::Anatomy::Hubs โ€” internals documentation for the hub stack, and โ€ฆ(truncated)
  • Test2::Manual::Anatomy::IPC โ€” the manual for the IPC system.
  • Test2::Manual::Anatomy::Utilities โ€” an overview of utilities for Test2.
  • Test2::Manual::Concurrency โ€” documentation for Concurrency support.
  • Test2::Manual::Contributing โ€” how to contribute to the Test2 project.
  • Test2::Manual::Testing โ€” the hub for documentation about writing tests with Test2.
  • Test2::Manual::Testing::Introduction โ€” an introduction to testing with Test2.
  • Test2::Manual::Testing::Migrating โ€” how to migrate existing tests from โ€ฆ(and the page cuts off right here ๐ŸŽ€)
  • Test2::Manual::Testing::Planning โ€” the many ways to set a plan, bestie. so many. pick one. ๐ŸŽ€
  • Test2::Manual::Testing::Todo โ€” tutorial for marking tests as TODO. the "we'll get to it" pile, but make it official. โœจ
  • Test2::Manual::Tooling โ€” manual page for tool authors. iykyk, this one's for the builders. ๐Ÿ”ฅ
  • Test2::Manual::Tooling::FirstTool โ€” write your first tool with Test2. baby's first tool ๐Ÿฅน so iconic.
  • Test2::Manual::Tooling::Formatter โ€” how to write a custom formatter, in our
  • Test2::Manual::Tooling::Nesting โ€” tutorial for using other tools within your
  • Test2::Manual::Tooling::Plugin::TestExit โ€” how to safely add pre-exit
  • Test2::Manual::Tooling::Plugin::TestingDone โ€” run code when the test file is
  • Test2::Manual::Tooling::Plugin::ToolCompletes โ€” how to add behaviors that occur
  • Test2::Manual::Tooling::Plugin::ToolStarts โ€” how to add behaviors that occur
  • Test2::Manual::Tooling::Subtest โ€” how to implement a tool that makes use of
  • Test2::Manual::Tooling::TestBuilder โ€” this section maps Test::Builder methods
  • Test2::Manual::Tooling::Testing โ€” tutorial on how to test your testing tools. testing inception fr fr ๐ŸŒ€
  • Test2::Mock โ€” module for managing mocked classes and instances. fake it till the tests pass ๐Ÿ’…
  • Test2::Plugin โ€” documentation for plugins.
  • Test2::Plugin::BailOnFail โ€” automatically bail out of testing on the first test
  • Test2::Plugin::DieOnFail โ€” automatically die on the first test failure. dramatic but valid ๐Ÿ’€
  • Test2::Plugin::ExitSummary โ€” add extra diagnostics on failure at the end of the
  • Test2::Plugin::SRand โ€” control the random seed for more controlled test
  • Test2::Plugin::Times โ€” output timing data at the end of the test. clocking the vibe โฑ๏ธ
  • Test2::Plugin::UTF8 โ€” Test2 plugin to test with utf8. unicode besties only ๐Ÿฆ‹
  • Test2::Require โ€” base class and documentation for skip-unless type test
  • Test2::Require::AuthorTesting โ€” only run a test when the AUTHOR_TESTING
  • Test2::Require::AutomatedTesting โ€” only run a test when the AUTOMATED_TESTING
  • Test2::Require::EnvVar โ€” only run a test when a specific environment variable
  • Test2::Require::ExtendedTesting โ€” only run a test when the EXTENDED_TESTING
  • Test2::Require::Fork โ€” skip a test file unless the system supports forking
  • Test2::Require::Module โ€” skip tests if certain packages are not installed, or
  • Test2::Require::NonInteractiveTesting โ€” only run a test when the NONINTERACTIVE_TESTING
  • Test2::Require::Perl โ€” skip the test unless the necessary version of Perl is
  • Test2::Require::RealFork โ€” skip a test file unless the system supports true
  • Test2::Require::ReleaseTesting โ€” only run a test when the RELEASE_TESTING
  • Test2::Require::Threads โ€” skip a test file unless the system supports threading
  • Test2::Suite โ€” distribution with a rich set of tools built upon the Test2
  • Test2::Todo โ€” TODO extension for Test2.
  • Test2::Tools โ€” documentation for Tools.
  • Test2::Tools::AsyncSubtest โ€” tools for writing async subtests.
  • Test2::Tools::Basic โ€” Test2 implementation of the basic testing tools.
  • Test2::Tools::Class โ€” Test2 implementation of the tools for testing classes.
  • Test2::Tools::ClassicCompare โ€” classic (Test::More style) comparison tools. retro but make it slay โœจ
  • Test2::Tools::Compare โ€” tools for comparing deep data structures.
  • Test2::Tools::Defer โ€” write tests that get executed at a later time
  • Test2::Tools::Encoding โ€” tools for managing the encoding of Test2 based
  • Test2::Tools::Event โ€” tools for generating test events.
  • Test2::Tools::Exception โ€” Test2 based tools for checking exceptions
  • Test2::Tools::Exports โ€” tools for validating exporters.
  • Test2::Tools::GenTemp โ€” tool for generating a populated temp directory.
  • Test2::Tools::Grab โ€” temporarily intercept all events without adding a scope
  • Test2::Tools::Mock โ€” class/instance mocking for Test2.
  • Test2::Tools::Ref โ€” tools for validating references.
  • Test2::Tools::Refcount โ€” assert reference counts on objects
  • Test2::Tools::Spec โ€” RSPEC implementation on top of Test2::Workflow
  • Test2::Tools::Subtest โ€” tools for writing subtests
  • Test2::Tools::Target โ€” alias the testing target package.
  • Test2::Tools::Tester โ€” tools to help you test other testing tools. meta af ๐ŸŒ€
  • Test2::Tools::Tiny โ€” tiny set of tools for unfortunate souls who cannot use
  • Test2::Tools::Warnings โ€” tools to verify warnings.
  • Test2::Transition โ€” transition notes when upgrading to Test2
  • Test2::Util โ€” tools used by Test2 and friends.
  • Test2::Util::ExternalMeta โ€” allow third party tools to safely attach meta-data
  • Test2::Util::Facets2Legacy โ€” convert facet data to the legacy event API.
  • Test2::Util::Grabber โ€” object used to temporarily intercept all events.
  • Test2::Util::Guard โ€” inline copy of Scope::Guard
  • Test2::Util::HashBase โ€” build hash based classes.
  • Test2::Util::Importer โ€” inline copy of Importer.
  • Test2::Util::Ref โ€” tools for inspecting or manipulating references.
  • Test2::Util::Sig โ€” signal tools used by Test2 and friends.
  • Test2::Util::Stash โ€” utilities for manipulating stashes and globs.
  • Test2::Util::Sub โ€” tools for inspecting and manipulating subs.
  • Test2::Util::Table โ€” format a header and rows into a table
  • Test2::Util::Table::LineBreak โ€” break up lines for use in tables.
  • Test2::Util::Times โ€” format timing/benchmark information.
  • Test2::Util::Trace โ€” legacy wrapper for Test2::EventFacet::Trace.
  • Test2::V0 โ€” 0th edition of the Test2 recommended bundle. the OG ๐Ÿ‘‘
  • Test2::V1 โ€” V1 edition of the Test2 recommended bundle.
  • Test2::V1::Base โ€” base namespace used for Test2::Handle objects created via
  • Test2::V1::Handle โ€” V1 subclass of Test2::Handle.
  • Test2::Workflow โ€” a test workflow is a way of structuring tests using
  • Test2::Workflow::BlockBase โ€” base class for all workflow blocks.
  • Test2::Workflow::Build โ€” represents a build in progress.
  • Test2::Workflow::Runner โ€” runs the workflows.
  • Test2::Workflow::Task โ€” encapsulation of a Task
  • Test2::Workflow::Task::Action โ€” encapsulation of an action.
  • Test2::Workflow::Task::Group โ€” encapsulation of a group (describe).
  • Test::Builder โ€” backend for building test libraries
  • Test::Builder::Formatter โ€” Test::Builder subclass of Test2::Formatter::TAP
  • Test::Builder::Module โ€” base class for test modules
  • Test::Builder::Tester โ€” test testsuites that have been built with
  • Test::Builder::Tester::Color โ€” turn on colour in Test::Builder::Tester
  • Test::Builder::TodoDiag โ€” Test::Builder subclass of Test2::Event::Diag
  • Test::Harness โ€” run Perl standard test scripts with statistics
  • Test::Harness::Beyond โ€” beyond make test
  • Test::More โ€” yet another framework for writing test scripts
  • Test::Simple โ€” basic utilities for writing tests.
  • Test::Tester โ€” ease testing test modules built with Test::Builder
  • Test::Tester::Capture โ€” help testing test modules built with Test::Builder
  • Test::Tester::CaptureRunner โ€” help testing test modules built with Test::Builder
  • Test::Tutorial โ€” a tutorial about writing really basic tests
  • Test::use::ok โ€” alternative to Test::More::use_ok
  • Text::Abbrev โ€” abbrev - create an abbreviation table from a list
  • Text::Balanced โ€” extract delimited text sequences from strings.
  • Text::ParseWords โ€” parse text into an array of tokens or array of arrays
  • Text::Tabs โ€” expand and unexpand tabs like unix expand(1) and unexpand(1)
  • Text::Wrap โ€” line wrapping to form simple paragraphs
  • Thread โ€” manipulate threads in Perl (for old code only). legacy energy, handle with care bestie โš ๏ธ
  • Thread::Queue โ€” thread-safe queues
  • Thread::Semaphore โ€” thread-safe semaphores
  • Tie::Array โ€” base class for tied arrays
  • Tie::File โ€” access the lines of a disk file via a Perl array
  • Tie::Handle โ€” base class definitions for tied handles
  • Tie::Hash โ€” base class definitions for tied hashes
  • Tie::Hash::NamedCapture โ€” named regexp capture buffers
  • Tie::Memoize โ€” add data to hash when needed
  • Tie::RefHash โ€” use references as hash keys
  • Tie::Scalar โ€” base class definitions for tied scalars
  • Tie::StdHandle โ€” base class definitions for tied handles
  • Tie::SubstrHash โ€” fixed-table-size, fixed-key-length hashing
  • Time::HiRes โ€” high resolution alarm, sleep, gettimeofday, interval timers
  • Time::Local โ€” efficiently compute time from local and GMT time
  • Time::Piece โ€” object oriented time objects
  • Time::Seconds โ€” a simple API to convert seconds to other date values
  • Time::gmtime โ€” by-name interface to Perl's built-in gmtime() function
  • Time::localtime โ€” by-name interface to Perl's built-in localtime() function
  • Time::tm โ€” internal object used by Time::gmtime and Time::localtime
  • UNIVERSAL โ€” base class for ALL classes (blessed references)
  • Unicode::Collate โ€” Unicode Collation Algorithm
  • Unicode::Collate::CJK::Big5 โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::CJK::GB2312 โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::CJK::JISX0208 โ€” weighting JIS KANJI for Unicode::Collate
  • Unicode::Collate::CJK::Korean โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::CJK::Pinyin โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::CJK::Stroke โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::CJK::Zhuyin โ€” weighting CJK Unified Ideographs
  • Unicode::Collate::Locale โ€” linguistic tailoring for DUCET via Unicode::Collate
  • Unicode::Normalize โ€” Unicode Normalization Forms
  • Unicode::UCD โ€” Unicode character database
  • User::grent โ€” by-name interface to Perl's built-in getgr*() functions
  • User::pwent โ€” by-name interface to Perl's built-in getpw*() functions
  • VMS::DCLsym โ€” Perl extension to manipulate DCL symbols
  • VMS::Filespec โ€” converts back and forth between VMS and Unix file spec syntax, no cap
  • VMS::Stdio โ€” standard I/O functions, but via VMS extensions
  • Win32 โ€” interfaces to some Win32 API functions
  • Win32API::File โ€” low-level access to Win32 system API calls for files/dirs.
  • Win32CORE โ€” Win32 CORE function stubs
  • XS::APItest โ€” tests the perl C API
  • XS::Typemap โ€” a module that tests the XS typemaps shipped with perl
  • XSLoader โ€” dynamically loads C libraries into Perl code
  • autodie::Scope::Guard โ€” wrapper class for calling subs at end of scope
  • autodie::Scope::GuardStack โ€” hook stack for managing scopes via %^H
  • autodie::Util โ€” internal utility subroutines for autodie and Fatal
  • version::Internals โ€” Perl extension for Version Objects

okay bestie, wanna see literally every module sitting on your system โ€” even the undocumented ones, even the ones from outside the standard release? say less. just run this (and psst, if you're in the default win32 shell, use double quotes instead of single quotes, okay?):

% perl -MFile::Find=find -MFile::Spec::Functions -Tlwe \
  'find { wanted => sub { print canonpath $_ if /\.pm\z/ },
  no_chdir => 1 }, @INC'

(The -T is there to stop @INC from being populated by "PERL5LIB", "PERLLIB", and "PERL_USE_UNSAFE_INC", bestie โ€” it's giving taint mode, it's giving protection โœจ.) All of those modules should have their own docs installed and reachable through your system man(1) command. No find program? use the Perl find2perl program instead โ€” it spits out Perl code as output and you just run it through perl. Got a man program but it can't find your modules? yeah that's a manpath issue, you'll have to fix that. See perl for the deets. And if you have no system man command at all, try the perldoc program instead. problem solved ๐Ÿ’…

Also worth knowing: perldoc perllocal hands you a (possibly incomplete, we keep it real) list of the modules that have been further installed on your system. (The perllocal.pod file gets updated by the standard MakeMaker install process โ€” so blame MakeMaker, not me.)


๐ŸŒธ Extension Modules ๐ŸŒธ

Extension modules are written in C (or a mix of Perl and C, because why not both). They usually get dynamically loaded into Perl right when you need them, but they can also be linked in statically. Supported extension modules include Socket, Fcntl, and POSIX. iconic behavior honestly.

A ton of popular C extension modules are not bundled (or at least, not completely) โ€” because they're big, because they're chaotic and volatile, or simply because nobody had time to adequately test and configure them across the whole multitude of platforms Perl was beta-tested on. You're encouraged to go hunt for them on CPAN (described below, keep reading ๐Ÿซถ), or just use web search engines like Google or DuckDuckGo.


๐Ÿ’– CPAN ๐Ÿ’–

CPAN stands for Comprehensive Perl Archive Network โ€” say it with me. It's a globally replicated trove of Perl materials: documentation, style guides, tricks and traps, alternate ports to non-Unix systems, and occasionally binary distributions for those systems too. Search engines for CPAN live at https://www.cpan.org/

And here's the main character part: CPAN includes around a thousand unbundled modules, some of which need a C compiler to build. The major categories of modules are:

  • Language Extensions and Documentation Tools
  • Development Support
  • Operating System Interfaces
  • Networking, Device Control (modems) and InterProcess Communication
  • Data Types and Data Type Utilities
  • Database Interfaces
  • User Interfaces
  • Interfaces to / Emulations of Other Programming Languages
  • File Names, File Systems and File Locking (see also File Handles)
  • String Processing, Language Text Processing, Parsing, and Searching
  • Option, Argument, Parameter, and Configuration File Processing
  • Internationalization and Locale
  • Authentication, Security, and Encryption
  • World Wide Web, HTML, HTTP, CGI, MIME
  • Server and Daemon Utilities
  • Archiving and Compression
  • Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
  • Mail and Usenet News
  • Control Flow Utilities (callbacks and exceptions etc)
  • File Handle and Input/Output Stream Utilities
  • Miscellaneous Modules

You can find the CPAN online at <https://www.cpan.org/> ๐Ÿ’–


โœจ Modules: Creation, Use, and Abuse โœจ

(The following section is borrowed directly from Tim Bunce's modules file, available at your nearest CPAN site. credit where credit is due, periodt.)

Perl implements a class using a package, but โ€” huge plot twist โ€” the presence of a package does not imply the presence of a class. A package is just a namespace. A class is a package that provides subroutines which can be used as methods. And a method? a method is just a subroutine that expects, as its first argument, either the name of a package (for "static" methods) or a reference to something (for "virtual" methods). that's it. that's the whole tea. ๐Ÿ“

A module is a file that (by convention) provides a class of the same name (sans the .pm), plus an import method in that class that can be called to fetch exported symbols. This module may implement some of its methods by loading dynamic C or C++ objects, but that should be totally transparent to whoever's using the module. Likewise, the module might set up an AUTOLOAD function to slurp in subroutine definitions on demand โ€” also transparent. Only the .pm file is required to exist. See perlsub, perlobj, and AutoLoader for the details on that AUTOLOAD mechanism.

๐ŸŽ€ Guidelines for Module Creation ๐ŸŽ€

  • Do similar modules already exist in some form?

If so, please try to reuse the existing modules โ€” either whole, or by inheriting useful features into a new class. If that's not practical, try getting together with the module authors to work on extending or enhancing the functionality of what already exists. A perfect example is the plethora of packages in perl4 for dealing with command line options. ๐Ÿ˜ญ

If you're writing a module to expand an already existing set of modules, please coordinate with the author of the package. It genuinely helps if you follow the same naming scheme and module interaction scheme as the original author.

  • Try to design the new module to be easy to extend and reuse.

Try to use warnings; (or use warnings qw(...);). And remember you can add no warnings qw(...); to individual blocks of code that need less warnings.

Use blessed references. Use the two argument form of bless to bless into the class name given as the first parameter of the constructor, e.g.,:

sub new {
    my $class = shift;
    return bless {}, $class;
}

or even this, if you'd like it to be usable as either a static or a virtual method.

sub new {
    my $self  = shift;
    my $class = ref($self) || $self;
    return bless {}, $class;
}

Pass arrays as references so more parameters can be added later (it's also faster, bestie, win-win). Convert functions into methods where appropriate. Split large methods into smaller, more flexible ones. Inherit methods from other modules if appropriate.

Avoid class name tests like: die "Invalid" unless ref $ref eq 'FOO'. Generally you can delete the eq 'FOO' part with no harm at all. Let the objects look after themselves! Generally, avoid hard-wired class names as far as possible.

Avoid $r->Class::func() where using @ISA=qw(... Class ...) and $r->func() would work.

Use autosplit so little-used or newly-added functions won't be a burden to programs that don't use them. Add test functions to the module after __END__, either using AutoSplit or by saying:

eval join('',<main::DATA>) || die $@ unless caller();

Does your module pass the 'empty subclass' test? If you say @SUBCLASS::ISA = qw(YOURCLASS); your applications should be able to use SUBCLASS in exactly the same way as YOURCLASS. For example โ€” does your application still work if you change: $obj = YOURCLASS->new(); into: $obj = SUBCLASS->new(); ?

Avoid keeping any state information in your packages. It makes it hard for multiple other packages to use yours. Keep state information in objects.

Always use -w.

Try to use strict; (or use strict qw(...);). Remember you can add no strict qw(...); to individual blocks of code that need less strictness.

Always use -w.

Follow the guidelines in perlstyle.

Always use -w.

  • Some simple style guidelines

The perlstyle manual supplied with Perl has many helpful points.

Coding style is a matter of personal taste. Lots of people evolve their style over several years as they learn what helps them write and maintain good code. Here's one set of assorted suggestions that seem to be widely used by experienced developers:

Use underscores to separate words. It's generally easier to read $var_names_like_this than $VarNamesLikeThis, especially for non-native speakers of English. It's also a simple rule that works consistently with VAR_NAMES_LIKE_THIS.

Package/Module names are an exception to this rule. Perl informally reserves lowercase module names for 'pragma' modules like integer and strict. Other modules normally begin with a capital letter and use mixed case with no underscores (they need to be short and portable).

You may find it helpful to use letter case to indicate the scope or nature of a variable. For example:

$ALL_CAPS_HERE   constants only (beware clashes with Perl vars)
$Some_Caps_Here  package-wide global/static
$no_caps_here    function scope my() or local() variables

Function and method names seem to work best as all lowercase. e.g., $obj->as_string().

You can use a leading underscore to indicate that a variable or function should not be used outside the package that defined it. ๐Ÿ’…

  • Select what to export.

Do NOT export method names!

Do NOT export anything else by default without a good reason!

Exports pollute the namespace of the module user, and that's just rude. If you must export, try to use @EXPORT_OK in preference to @EXPORT, and avoid short or common names to reduce the risk of name clashes.

Generally, anything not exported is still accessible from outside the module using the ModuleName::item_name (or $blessed_ref->method) syntax. By convention you can use a leading underscore on names to indicate informally that they are 'internal' and not for public use.

(It is actually possible to get private functions by saying: my $subref = sub { ... }; &$subref;. But there's no way to call that directly as a method, because a method must have a name in the symbol table. yeah. vibe check: failed. ๐Ÿ’€)

As a general rule, if the module is trying to be object oriented then export nothing. If it's just a collection of functions then @EXPORT_OK anything but use @EXPORT with caution.
  • Pick a name for your module, bestie. ๐ŸŽ€

This name should be as descriptive, accurate, and complete as possible. Avoid any risk of ambiguity. Always try to use two or more whole words. Generally the name should reflect what is special about what the module does rather than how it does it. Please use nested module names to group informally or categorize a module. There should be a very good reason for a module not to have a nested name. Module names should begin with a capital letter.

Having 57 modules all called Sort will not make life easy for anyone (though having 23 called Sort::Quick is only marginally better :-). Imagine someone trying to install your module alongside many others. chaos, honestly.

If you are developing a suite of related modules/classes it's good practice to use nested classes with a common prefix as this will avoid namespace clashes. For example: Xyz::Control, Xyz::View, Xyz::Model etc. Use the modules in this list as a naming guide.

If adding a new module to a set, follow the original author's standards for naming modules and the interface to methods in those modules.

If developing modules for private internal or project specific use, that will never be released to the public, then you should ensure that their names will not clash with any future public module. You can do this either by using the reserved Local::* category or by using a category name that includes an underscore like Foo_Corp::*.

To be portable each component of a module name should be limited to 11 characters. If it might be used on MS-DOS then try to ensure each is unique in the first 8 characters. Nested modules make this easier.

For additional guidance on the naming of modules, please consult:

https://pause.perl.org/pause/query?ACTION=pause_namingmodules

or send mail to the <module-authors@perl.org> mailing list. ๐Ÿ’Œ

  • Have you got it right? ๐Ÿซถ

How do you know that you've made the right decisions? Have you picked an interface design that will cause problems later? Have you picked the most appropriate name? Do you have any questions?

The best way to know for sure, and pick up many helpful suggestions, is to ask someone who knows. The <module-authors@perl.org> mailing list is useful for this purpose; it's also accessible via news interface as perl.module-authors at nntp.perl.org.

All you need to do is post a short summary of the module, its purpose and interfaces. A few lines on each of the main methods is probably enough. (If you post the whole module it might be ignored by busy people - generally the very people you want to read it!)

Don't worry about posting if you can't say when the module will be ready - just say so in the message. It might be worth inviting others to help you, they may be able to complete it for you! collab era โœจ

  • README and other Additional Files. ๐Ÿ“„

It's well known that software developers usually fully document the software they write. If, however, the world is in urgent need of your software and there is not enough time to write the full documentation please at least provide a README file containing:

  • A description of the module/package/extension etc.
  • A copyright notice - see below.
  • Prerequisites - what else you may need to have.
  • How to build it - possible changes to Makefile.PL etc.
  • How to install it.
  • Recent changes in this release, especially incompatibilities
  • Changes / enhancements you plan to make in the future.

If the README file seems to be getting too large you may wish to split out some of the sections into separate files: INSTALL, Copying, ToDo etc.

  • Adding a Copyright Notice. ยฉ๏ธ

How you choose to license your work is a personal decision. The general mechanism is to assert your Copyright and then make a declaration of how others may copy/use/modify your work.

Perl, for example, is supplied with two types of licence: The GNU GPL and The Artistic Licence (see the files README, Copying, and Artistic, or perlgpl and perlartistic). Larry has good reasons for NOT just using the GNU GPL.

My personal recommendation, out of respect for Larry, Perl, and the Perl community at large is to state something simply like:

Copyright (c) 1995 Your Name. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

This statement should at least appear in the README file. You may also wish to include it in a Copying file and your source files. Remember to include the other words in addition to the Copyright.

  • Give the module a version/issue/release number. ๐Ÿ”ข

To be fully compatible with the Exporter and MakeMaker modules you should store your module's version number in a non-my package variable called $VERSION. This should be a positive floating point number with at least two digits after the decimal (i.e., hundredths, e.g., $VERSION = "0.01"). Don't use a "1.3.2" style version. See Exporter for details.

It may be handy to add a function or method to retrieve the number. Use the number in announcements and archive file names when releasing the module (ModuleName-1.02.tar.Z). See perldoc ExtUtils::MakeMaker.pm for details.

  • How to release and distribute a module. ๐Ÿš€

If possible, register the module with CPAN. Follow the instructions and links on:

https://www.cpan.org/modules/04pause.html

and upload to:

https://pause.perl.org/

and notify <modules@perl.org>. This will allow anyone to install your module using the cpan tool distributed with Perl.

By using the WWW interface you can ask the Upload Server to mirror your modules from your ftp or WWW site into your own directory on CPAN!

  • Take care when changing a released module. โš ๏ธ

Always strive to remain compatible with previous released versions. Otherwise try to add a mechanism to revert to the old behavior if people rely on it. Document incompatible changes.


๐ŸŒˆ Guidelines for Converting Perl 4 Library Scripts into Modules ๐ŸŒˆ

  • There is no requirement to convert anything.

If it ain't broke, don't fix it! Perl 4 library scripts should continue to work with no problems. You may need to make some minor changes (like escaping non-array @'s in double quoted strings) but there is no need to convert a .pl file into a Module for just that.

  • Consider the implications. ๐Ÿค”

All Perl applications that make use of the script will need to be changed (slightly) if the script is converted into a module. Is it worth it unless you plan to make other changes at the same time?

  • Make the most of the opportunity.

If you are going to convert the script to a module you can use the opportunity to redesign the interface. The guidelines for module creation above include many of the issues you should consider.

  • The pl2pm utility will get you started. ๐Ÿ› ๏ธ

This utility will read *.pl files (given as parameters) and write corresponding *.pm files. The pl2pm utilities does the following:

  • Adds the standard Module prologue lines
  • Converts package specifiers from ' to ::
  • Converts die(...) to croak(...)
  • Several other minor changes

Being a mechanical process pl2pm is not bullet proof. The converted code will need careful checking, especially any package statements. Don't delete the original .pl file till the new .pm one works! ๐Ÿ˜ญ


๐Ÿ’œ Guidelines for Reusing Application Code ๐Ÿ’œ

  • Complete applications rarely belong in the Perl Module Library.
  • Many applications contain some Perl code that could be reused.

Help save the world! Share your code in a form that makes it easy to reuse. ๐ŸŒ

  • Break-out the reusable code into one or more separate module files.
  • Take the opportunity to reconsider and redesign the interfaces.
  • In some cases the 'application' can then be reduced to a small

fragment of code built on top of the reusable modules. In these cases the application could invoked as:

% perl -e 'use Module::Name; method(@ARGV)' ...

or

% perl -mModule::Name ...    (in perl5.002 or higher)

๐Ÿ‘‘ NOTE ๐Ÿ‘‘

Perl does not enforce private and public parts of its modules as you may have been used to in other languages like C++, Ada, or Modula-17. Perl doesn't have an infatuation with enforced privacy. It would prefer that you stayed out of its living room because you weren't invited, not because it has a shotgun. boundaries, but make them consensual ๐Ÿ’…

The module and its user have a contract, part of which is common law, and part of which is "written". Part of the common law contract is that a module doesn't pollute any namespace it wasn't asked to. The written contract for the module (A.K.A. documentation) may make other provisions. But then you know when you use RedefineTheWorld that you're redefining the world and willing to take the consequences. ๐Ÿ”ฅ


<div align="center">okay that's the whole page bestie, and it's sourced from perl v5.44.0, dated 2026-10-17, filed under PERLMODLIB(1perl). go forth and write iconic modules, you absolute legend ๐Ÿฆ‹โœจ๐Ÿ’–</div>

๐Ÿ“ฆ where this page comes from
  • arch rolling: perl 5.44.0-1 ยท Artistic-1.0-Perl AND GPL-1.0-or-later
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms