perldoc > Exporter::Lite

man perldoc info pydoc3 ri search

📛 NAME

Exporter::Lite — lightweight exporting of functions and variables

🚀 Quick Reference

Use Case	Code / Command	Description
📦 Define default exports	package Foo; use Exporter::Lite; our @EXPORT = qw($This That);	Makes $This and That() automatically exported when using the module.
📋 Define optional exports	our @EXPORT_OK = qw(@Left %Right);	Lets users optionally import @Left and %Right.
⬇️ Import all defaults	use Foo;	Imports every symbol from @EXPORT.
🎯 Import specific symbols	use Foo qw($This);	Imports only $This; any default exports are ignored unless listed.
🧪 Import optional + default	use Games qw(pacman galaga);	Imports pacman (default) and galaga (optional); must list all desired symbols explicitly.

📋 SYNOPSIS

  package Foo;
  use Exporter::Lite;

  our @EXPORT    = qw($This That);      # default exports
  our @EXPORT_OK = qw(@Left %Right);    # optional exports

Then in code using the module:

  use Foo;
  # $This and &That are imported here

You have to explicitly ask for optional exports:

 use Foo qw/ @Left %Right /;

📘 DESCRIPTION

Exporter::Lite is an alternative to Exporter, intended to provide a lightweight subset of the most commonly‑used functionality. It supports import(), @EXPORT and @EXPORT_OK and not a whole lot else.

Unlike Exporter, it is not necessary to inherit from Exporter::Lite; i.e. you don’t need to write:

 @ISA = qw(Exporter::Lite);

Exporter::Lite simply exports its import() function into your namespace. This might be called a “mix‑in” or a “role”.

Setting up a module to export its variables and functions is simple:

    package My::Module;
    use Exporter::Lite;

    our @EXPORT = qw($Foo bar);

Functions and variables listed in the @EXPORT package variable are automatically exported if you use the module and don’t explicitly list any imports. Now, when you use My::Module, $Foo and bar() will show up.

Optional exports are listed in the @EXPORT_OK package variable:

    package My::Module;
    use Exporter::Lite;

    our @EXPORT_OK = qw($Foo bar);

When My::Module is used, $Foo and bar() will not show up, unless you explicitly ask for them:

    use My::Module qw($Foo bar);

Note that when you specify one or more functions or variables to import, you must also explicitly list any of the default symbols you want to use. So if you have an exporting module:

    package Games;
    our @EXPORT    = qw/ pacman defender  /;
    our @EXPORT_OK = qw/ galaga centipede /;

Then if you want to use both pacman and galaga, you would write:

    use Games qw/ pacman galaga /;

🔧 Methods

Export::Lite has one public method, import(), which is called automatically when your modules is use()'d.

In normal usage you don’t have to worry about this at all.

📥 import

      Some::Module->import;
      Some::Module->import(@symbols);

Works just like Exporter::import() excepting it only honors @Some::Module::EXPORT and @Some::Module::EXPORT_OK.

The given @symbols are exported to the current package provided they are in @Some::Module::EXPORT or @Some::Module::EXPORT_OK. Otherwise an exception is thrown (i.e. the program dies).

If @symbols is not given, everything in @Some::Module::EXPORT is exported.

🩺 DIAGNOSTICS

• "%s" is not exported by the %s module — Attempted to import a symbol which is not in @EXPORT or @EXPORT_OK.
• Can\'t export symbol: %s — Attempted to import a symbol of an unknown type (i.e. the leading $@% salad wasn’t recognized).

📚 SEE ALSO

• Exporter 👑 — the grandaddy of all Exporter modules, bundled with Perl itself.
• Attribute::Exporter 🏷️ — defines attributes to mark which subs and variables to export, and how.
• Exporter::Simple 🔄 — also uses attributes to control exports.
• Const::Exporter 🧊 — makes it easy to create a module that exports constants.
• Constant::Exporter 🧊 — another module for creating and exporting constants.
• Sub::Exporter 🛠️ — sophisticated exporter with custom generators.
• Exporter::Tiny 📦 — provides Sub::Exporter features with only core dependencies.
• Exporter::Shiny ✨ — a concise notation for optional exports via Exporter::Tiny.
• Exporter::Declare 🔊 — syntactic sugar to make export status part of declaration.
• AppConfig::Exporter ⚙️ — exports part of an AppConfig‑based configuration.
• Exporter::Lexical 🧠 — exports lexical subs from your module.
• Constant::Export::Lazy 🦥 — writes a module that exports function‑style constants lazily.
• Exporter::Auto 🤖 — auto‑exports every public function (names not starting with underscore).
• Class::Exporter 🏛️ — exports class methods as regular subroutines.
• Xporter 🔄 — like Exporter but with persistent defaults and auto‑ISA.

📦 REPOSITORY

https://github.com/neilb/Exporter-Lite

✍️ AUTHORS

Michael G Schwern <schwern AT pobox.com>

⚖️ LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

📛 NAME 🚀 Quick Reference 📋 SYNOPSIS 📘 DESCRIPTION 🩺 DIAGNOSTICS 📚 SEE ALSO 📦 REPOSITORY ✍️ AUTHORS ⚖️ LICENSE