Как программа Perl знает, где найти файл, содержащий модуль Perl, который он использует?

Question

Если моя программа Perl использует модули Perl, как она определит, где найти файл, содержащий код модуля?

Например, если программа содержит:

use MyModule1;    # Example 1 
use This::Here::MyModule2; # Example 2 

, где это будет выглядеть?

Answer 1

Perl-интерпретатор (который запускает вашу программу perl) будет использовать специальный массив с именем @INC для поиска файла, содержащего модуль.

Каждое значение в массиве @INC - это имя каталога (, но см. Примечание ниже); Perl будет искать в этих каталогах в цикле, используя правила, указанные ниже. (См. this SO post for details of how the contents of @INC are determined).

Если файл модуля не найден после исчерпания @INC, компиляция программы будет прервана с ошибкой. Если файл модуля находится в одном из каталогов, указанных в @INC, поиск завершен, не глядя на остальную часть @INC.

Путь Perl ищет файл модуля в каждом из каталогов, перечисленных в @INC выглядит следующим образом:

• Во-первых, это будет отдельный иерархические компоненты имя модуля в (слова, разделенные ::), в последний компонент, который будет использоваться для формирования имени файла, и путь иерархии (все компоненты, предшествующие последним ::).

  В случае, если имя модуля имеет только один компонент (нет ::, например MyModule1), путь иерархии пуст, а имя файла - это имя модуля. Во втором примере в этом вопросе последний компонент равен MyModule2, а путь иерархии будет This::Here.

• Ожидаемое имя файла будет определено путем добавления последнего компонента имени модуля с расширением .pm. Например. MyModule1.pm и MyModule2.pm в наших примерах.

  ПРИМЕЧАНИЕ. Имена модулей, очевидно, чувствительны к регистру в Unix и других операционных системах, где имена файлов/каталогов чувствительны к регистру.

• каталог модуля будет определяться:

  1. Принимая следующий каталог из @INC - скажем /usr/lib/perl качестве примера

  2. Формирование подкаталог этого каталога, принимая иерархию путь имени модуля (если таковой имеется) и заменить «::» / или любым другим символом, который операционная система использует как разделитель каталога. В наших двух примерах первый модуль будет искать в /usr/lib/perl (без подкаталога), а второй - в /usr/lib/perl/This/Here.

  3. ПРИМЕЧАНИЕ: выше небольшое упрощение - @INCmay also contain subroutine references and object references, который загружает модули, как их пользовательский код указывает вместо выполнения поиск в каталоге, как указано в # 2 логика выше. Эта функциональность очень редко используется, и в этой статье предполагается, что весь @INC содержит только каталоги.

Давайте рассмотрим конкретный пример, при условии, что ваш @INC содержит две поддиректории: ("/usr/lib/perl", "/opt/custom/lib").

Тогда Perl будет искать следующим образом:

 
========================================================================== 
| Module    | Try # | File to try    
========================================================================== 
| MyModule1    | Try 1 | /usr/lib/perl/MyModule1.pm 
| MyModule1    | Try 2 | /opt/custom/lib/MyModule1.pm 
========================================================================== 
| This::Here::MyModule2 | Try 1 | /usr/lib/perl/This/Here/MyModule2.pm 
| This::Here::MyModule2 | Try 2 | /opt/custom/lib/This/Here/MyModule2.pm 
========================================================================== 

Пожалуйста, помните, что интерпретатор Perl перестанет пытаться искать, когда он находит файл в одном из мест, не пытаясь увидеть, если файл находится в более поздних местах также. Например. если /usr/lib/perl/This/Here/MyModule2.pm существует, то Perl не будет искать и не заботится о существовании /opt/custom/lib/This/Here/MyModule2.pm.

ПРИМЕЧАНИЕ: @INC используется всякий раз, когда интерпретатор Perl использует require-подобный механизм для импорта модулей Perl. Это включает в себя:

• require директива сама
• use MyModule заявление (эквивалент требовать + импорт)
• use base (эквивалент требовать + "нажмите @ISA")

Answer 2

Согласно perlfunc documentation on use:

использование модуля LI ST

Импортирует некоторую семантику в текущий пакет из именованного модуля, как правило, путем наложения определенных подпрограмм или имен переменных в ваш пакет. Это в точности эквивалентно

BEGIN { require Module; Module->import(LIST); } 

за исключением того, что модуль должен быть гоблином.

Так require делает тяжелую работу, а require documentation обеспечивает

Если EXPR является bareword, то требуется предполагает ".pm" расширение и заменяет "::" с "/" в имени файла для вас, чтобы сделать его легко для загрузки стандартных модулей. Эта форма загрузки модулей не подвержена изменению вашего пространства имен.

Другими словами, если вы попытаетесь это сделать:

require Foo::Bar; # a splendid bareword 

Требовать функция будет фактически искать "Foo/Bar.pm" файла в каталогах, указанных в @INC массиве.

Answer 3

Хотя это прямо не отвечает на вопрос, вот несколько простых методов определения полного пути к файлу модуля, который вы хотите использовать.

Для просмотра содержимого по умолчанию для @INC массива, а также много другой информации, из командной строки:

perl -V  

Если вы хотите знать расположение Carp модуля:

perldoc -l Carp 

Внутри сценария печать содержимого хеша %INC полезна для определения фактического модуля, который вы используете, особенно если вы изменили значение по умолчанию @INC:

use Carp; 
print $INC{'Carp.pm'}; 

Этот простой сценарий также может быть использован для Find installed Perl modules matching a regular expression и выявления повторяющихся модулей в различных каталогах.