Perl::...rtation(3pm)

✨ NAME ✨

okay so bestie, welcome to Perl::...rtation(3pm) β€” that's the manual name right there β€” from the User Contributed Perl Documentation crew. The full policy name is Perl::Critic::Policy::Modules::ProhibitAutomaticExportation, and its whole thing is: export symbols via @EXPORT_OK or %EXPORT_TAGS instead of @EXPORT. periodt. πŸ’…


πŸ¦‹ AFFILIATION πŸ¦‹

This Policy is part of the core Perl::Critic distribution. iykyk ✨


πŸ’… DESCRIPTION πŸ’…

So when you're using Exporter, any symbols you put in the @EXPORT variable get automatically exported into the caller's namespace. Convenient? sure. Polite? not it. It may cause serious problems if the caller declares the same symbols. fr fr, that's a whole mess.

The best practice is to place your symbols in @EXPORT_OK or %EXPORT_TAGS and let the caller choose exactly which symbols to export. slay. 🫢

package Foo;

use Exporter 'import';
our @EXPORT      = qw(foo $bar @baz);                  # not ok
our @EXPORT_OK   = qw(foo $bar @baz);                  # ok
our %EXPORT_TAGS = ( all => [ qw(foo $bar @baz) ] );   # ok

πŸŽ€ CONFIGURATION πŸŽ€

This Policy is not configurable except for the standard options. that's literally the whole config section πŸ’€


🌸 AUTHOR 🌸

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> iconic behavior πŸ‘‘


Copyright (c) 2005-2023 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. ate and left no crumbs 🌈


xoxo, your fave manpage β€” version stamp perl v5.42.0, date stamp 2024-10-23 πŸ’–βœ¨πŸ’…

πŸ“¦ where this page comes from