How do I choose a package name for a custom Perl module that does not collide with builtin or CPAN packages names?

by

The namespace Local:: has been reserved for just this purpose. No module that starts with that prefix will be accepted to CPAN or the core. Alternatively, you can use an underscore in the top-level name (like My_Corp::Session or just My_Session). All categories with an underscore have also been reserved. (This is mentioned in perlmodlib, under “Select a name for the module”.)

Note that both those reservations apply only to the top-level name. For example, there are CPAN modules named Time::Local and Text::CSV_XS. But Local::Time and Text_CSV::XS are reserved names and would not be accepted on CPAN.

Naming modules after your company is fine too. (Well, unless you work for some really generic sounding company.) Using the reverse domain name is probably overkill, unless you intend to distribute your modules to others. (But in that case, you should probably register a normal module name.)

How Perl resolves a conflict:

Perl searches the directories in @INC for a module with the specified name. The first module found is the one used. So the order of directories in @INC determines which module would be used (if you have modules with the same name installed in different locations).

perl -V will report the contents of @INC (the highest-priority directories are listed first). But there are lots of ways to manipulate @INC at runtime, too.

BTW, Raku can handle multiple modules with the same name by different authors, and even use more than one in a single program. That’s a different solution.

More Related Contents:

  1. How can I install a CPAN module into a local directory?
  2. How can I install Perl modules without root privileges?
  3. How can I use a new Perl module without install permissions?
  4. How can I install a specific version of a set of Perl modules?
  5. How can I find the version of an installed Perl module?
  6. Failing to install MIME::Base64 using cpan [closed]
  7. What’s the easiest way to install a missing Perl module?
  8. How can I use CPAN as a non-root user?
  9. How can I require an optional Perl module if installed?
  10. How do I “use” a Perl module in a directory not in @INC?
  11. How can I dynamically include Perl modules without using eval?
  12. What is the difference between new Some::Class and Some::Class->new() in Perl?
  13. How can I install CPAN modules locally without root access (DynaLoader.pm line 229 error)?
  14. How do YOU manage Perl modules when using a package manager?
  15. Which cpan installer is the right one? (CPAN.pm/CPANPLUS/cpanminus)
  16. Why is the Switch module deprecated in Perl?
  17. In Perl, how can I check from which module a given function was imported?
  18. Can a Perl script install its own CPAN dependencies?
  19. How do I tell CPAN to install all dependencies?
  20. Why can’t Perl find my file that is in ClearCase?
  21. What’s the difference between a hash and hash reference in Perl?
  22. How can I process options using Perl in -n or -p mode?
  23. Why does my Perl script exit with 137?
  24. Which Perl module would you recommend for JSON manipulation?
  25. Perl read line by line
  26. What is the difference between Perl’s ( or, and ) and ( ||, && ) short-circuit operators?
  27. Obtain a switch/case behaviour in Perl 5
  28. How do I extract the domain out of an URL?
  29. How do I capture Perl’s STDOUT in a variable?
  30. Is object oriented exception handling in Perl worth it?

Leave a Comment