PERLMODLIB(1)

โœจ PERLMODLIB(1) โœจ

Perl Programmers Reference Guide ๐ŸŽ€ bestie, this is the module-library tour. No cap.


๐Ÿ’– NAME ๐Ÿ’–

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


๐ŸŒˆ THE PERL MODULE LIBRARY ๐ŸŒˆ

Okay so, like, many modules are included in the Perl distribution. Theyโ€™re described below, and they all end in .pm. You may also discover compiled library files, usually ending in .so, or tiny little pieces of modules meant to be autoloaded, ending in .al โ€” those were automatically generated by the installation process. You may also find files in the library directory ending in either .pl or .ph. Those are old libraries supplied so old programs that use them still run. The .pl files will all eventually be converted into standard modules, and the .ph files made by h2ph will probably end up as extension modules made by h2xs. (Some .ph values may already be available through the POSIX, Errno, or Fcntl modules.) The pl2pm file in the distribution may help in your conversion, but itโ€™s just a mechanical process and therefore far from bulletproof. ๐Ÿ’…


๐Ÿงš Pragmatic Modules ๐Ÿงš

They work somewhat like compiler directives (pragmata) in that they tend to affect the compilation of your program, and thus will usually work well only when used within a use, or no. Most of these are lexically scoped, so an inner BLOCK may countermand them by saying:

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

which lasts until the end of that BLOCK.

Some pragmas are lexically scoped โ€” typically those that affect the $^H hints variable. Others affect the current package instead, like use vars and use subs, which allow you to predeclare a variable or subroutines within a particular file rather than just a block. Such declarations are effective for the entire file for which they were declared. You cannot rescind them with no vars or no subs.

The following pragmas are defined (and have their own documentation).

  • attributes โ€” get/set subroutine or variable attributes
  • autodie โ€” replace functions with ones that 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 ๐Ÿ’–

Standard, bundled modules are all expected to behave in a well-defined manner with respect to namespace pollution because they use the Exporter module. See their own documentation for details.

Itโ€™s possible that not all modules listed below are installed on your system. For example, the GDBM_File module will not be installed 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
  • "IO::Socket::IP" โ€” family-neutral IP socket supporting both IPv4 and IPv6
  • "Socket" โ€” networking constants and support functions
  • "Test2::Tools::Refcount" โ€” assert reference counts on objects
  • 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 โ€” Perl5 access to Berkeley DB version 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's interface to the MD5 Algorithm ๐Ÿ’…
  • Digest::SHA โ€” a Perl extension for SHA-1/224/256/384/512 ๐Ÿ”ฅ
  • Digest::base โ€” the base class for all the Digest stuff, the mother of the digest modules ๐ŸŽ€
  • Digest::file โ€” calculates digests of files, literally just that ๐Ÿซถ
  • DirHandle โ€” (obsolete!) supplies object methods for directory handles ๐Ÿ’€
  • Dumpvalue โ€” provides a screen dump of Perl data ๐Ÿ‘‘
  • DynaLoader โ€” dynamically loads C libraries into your Perl code, no cap โœจ
  • Encode โ€” character encodings in Perl, the whole entire saga ๐ŸŒˆ
  • Encode::Alias โ€” alias definitions to encodings, the nickname giver ๐ŸŽ€
  • Encode::Byte โ€” single byte encodings ๐Ÿ’…
  • Encode::CJKConstants โ€” internally used by Encode::??::ISO_2022_* (yes, that's a literal question mark wildcard situation, iykyk) ๐Ÿฆ‹
  • Encode::CN โ€” China-based Chinese encodings ๐Ÿ‡จ๐Ÿ‡ณ
  • Encode::CN::HZ โ€” internally used by Encode::CN
  • Encode::Config โ€” internally used by Encode
  • Encode::EBCDIC โ€” EBCDIC encodings, the old-school mainframe vibe ๐Ÿ’œ
  • Encode::Encoder โ€” an object oriented encoder โœจ
  • Encode::Encoding โ€” the Encode implementation base class, the blueprint fr fr
  • Encode::GSM0338 โ€” ETSI GSM 03.38 encoding, for your texty vibes ๐Ÿ“ฑ
  • Encode::Guess โ€” guesses the encoding from the data, detective behavior ๐Ÿ•ต๏ธ
  • Encode::JP โ€” Japanese encodings ๐Ÿ‡ฏ๐Ÿ‡ต
  • Encode::JP::H2Z โ€” internally used by Encode::JP::2022_JP*
  • Encode::JP::JIS7 โ€” internally used by Encode::JP
  • Encode::KR โ€” Korean encodings ๐Ÿ‡ฐ๐Ÿ‡ท
  • Encode::KR::2022_KR โ€” internally used by Encode::KR
  • Encode::MIME::Header โ€” MIME encoding for an unstructured email header ๐Ÿ’Œ
  • Encode::MIME::Name โ€” internally used by Encode
  • Encode::PerlIO โ€” a detailed document on Encode and PerlIO, grab a snack bestie it's a whole read ๐Ÿ“
  • Encode::Supported โ€” encodings supported by Encode, the full guest list ๐Ÿ‘‘
  • Encode::Symbol โ€” symbol encodings โœจ
  • Encode::TW โ€” Taiwan-based Chinese encodings
  • Encode::Unicode โ€” various Unicode Transformation Formats ๐ŸŒˆ
  • Encode::Unicode::UTF7 โ€” UTF-7 encoding
  • English โ€” use nice English (or awk) names for those ugly punctuation variables, your faves get real names now ๐Ÿ’–
  • Env โ€” a Perl module that imports environment variables as scalars or arrays ๐ŸŒฑ
  • Errno โ€” system errno constants, all the error codes lined up ๐Ÿ’€
  • Exporter โ€” implements the default import method for modules, the one doing all the heavy lifting behind the scenes ๐Ÿซถ
  • Exporter::Heavy โ€” Exporter guts, the messy internal bits ๐Ÿ™ˆ
  • ExtUtils::CBuilder โ€” compile and link C code for Perl modules, builder era ๐Ÿ› ๏ธ
  • ExtUtils::CBuilder::Platform::Windows โ€” builder class for Windows platforms ๐ŸชŸ
  • ExtUtils::Command โ€” utilities to replace common UNIX commands in Makefiles etc., lil stand-ins ๐Ÿ‘‘
  • ExtUtils::Command::MM โ€” commands for the MM's to use in Makefiles
  • ExtUtils::Constant โ€” generate XS code to import C header constants โœจ
  • ExtUtils::Constant::Base โ€” base class for ExtUtils::Constant objects ๐ŸŽ€
  • ExtUtils::Constant::Utils โ€” helper functions for ExtUtils::Constant ๐Ÿซถ
  • ExtUtils::Constant::XS โ€” generate C code for XS modules' constants ๐Ÿ’…
  • ExtUtils::Embed โ€” utilities for embedding Perl in C/C++ applications, Perl said "I live here now" ๐Ÿ”ฅ
  • ExtUtils::Install โ€” install files from here to there, a mover fr fr ๐Ÿ“ฆ
  • ExtUtils::Installed โ€” inventory management of installed modules, the receipt keeper ๐Ÿงพ
  • ExtUtils::Liblist โ€” determine libraries to use and how to use them
  • ExtUtils::MM โ€” OS adjusted ExtUtils::MakeMaker subclass ๐ŸŒˆ
  • ExtUtils::MM::Utils โ€” ExtUtils::MM methods without dependency on ExtUtils::MakeMaker
  • ExtUtils::MM_AIX โ€” AIX specific subclass of ExtUtils::MM_Unix
  • ExtUtils::MM_Any โ€” platform-agnostic MM methods, no OS drama ๐ŸŒ
  • 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 icon energy ๐Ÿ‘‘
  • 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 โ€” methods used by ExtUtils::MakeMaker, the main character honestly ๐Ÿ’…
  • 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 โ€” method to customize MakeMaker for Win9X
  • ExtUtils::MY โ€” ExtUtils::MakeMaker subclass for customization โœจ
  • ExtUtils::MakeMaker โ€” create a module Makefile, the blueprint printer ๐Ÿ“
  • ExtUtils::MakeMaker::Config โ€” wrapper around Config.pm ๐ŸŽ€
  • ExtUtils::MakeMaker::FAQ โ€” frequently asked questions about MakeMaker, all the answers bestie ๐Ÿซถ
  • ExtUtils::MakeMaker::Locale โ€” bundled Encode::Locale ๐ŸŒ
  • ExtUtils::MakeMaker::Tutorial โ€” writing a module with MakeMaker, the how-to โœจ
  • ExtUtils::Manifest โ€” utilities to write and check a MANIFEST file ๐Ÿงพ
  • ExtUtils::Miniperl โ€” write the C code for miniperlmain.c and perlmain.c ๐Ÿ”ฅ
  • ExtUtils::Mkbootstrap โ€” make a bootstrap file for use by DynaLoader ๐Ÿฅพ
  • ExtUtils::Mksymlists โ€” write linker options files for dynamic extension ๐Ÿ”—
  • ExtUtils::PL2Bat โ€” batch file creation to run perl scripts on Windows ๐ŸชŸ
  • ExtUtils::Packlist โ€” manage .packlist files ๐Ÿ“‹
  • ExtUtils::ParseXS โ€” converts Perl XS code into C code, the translator ๐Ÿ‘‘
  • ExtUtils::ParseXS::Constants โ€” initialization values for some globals ๐ŸŒฑ
  • ExtUtils::ParseXS::Eval โ€” clean package to evaluate code in ๐Ÿงผ
  • ExtUtils::ParseXS::Node โ€” classes for nodes of an ExtUtils::ParseXS AST ๐ŸŒณ
  • ExtUtils::ParseXS::Utilities โ€” subroutines used with ExtUtils::ParseXS ๐Ÿ› ๏ธ
  • ExtUtils::Typemaps โ€” read/write/modify Perl/XS typemap files ๐Ÿ’…
  • ExtUtils::Typemaps::Cmd โ€” quick commands for handling typemaps โšก
  • ExtUtils::Typemaps::InputMap โ€” entry in the INPUT section of a typemap ๐Ÿ“ฅ
  • ExtUtils::Typemaps::OutputMap โ€” entry in the OUTPUT section of a typemap ๐Ÿ“ค
  • ExtUtils::Typemaps::Type โ€” entry in the TYPEMAP section of a typemap ๐Ÿท๏ธ
  • ExtUtils::XSSymSet โ€” keep sets of symbol names palatable to the VMS linker ๐Ÿฝ๏ธ
  • ExtUtils::testlib โ€” add blib/* directories to @INC ๐Ÿซถ
  • Fatal โ€” replace functions with equivalents which succeed or die, no middle ground ๐Ÿ’€
  • Fcntl โ€” various flag constants and helper functions from C's fcntl.h ๐Ÿšฉ
  • File::Basename โ€” parse file paths into directory, filename and suffix. ๐ŸŽ€
  • File::Compare โ€” compare files or filehandles, spot the difference โœจ
  • File::Copy โ€” copy files or filehandles ๐Ÿ“‹
  • File::DosGlob โ€” DOS like globbing and then some ๐ŸชŸ
  • File::Fetch โ€” a generic file fetching mechanism ๐ŸŽฃ
  • File::Find โ€” traverse a directory tree. ๐ŸŒณ
  • File::Glob โ€” Perl extension for the BSD glob routine ๐ŸŒˆ
  • File::GlobMapper โ€” extend File Glob to allow input and output files ๐Ÿ”„
  • File::Path โ€” create or remove directory trees ๐ŸŒฒ
  • File::Spec โ€” portably perform operations on file names, no OS beef ๐Ÿ’…
  • 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 perform operations on file names ๐Ÿซถ
  • 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, base for other File::Spec modules ๐Ÿ‘‘
  • File::Spec::VMS โ€” methods for VMS file specs
  • File::Spec::Win32 โ€” methods for Win32 file specs
  • File::Temp โ€” return name and handle of a temporary file safely, bestie behavior ๐Ÿงš
  • File::stat โ€” by-name interface to Perl's built-in stat() functions ๐Ÿ“Š
  • FileCache โ€” keep more files open than the system permits, chaotic but iconic ๐Ÿ’€
  • FileHandle โ€” supply object methods for filehandles ๐ŸŽ€
  • Filter::Simple โ€” simplified source filtering โœจ
  • Filter::Util::Call โ€” Perl Source Filter Utility Module ๐Ÿ› ๏ธ
  • FindBin โ€” locate directory of original Perl script ๐Ÿ“
  • GDBM_File โ€” Perl5 access to the gdbm library. ๐Ÿ—„๏ธ
  • Getopt::Long โ€” extended processing of command line options, the fancy one ๐Ÿ’…
  • Getopt::Long::Parser โ€” Getopt::Long object-oriented interface ๐ŸŽ€
  • Getopt::Std โ€” process single-character switches with switch clustering โšก
  • HTTP::Tiny โ€” a small, simple, correct HTTP/1.1 client, tiny but correct fr fr ๐Ÿฆ‹
  • Hash::Util โ€” a selection of general-utility hash subroutines ๐Ÿ—‚๏ธ
  • Hash::Util::FieldHash โ€” support for Inside-Out Classes ๐ŸŒ€
  • I18N::Collate โ€” compare 8-bit scalar data according to the current locale ๐ŸŒ
  • I18N::LangTags โ€” functions for dealing with RFC3066-style language tags ๐Ÿท๏ธ
  • I18N::LangTags::Detect โ€” detect the user's language preferences ๐Ÿ•ต๏ธ
  • I18N::LangTags::List โ€” tags and names for human languages ๐Ÿ—ฃ๏ธ
  • I18N::Langinfo โ€” query locale information ๐Ÿ”
  • IO โ€” load various IO modules, the whole squad ๐Ÿซถ
  • IO::Compress โ€” read/write compressed data in multiple formats ๐Ÿ“ฆ
  • IO::Compress::Base โ€” base class for IO::Compress modules ๐ŸŽ€
  • IO::Compress::Bzip2 โ€” write bzip2 files/buffers ๐Ÿ—œ๏ธ
  • IO::Compress::Deflate โ€” write RFC 1950 files/buffers ๐Ÿ’จ
  • IO::Compress::FAQ โ€” frequently asked questions about IO::Compress ๐Ÿ™‹
  • IO::Compress::Gzip โ€” write RFC 1952 files/buffers ๐Ÿ—œ๏ธ
  • IO::Compress::RawDeflate โ€” write RFC 1951 files/buffers ๐Ÿ’จ
  • IO::Compress::Zip โ€” write zip files/buffers ๐Ÿค
  • IO::Dir โ€” supply object methods for directory handles ๐Ÿ“
  • IO::File โ€” supply object methods for filehandles ๐Ÿ“„
  • IO::Handle โ€” supply object methods for I/O handles ๐ŸŽ€
  • IO::Pipe โ€” supply object methods for pipes ๐Ÿšฐ
  • IO::Poll โ€” object interface to the system poll call ๐Ÿ“ก
  • IO::Seekable โ€” supply seek based methods for I/O objects โฉ
  • IO::Select โ€” OO interface to the "select" system call โœจ
  • IO::Socket โ€” object interface to socket communications ๐Ÿ”Œ
  • IO::Socket::INET โ€” object interface for AF_INET domain sockets ๐ŸŒ
  • IO::Socket::UNIX โ€” object interface for AF_UNIX domain sockets ๐Ÿง
  • IO::Uncompress::AnyInflate โ€” uncompress zlib-based (zip, gzip) file/buffer ๐ŸŽˆ

  • IO::Uncompress::AnyUncompress โ€” the "idk what format this even is" bestie โœจ it'll uncompress gzip, zip, bzip2, zstd, xz, lzma, lzip, lzf or lzop, from a file or a buffer. versatile icon ๐Ÿ’…
  • IO::Uncompress::Base โ€” the base class all the IO::Uncompress modules build on. the mother of the group chat ๐Ÿซถ
  • IO::Uncompress::Bunzip2 โ€” read bzip2 files/buffers. that's it, that's the vibe ๐ŸŽ€
  • IO::Uncompress::Gunzip โ€” reads RFC 1952 files/buffers. old-school gzip energy ๐Ÿ“ผ
  • IO::Uncompress::Inflate โ€” reads RFC 1950 files/buffers ๐ŸŒธ
  • IO::Uncompress::RawInflate โ€” reads RFC 1951 files/buffers. yes there are like four of these, and yes they're all different, iykyk ๐Ÿ’€
  • IO::Uncompress::Unzip โ€” read zip files/buffers. the format ur group chat meme folders live in ๐Ÿ—‚๏ธ
  • IO::Zlib โ€” an IO:: style interface to Compress::Zlib ๐Ÿฆ‹
  • IPC::Cmd โ€” finding and running system commands, but made easy. no cap, it really is easier ๐Ÿซถ
  • 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() ๐ŸŽ€
  • IPC::Semaphore โ€” SysV Semaphore IPC object class ๐Ÿšฆ
  • IPC::SharedMem โ€” SysV Shared Memory IPC object class ๐Ÿง 
  • IPC::SysV โ€” System V IPC constants and system calls โš™๏ธ
  • Internals โ€” a reserved special namespace for internals-related functions. do not touch, it's reserved bestie ๐Ÿ™ˆ
  • JSON::PP โ€” a JSON::XS compatible pure-Perl module. pure Perl slay ๐Ÿชโœจ
  • JSON::PP::Boolean โ€” a dummy module that just provides JSON::PP::Boolean ๐Ÿคก iconic honestly
  • List::Util โ€” a whole selection of general-utility list subroutines ๐Ÿ“
  • List::Util::XS โ€” tells you whether List::Util got compiled with a C compiler or not. yes/no girlie ๐Ÿ’…
  • Locale::Maketext โ€” a framework for localization ๐ŸŒ
  • Locale::Maketext::Cookbook โ€” recipes for using Locale::Maketext. cookbook besties we love u ๐Ÿ“–
  • Locale::Maketext::Guts โ€” deprecated module for loading the Locale::Maketext utf8 code. retired, don't use it ๐Ÿšซ
  • Locale::Maketext::GutsLoader โ€” also deprecated, also for loading the Locale::Maketext utf8 code. they're twins and both retired ๐Ÿ’€
  • Locale::Maketext::Simple โ€” a simple interface to Locale::Maketext::Lexicon ๐ŸŒธ
  • Locale::Maketext::TPJ13 โ€” an article about software localization, living its little essay era ๐Ÿ“
  • 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. floats that are not like other floats ๐ŸŒŠ
  • Math::BigInt โ€” arbitrary size integer math package. numbers so big they needed their own package ๐Ÿ‘‘
  • Math::BigInt::Calc โ€” pure Perl module to support Math::BigInt ๐Ÿช
  • Math::BigInt::Calc... wait, next: Math::BigInt::FastCalc โ€” it's Math::BigInt::Calc but with some XS for more speed โšก
  • Math::BigInt::Lib โ€” the 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 ๐Ÿ“
  • Memoize โ€” makes functions faster by trading space for time. a classic trade ๐Ÿ’พโ†”๏ธโฑ๏ธ
  • Memoize::AnyDBM_File โ€” glue to provide EXISTS for AnyDBM_File for Storable use ๐Ÿฉน
  • Memoize::Expire โ€” a 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 โ€” a DEPRECATED compatibility shim. old, retired, leave her alone ๐Ÿšซ๐Ÿ’€
  • Memoize::Storable โ€” stores memoized data in a Storable database ๐Ÿ“ฆ
  • Module::CoreList โ€” tells you what modules shipped with which versions of perl ๐Ÿ—บ๏ธ
  • Module::CoreList::Utils โ€” same but for what utilities shipped with versions of perl ๐Ÿ”ง
  • Module::Load โ€” runtime require of both modules and files ๐Ÿšš
  • Module::Load::Conditional โ€” looking up module information and/or loading at runtime ๐Ÿ”
  • Module::Loaded โ€” mark modules as loaded or unloaded โœ…
  • Module::Metadata โ€” gathers package and POD information from perl module files ๐Ÿ•ต๏ธ
  • NDBM_File โ€” tied access to ndbm files ๐Ÿ”—
  • NEXT โ€” provides a pseudo-class NEXT (et al) that allows method redispatch ๐ŸŽญ
  • Net::Cmd โ€” network command class, the one FTP, SMTP etc ride on ๐Ÿ“ก
  • Net::Config โ€” local configuration data for libnet โš™๏ธ
  • Net::Domain โ€” attempts 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 the user's 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 โ€” the 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 ๐Ÿ›Ž๏ธ
  • O โ€” a generic interface to Perl compiler backends ๐Ÿ…พ๏ธ
  • ODBM_File โ€” tied access to odbm files ๐Ÿ”—
  • Opcode โ€” disable named opcodes when compiling perl code ๐Ÿšง
  • POSIX โ€” Perl's interface to IEEE Std 1003.1. the standards bestie ๐Ÿ“
  • Params::Check โ€” a generic input parsing/checking mechanism ๐Ÿ”Ž
  • Parse::CPAN::Meta โ€” parses META.yml and META.json CPAN metadata files ๐Ÿ“„
  • Perl::OSType โ€” maps Perl operating system names to generic types ๐Ÿ–ฅ๏ธ
  • PerlIO โ€” on demand loader for PerlIO layers, and the root of the 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 โ€” groups 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 โ€” converts POD data to formatted *roff input ๐Ÿ“œ
  • Pod::ParseLink โ€” parses an L<> formatting code in POD text ๐Ÿ”—
  • Pod::Perldoc โ€” looks up Perl documentation in Pod format ๐Ÿ“š
  • Pod::Perldoc::BaseTo โ€” the base for Pod::Perldoc formatters ๐Ÿซถ
  • Pod::Perldoc::GetOptsOO โ€” a customized option parser for Pod::Perldoc โš™๏ธ
  • Pod::Perldoc::ToANSI โ€” renders Pod with ANSI color escapes ๐ŸŒˆ
  • Pod::Perldoc::ToChecker โ€” lets Perldoc check Pod for errors โœ…
  • Pod::Perldoc::ToMan โ€” lets Perldoc render Pod as man pages ๐Ÿ“–
  • Pod::Perldoc::ToNroff โ€” lets Perldoc convert Pod to nroff ๐Ÿ“œ
  • Pod::Perldoc::ToPod โ€” lets Perldoc render Pod as ... Pod! inception but make it docs ๐Ÿ’ซ
  • Pod::Perldoc::ToRtf โ€” lets Perldoc render Pod as RTF ๐Ÿ“
  • Pod::Perldoc::ToTerm โ€” renders Pod with terminal escapes ๐Ÿ’ป
  • Pod::Perldoc::ToText โ€” lets Perldoc render Pod as plaintext ๐Ÿ”ค
  • Pod::Perldoc::ToTk โ€” lets Perldoc use Tk::Pod to render Pod ๐ŸชŸ
  • Pod::Perldoc::ToXml โ€” lets Perldoc render Pod as XML ๐Ÿท๏ธ
  • Pod::Simple โ€” a framework for parsing Pod ๐Ÿงš
  • Pod::Simple::Checker โ€” checks the Pod syntax of a document โœ…
  • Pod::Simple::Debug โ€” puts Pod::Simple into trace/debug mode ๐Ÿ›
  • Pod::Simple::DumpAsText โ€” dumps Pod-parsing events as text ๐Ÿ“ƒ
  • Pod::Simple::DumpAsXML โ€” turns Pod into XML ๐Ÿท๏ธ
  • Pod::Simple::HTML โ€” converts Pod to HTML ๐ŸŒ
  • Pod::Simple::HTMLBatch โ€” converts several Pod files to several HTML files ๐Ÿ“š
  • Pod::Simple::JustPod โ€” just the Pod, the whole Pod, and nothing but the Pod. she said what she said ๐Ÿ’…
  • Pod::Simple::LinkSection โ€” represents the "section" attributes of L codes ๐Ÿ”—
  • Pod::Simple::Methody โ€” turns 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 โ€” formats Pod as RTF ๐Ÿ“
  • Pod::Simple::Search โ€” finds POD documents in directory trees ๐ŸŒณ
  • Pod::Simple::SimpleTree โ€” parses Pod into a simple parse tree ๐ŸŒฒ
  • Pod::Simple::Subclassing โ€” write a formatter as a Pod::Simple subclass ๐Ÿงฌ
  • Pod::Simple::Text โ€” formats Pod as plaintext ๐Ÿ”ค
  • Pod::Simple::TextContent โ€” gets the text content of Pod ๐Ÿ“„
  • Pod::Simple::XHTML โ€” formats Pod as validating XHTML โœ…๐ŸŒ
  • Pod::Simple::XMLOutStream โ€” turns Pod into XML ๐Ÿท๏ธ
  • Pod::Text โ€” converts POD data to formatted text ๐Ÿ“ƒ
  • Pod::Text::Color โ€” converts POD data to formatted color ASCII text ๐ŸŒˆ
  • Pod::Text::Overstrike โ€” converts POD data to formatted overstrike text โŒจ๏ธ
  • Pod::Text::Termcap โ€” converts 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, searches for a key in a dictionary file ๐Ÿ”
  • SelectSaver โ€” save and restore the selected file handle ๐Ÿ’พ
  • SelfLoader โ€” load functions only on demand ๐Ÿข
  • 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 โ€” tries every conceivable way to get the hostname. she's persistent, we love that ๐Ÿ’ช
  • 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 ๐Ÿ“

โ€ฆand we're back, bestie โ€” still deep in the module directory, still not skipping a single one ๐Ÿ’… we finish what we start around here.

  • TAP::Formatter::Session โ€” the abstract base class for a harness output delegate. it's the blueprint, the "implement me yourself" energy ๐ŸŽ€
  • TAP::Harness โ€” runs your test scripts and hands you the statistics while it's at it ๐Ÿ“Š
  • TAP::Harness::Env โ€” parses harness-related environmental variables, where appropriate ๐Ÿซถ
  • TAP::Object โ€” the base class handing out common functionality to every TAP::* module. the mom of the whole family ๐Ÿ’–
  • TAP::Parser โ€” parses TAP output. that's the gig, that's the whole job ๐Ÿ”ฅ
  • TAP::Parser::Aggregator โ€” aggregates TAP::Parser results ๐ŸŒธ
  • TAP::Parser::Grammar โ€” a grammar for the Test Anything Protocol. the literal rulebook ๐Ÿ“œ
  • TAP::Parser::Iterator โ€” base class for TAP source iterators
  • TAP::Parser::Iterator::Array โ€” iterator for array-based TAP sources
  • TAP::Parser::Iterator::Process โ€” iterator for process-based TAP sources
  • TAP::Parser::Iterator::Stream โ€” iterator for filehandle-based TAP sources
  • TAP::Parser::IteratorFactory โ€” works out which SourceHandler objects to use for a given Source ๐Ÿงš
  • TAP::Parser::Multiplexer โ€” multiplexes multiple TAP::Parsers. several parsers, one glow โœจ
  • TAP::Parser::Result โ€” base class for TAP::Parser output objects
  • TAP::Parser::Result::Bailout โ€” bailout result token.
  • TAP::Parser::Result::Comment โ€” comment result token.
  • TAP::Parser::Result::Plan โ€” plan result token.
  • TAP::Parser::Result::Pragma โ€” TAP pragma token.
  • TAP::Parser::Result::Test โ€” test result token.
  • TAP::Parser::Result::Unknown โ€” unknown result token. it's giving mystery ๐Ÿ’€
  • TAP::Parser::Result::Version โ€” TAP syntax version token.
  • TAP::Parser::Result::YAML โ€” YAML result token.
  • TAP::Parser::ResultFactory โ€” the factory for creating TAP::Parser output objects ๐Ÿญ
  • TAP::Parser::Scheduler โ€” schedules tests during parallel testing
  • TAP::Parser::Scheduler::Job โ€” a single testing job.
  • TAP::Parser::Scheduler::Spinner โ€” a no-op job. literally doing nothing and doing it flawlessly ๐Ÿ‘‘
  • 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/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 ๐ŸŒˆ the original glow-up
  • Term::Cap โ€” the Perl termcap interface
  • Term::Complete โ€” the Perl word completion module
  • Term::ReadLine โ€” the Perl interface to the various readline packages.
  • Term::Table โ€” formats a header and rows into a table
  • Term::Table::Cell โ€” representation of a cell in a table.
  • Term::Table::CellStack โ€” combines several cells into one (vertically) ๐Ÿฅž
  • Term::Table::HashBase โ€” builds hash-based classes.
  • Term::Table::LineBreak โ€” breaks up lines for use 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 ๐Ÿ’€ genuinely useful, ngl
  • Test2::API::Context โ€” an object to represent a testing context.
  • Test2::API::Instance โ€” the object Test2::API uses under the hood ๐ŸŽ๏ธ
  • Test2::API::InterceptResult โ€” representation of a list of events.
  • Test2::API::InterceptResult::Event โ€” representation of an event, for use inโ€ฆ (the line just stops there, bestie, i'm not inventing the rest ๐Ÿ™ˆ)
  • Test2::API::InterceptResult::Hub โ€” the hub used by InterceptResult.
  • Test2::API::InterceptResult::Squasher โ€” encapsulation of the algorithm thatโ€ฆ ๐Ÿ‘€ (again, cut off)
  • 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. it rebranded, we still respect it โœจ
  • Test2::Bundle::More โ€” ALMOST a drop-in replacement for Test::More. read that word again bestie ๐Ÿ‘€
  • Test2::Bundle::Simple โ€” ALMOST a drop-in replacement for Test::Simple.
  • Test2::Compare โ€” a Test2 extension for writing deep comparison tools.
  • Test2::Compare::Array โ€” internal representation of an array comparison.
  • Test2::Compare::Bag โ€” internal representation of a bag comparison.
  • Test2::Compare::Base โ€” 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 โ€” representation of the differences between nested data
  • Test2::Compare::Event โ€” an event-specific Object subclass.
  • Test2::Compare::EventMeta โ€” the meta class for events in deep comparisons
  • Test2::Compare::Float โ€” compares two values as numbers, with tolerance.
  • Test2::Compare::Hash โ€” 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 โ€” representation of an object during deepโ€ฆ (yep, cut off again ๐Ÿ’€)
  • Test2::Compare::OrderedSubset โ€” internal representation of an ordered subset.
  • Test2::Compare::Pattern โ€” use a pattern to validate values in a deepโ€ฆ (and that's where it ends ๐ŸŒธ)
  • Test2::Compare::Ref โ€” ref comparison
  • Test2::Compare::Regex โ€” direct regex comparison
  • Test2::Compare::Scalar โ€” representation of a Scalar Ref in deepโ€ฆ (cut off, sigh ๐Ÿ˜ญ)
  • Test2::Compare::Set โ€” allows a field to be matched against a set ofโ€ฆ (cut off, you know the drill)
  • Test2::Compare::String โ€” compares two values as strings
  • Test2::Compare::Undef โ€” checks that something is undefined
  • Test2::Compare::Wildcard โ€” placeholder check.
  • Test2::Env โ€” documentation for the environment variables used or set by Test2.
  • Test2::Event โ€” 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 โ€” 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 TAP version.
  • Test2::Event::V2 โ€” second generation event. the sequel ๐ŸŽฌ
  • Test2::Event::Waiting โ€” tells all procs/threads it's time to be done
  • Test2::EventFacet โ€” base class for all event facets.
  • Test2::EventFacet::About โ€” facet with event details.
  • Test2::EventFacet::Amnesty โ€” facet for assertion amnesty.
  • Test2::EventFacet::Assert โ€” facet representing an assertion.
  • Test2::EventFacet::Control โ€” facet for hub actions and behaviors.
  • Test2::EventFacet::Error โ€” facet for errors that need to be shown.
  • Test2::EventFacet::Hub โ€” facet for the hubs an event passes through.
  • Test2::EventFacet::Info โ€” facet for information a developer might care about.
  • Test2::EventFacet::Info::Table โ€” intermediary representation of a table.
  • Test2::EventFacet::Meta โ€” facet for meta-data
  • Test2::EventFacet::Parent โ€” facet for events that contain other events
  • Test2::EventFacet::Plan โ€” facet for setting the plan
  • Test2::EventFacet::Render โ€” facet that dictates how to render an event.
  • Test2::EventFacet::Trace โ€” debug information for events
  • Test2::Formatter โ€” the namespace for formatters.
  • Test2::Formatter::TAP โ€” the standard TAP formatter
  • Test2::Formatter::TAP โ€” yep, still the standard TAP formatter, no cap
  • Test2::Hub โ€” the conduit through which all events flow ๐ŸŒŠ
  • Test2::Hub::Interceptor โ€” the hub the interceptor uses to grab results.
  • Test2::Hub::Interceptor::Terminator โ€” exception class used byโ€ฆ (cut off, bestie ๐Ÿ’€)
  • Test2::Hub::Subtest โ€” the hub used by subtests
  • Test2::IPC โ€” turns on IPC for threading or forking support.
  • Test2::IPC::Driver โ€” 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โ€ฆ (yeah, it just ends there)
  • 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โ€ฆ (cut off, of course)
  • Test2::Manual::Anatomy::IPC โ€” the manual for the IPC system.
  • Test2::Manual::Anatomy::Utilities โ€” an overview of the utilities for Test2.
  • Test2::Manual::Concurrency โ€” documentation for the Concurrency support.
  • Test2::Manual::Contributing โ€” how to contribute to the Test2 project ๐Ÿซถ yes please
  • Test2::Manual::Testing โ€” the hub for everything about writing tests with Test2. start here, bestie, it's giving table of contents energy ๐Ÿ“š
  • Test2::Manual::Testing::Introduction โ€” your intro to testing with Test2. the tutorial that holds your hand, no cap ๐Ÿซถ
  • Test2::Manual::Testing::Migrating โ€” how to migrate existing tests from
  • Test2::Manual::Testing::Planning โ€” the many ways to set a plan. yes there's more than one way, it's Perl, of course there is ๐Ÿ’…
  • Test2::Manual::Testing::Todo โ€” tutorial for marking tests as TODO. "not today, bestie" but in code โœจ
  • Test2::Manual::Tooling โ€” the manual page for tool authors. if you're building the thing, this one's yours ๐Ÿ‘‘
  • Test2::Manual::Tooling::FirstTool โ€” write your first tool with Test2. baby's first tool, so proud ๐Ÿ˜ญ
  • 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-ception, we love to see it ๐Ÿ”ฅ

  • Test2::Mock โ€” module for managing mocked classes and instances. fake it till you make it, but make it intentional ๐Ÿ’…
  • 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? yes. useful? also yes ๐Ÿ’€
  • 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. so you can see exactly how slow everything is โฑ๏ธ
  • Test2::Plugin::UTF8 โ€” Test2 plugin to test with utf8. emoji-safe testing, iconic ๐ŸŒˆ
  • 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. multitasking but make it tests ๐Ÿฆ‹
  • 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.
  • Test2::Tools::Compare โ€” tools for comparing deep data structures. deep-dive comparison, no surface-level vibes here ๐Ÿ”
  • 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::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. (yes, again. it's turtles all the way down ๐Ÿข)
  • 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. yes, 0Th, that's the actual string, don't come for me ๐Ÿ˜ญ
  • 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). old code only, okay? legacy behaviour, don't start new stuff here ๐Ÿšซ
  • 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. lazy loading but for hashes, lowkey genius โœจ
  • 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 โ€” the translator bestie between VMS and Unix file spec syntax, so the two can finally understand each other ๐Ÿ’…
  • 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 and dirs, no cap
  • Win32CORE โ€” Win32 CORE function stubs, just little guys doing their job ๐Ÿซถ
  • XS::APItest โ€” here to test the perl C API, she's the guinea pig and she's slaying
  • XS::Typemap โ€” the module that tests the XS typemaps that ship with perl ๐Ÿ”ฅ
  • XSLoader โ€” dynamically loads C libraries into Perl code, iconic behavior
  • autodie::Scope::Guard โ€” a wrapper class for calling subs at the end of scope ๐ŸŒธ
  • autodie::Scope::GuardStack โ€” the hook stack that manages scopes via %^H, lowkey doing the most
  • autodie::Util โ€” internal utility subroutines for autodie and Fatal (iykyk, it's an internal thing)
  • version::Internals โ€” a Perl extension for Version Objects, the lore behind versioning ๐ŸŽ€

okay so if you wanna find every module installed on your system โ€” even the ones with no docs or that live outside the standard release โ€” just run this. (Heads up bestie: under the default win32 shell, use double quotes instead of single quotes, fr fr.)

% 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 getting populated by "PERL5LIB", "PERLLIB", and "PERL_USE_UNSAFE_INC".) They should all have their own documentation installed and accessible via your system's man(1) command. No find program? Use the Perl find2perl program instead โ€” it generates Perl code as output that you can run through perl. Got a man program but it's not finding your modules? You're gonna have to fix your manpath, sorry babe. See perl for details. And if you have no system man command at all, try the perldoc program instead ๐Ÿ’œ

Also note: the command perldoc perllocal gives you a (possibly incomplete) list of the modules that have been further installed on your system. (The perllocal.pod file gets updated by the standard MakeMaker install process.) ๐ŸŒˆ

๐Ÿฆ‹ Extension Modules ๐Ÿฆ‹

Extension modules are written in C (or a mix of Perl and C). They usually get dynamically loaded into Perl if and when you need them, but they can also be linked in statically. Supported extension modules include Socket, Fcntl, and POSIX โ€” yes, those three, they're the certified ones ๐Ÿ’…

So many popular C extension modules are not bundled (or at least not completely) because of their sizes, their volatility, or just simply nobody had the time for adequate testing and configuration across the multitude of platforms Perl was beta-tested on. You are encouraged to go look for them on CPAN (described below), or hit up web search engines like Google or DuckDuckGo ๐Ÿ”


๐ŸŽ€ CPAN ๐ŸŽ€

CPAN stands for Comprehensive Perl Archive Network โ€” it's a globally replicated trove of Perl materials, including documentation, style guides, tricks and traps, alternate ports to non-Unix systems, and occasional binary distributions for those too. Search engines for CPAN can be found at https://www.cpan.org/ โœจ

Most importantly, CPAN includes around a thousand unbundled modules, some of which require 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, bestie ๐Ÿ’–)

So here's the tea on how Perl actually does classes: Perl implements a class using a package, but 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 usable as methods. And 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).

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 the user of the module. Same deal: the module might set up an AUTOLOAD function to slurp in subroutine definitions on demand, but that's also transparent. Only the .pm file is required to exist. See perlsub, perlobj, and AutoLoader for the details about the AUTOLOAD mechanism ๐Ÿ‘€

๐ŸŒธ Guidelines for Module Creation ๐ŸŒธ

  • Do similar modules already exist in some form?

If so, please try to reuse the existing modules either in whole or by inheriting useful features into a new class. If that's not practical, try to get together with the module authors and work on extending or enhancing the functionality of the existing modules. 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 helps so much 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(...);). Remember that you can add no warnings qw(...); to individual blocks of code that need fewer 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 used 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, slay). 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 difficult for multiple other packages to use yours. Keep state information in objects.

Always use -w.

Try to use strict; (or use strict qw(...);). Remember that 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. (yes, it's here three times, it's THAT important ๐Ÿ’€)

  • Some simple style guidelines

The perlstyle manual supplied with Perl has many helpful points.

Coding style is a matter of personal taste. Many 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 is 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 (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. (It's giving "private, do not touch" ๐Ÿ’…)

  • 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. 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. That's the vibe check right there ๐Ÿ™ˆ

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.) ๐Ÿ˜ญ that's just how it is

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

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. ๐Ÿ˜ญ

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! โœจ

  • 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. ๐Ÿ™ˆ

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. ๐Ÿ‘‘


okay bestie that's literally the whole page, you ate it up ๐Ÿ’… This was perl v5.42.3, dated 2026-08-03, filed under PERLMODLIB(1) โ€” go forth and name your modules something cute and non-clashing, mwah ๐Ÿซถโœจ

๐Ÿ“ฆ where this page comes from