Spec-Zone.ru › Perl 5.32

perlhack

СОДЕРЖАНИЕ

  • NAME
  • DESCRIPTION
  • КРАТКОЕ РУКОВОДСТВО ПО ПРАВКЕ
  • СООБЩЕНИЕ ОБ ОШИБКАХ
  • РАЗРАБОТЧИКИ PERL 5
    • Рассылка perl-changes
    • #p5p на IRC
  • ПОЛУЧЕНИЕ ИСТОЧНОГО КОДА PERL
    • Доступ для чтения через Git
    • Доступ для чтения через веб
    • Доступ для чтения через rsync
    • Доступ для записи через git
  • ПРАВКА PERL
    • Отправка правок
    • Получение одобрения вашей правки
      • Стиль правок
      • Сообщение коммита
      • Комментарии, комментарии, комментарии
      • Стиль
      • Набор тестов
    • Правка основного модуля
    • Обновление perldelta
    • Что делает правку хорошей?
      • Соответствует ли концепция общим целям Perl?
      • Где реализация?
      • Обратная совместимость
      • Можно ли это сделать в виде модуля?
      • Достаточно ли универсальна эта функция?
      • Может ли это привести к новым ошибкам?
      • Насколько это велико?
      • Препятствует ли это другим желательным функциям?
      • Надежна ли реализация?
      • Достаточно ли универсальна реализация для обеспечения переносимости?
      • Протестирована ли реализация?
      • Достаточно ли документации?
      • Есть ли другой способ сделать это?
      • Создает ли это слишком много работы?
      • Правки говорят громче слов
  • ТЕСТИРОВАНИЕ
    • Специальные цели make test
    • Параллельные тесты
    • Запуск тестов вручную
    • Использование t/harness для тестирования
      • Другие переменные окружения, которые могут влиять на тесты
    • Тестирование производительности
    • Сборка perl на более старых коммитах
  • ДОПОЛНИТЕЛЬНАЯ ЛИТЕРАТУРА ДЛЯ ПРОГРАММИСТОВ-ЭНТУЗИАСТОВ
  • ТЕСТЕРЫ CPAN И ТЕСТЕРЫ PERL
  • ЧТО ДАЛЬШЕ?
    • "Дорога всё идёт и идёт, вниз от двери, где она началась."
    • Метафорические цитаты
  • АВТОР

NAME

perlhack - Как работать над Perl

DESCRIPTION

В этом документе объясняется, как работает разработка Perl. Он включает в себя подробную информацию о списке рассылки Perl 5 Porters, репозитории Perl, системе отслеживания ошибок Perl, рекомендациях по созданию патчей и комментариях к философии разработки Perl.

КРАТКОЕ РУКОВОДСТВО ПО ПРАВКЕ

Если вы просто хотите отправить одну небольшую правку, например, исправление pod, тест для ошибки, исправление комментариев и т. д., это легко! Вот как:

  • Выполните checkout репозитория исходного кода

    Исходный код perl находится в репозитории git. Вы можете клонировать репозиторий с помощью следующей команды:

    % git clone https://github.com/Perl/perl5.git perl

  • Убедитесь, что вы следуете последним рекомендациям

    В случае, если рекомендации в этом руководстве были недавно обновлены, прочитайте последнюю версию непосредственно из исходного кода perl:

    % perldoc pod/perlhack.pod

  • Создайте ветку для вашего изменения

    Создайте ветку на основе blead для фиксации вашего изменения, которая позже будет использоваться для отправки его в систему отслеживания ошибок Perl.

    % git checkout -b mychange

  • Внесите изменения

    Работайте, работайте, работайте. Имейте в виду, что Perl работает на многих разных платформах, с различными операционными системами, которые имеют разные возможности, разные организации файловой системы и даже разные кодировки символов. perlhacktips дает советы по этому поводу.

  • Протестируйте ваши изменения

    Вы можете запустить все тесты с помощью следующих команд:

    % ./Configure -des -Dusedevel
% make test

    Продолжайте работу, пока тесты не пройдут.

  • Зафиксируйте изменения

    Фиксация вашей работы сохранит изменения на вашей локальной системе:

    % git commit -a -m 'Commit message goes here'

    Убедитесь, что сообщение коммита описывает ваши изменения в одном предложении. Например, "Исправлены орфографические ошибки в perlhack.pod".

  • Отправьте изменения в систему отслеживания ошибок Perl

    Следующим шагом является отправка вашей правки в систему отслеживания ошибок ядра Perl.

    Создайте GitHub fork репозитория perl5 и добавьте его как удалённый репозиторий, если вы ещё этого не сделали, как описано в документации GitHub по адресу https://help.github.com/en/articles/working-with-forks.

    % git remote add fork git@github.com:MyUser/perl5.git

    Затем отправьте вашу новую ветку в ваш fork.

    % git push -u fork mychange

    Наконец, создайте запрос на вытягивание (Pull Request) на GitHub из вашей ветки в blead, как описано в документации GitHub по адресу https://help.github.com/en/articles/creating-a-pull-request-from-a-fork.

  • Спасибо

    Разработчики ценят время, которое вы потратили на улучшение Perl. Спасибо!

  • Благодарность

    Все участники проекта упоминаются (по имени и адресу электронной почты) в файле AUTHORS, который является частью дистрибутива perl, а также в истории коммитов Git.

    Если вы не хотите, чтобы вас включили в файл AUTHORS, просто сообщите нам об этом. В противном случае мы будем считать вашу отправку патча разрешением на указание вас в файле AUTHORS.

  • В следующий раз

    В следующий раз, когда вы захотите внести правку, вам нужно начать с последней версии perl в чистом состоянии. Убедитесь, что у вас нет локальных изменений или добавленных файлов в вашей выгруженной копии perl, которые вы хотите сохранить, а затем выполните следующие команды:

    % git checkout blead
% git pull
% git reset --hard origin/blead
% git clean -dxf

СООБЩЕНИЕ ОБ ОШИБКАХ

Если вы хотите сообщить об ошибке в Perl или просмотреть существующие ошибки и патчи Perl, используйте систему отслеживания ошибок GitHub по адресу https://github.com/perl/perl5/issues.

Перед отправкой сообщения об ошибке, пожалуйста, проверьте архив списка perl5-porters (см. ниже) и/или систему отслеживания ошибок. Часто вы обнаружите, что ошибка уже была сообщена.

Вы можете войти в систему отслеживания ошибок и оставлять комментарии к существующим сообщениям об ошибках. Если у вас есть дополнительная информация о существующей ошибке, пожалуйста, добавьте её. Это поможет разработчикам исправить ошибку.

РАЗРАБОТЧИКИ PERL 5

Список рассылки perl5-porters (p5p) — это место, где поддерживается и разрабатывается стандартный дистрибутив Perl. Люди, которые поддерживают Perl, также называются "Perl 5 Porters", "p5p" или просто "разработчики".

Поисковый архив списка доступен по адресу https://markmail.org/search/?q=perl5-porters. Также существует архив по адресу https://archive.develooper.com/perl5-porters@perl.org/.

Рассылка perl-changes

Список рассылки perl5-changes получает копию каждого патча, который отправляется в ветки обслуживания и разработки репозитория perl. См. https://lists.perl.org/list/perl5-changes.html для получения информации о подписке и архиве.

#p5p на IRC

Многие разработчики также активны на канале irc://irc.perl.org/#p5p. Не стесняйтесь присоединиться к каналу и задавать вопросы о работе над ядром Perl.

ПОЛУЧЕНИЕ ИСТОЧНОГО КОДА PERL

Весь исходный код Perl хранится централизованно в репозитории Git на github.com. Репозиторий содержит множество ревизий Perl, начиная с Perl 1, и все ревизии из Perforce, предыдущей системы управления версиями.

Для получения более подробной информации об использовании git с репозиторием Perl, пожалуйста, см. perlgit.

Доступ для чтения через Git

Вам понадобится копия Git для вашего компьютера. Вы можете получить копию репозитория, используя протокол git:

% git clone git://github.com/Perl/perl5.git perl

Это клонирует репозиторий и создает локальную копию в каталоге perl.

Если вы не можете использовать протокол git из-за проблем с брандмауэром, вы также можете клонировать через http:

% git clone https://github.com/Perl/perl5.git perl

Доступ для чтения через веб

Вы можете получить доступ к репозиторию через веб. Это позволяет вам просматривать дерево, видеть последние коммиты, подписываться на уведомления о репозитории, искать определенные коммиты и многое другое. Вы можете получить к нему доступ по адресу https://github.com/Perl/perl5.

Чтение через rsync

Вы также можете использовать rsync для получения копии текущего дерева исходного кода для ветки bleadperl и всех ветвей обслуживания:

% rsync -avz rsync://perl5.git.perl.org/perl-current .
% rsync -avz rsync://perl5.git.perl.org/perl-5.12.x .
% rsync -avz rsync://perl5.git.perl.org/perl-5.10.x .
% rsync -avz rsync://perl5.git.perl.org/perl-5.8.x .
% rsync -avz rsync://perl5.git.perl.org/perl-5.6.x .
% rsync -avz rsync://perl5.git.perl.org/perl-5.005xx .

(Добавьте опцию --delete для удаления оставшихся файлов.)

Чтобы получить полный список доступных точек синхронизации:

% rsync perl5.git.perl.org::

Запись через git

Если у вас есть бит коммита, см. perlgit для получения более подробной информации об использовании git.

ВНЕСЕНИЕ ИЗМЕНЕНИЙ В PERL

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

Отправка патчей

Если у вас есть небольшой патч для отправки, отправьте его через рабочий процесс GitHub Pull Request. Вы также можете отправить патчи в список p5p.

Патчи проверяются и обсуждаются на GitHub или в списке p5p. Простые, не вызывающие споров патчи обычно применяются без обсуждения. После применения патча тикет будет обновлен, и вы получите электронное письмо.

В других случаях патч потребует дополнительной работы или обсуждения. Вам предлагается участвовать в обсуждении и отстаивать свой патч. Иногда ваш патч может потеряться. Целесообразно отправить напоминание на p5p, если никаких действий не предпринято в течение месяца. Пожалуйста, помните, что разработчики Perl 5 — все добровольцы, и будьте вежливы.

Изменения всегда применяются непосредственно к основной ветке разработки, называемой "blead". Некоторые патчи могут быть перенесены в ветку обслуживания. Если вы считаете, что ваш патч подходит для ветки обслуживания (см. "ВЕТВИ ОБСЛУЖИВАНИЯ" в perlpolicy), пожалуйста, объясните почему, когда вы его отправите.

Получение одобрения патча

Если вы отправляете патч кода, есть несколько вещей, которые вы можете сделать, чтобы помочь разработчикам Perl 5 принять ваш патч.

Стиль патча

При использовании рабочего процесса GitHub Pull Request ваш патч будет автоматически доступен в подходящем формате. Если вы хотите отправить патч в список p5p для проверки, убедитесь, что вы создали его соответствующим образом.

Если вы использовали git для проверки исходного кода Perl, то использование git format-patch создаст патч в стиле, подходящем для Perl. Команда format-patch создает один файл патча для каждого выполненного вами коммита. Если вы предпочитаете отправить один патч для всех коммитов, вы можете использовать git diff.

% git checkout blead
% git pull
% git diff blead my-branch-name

Это создает патч на основе различий между blead и вашей текущей веткой. Важно убедиться, что blead обновлен перед созданием diff, поэтому мы сначала вызываем git pull.

Мы настоятельно рекомендуем использовать git, если это возможно. Это упростит вашу жизнь, а также нашу.

Однако, если вы не используете git, вы все равно можете создать подходящий патч. Вам понадобится чистая копия исходного кода Perl для сравнения. Разработчики предпочитают унифицированные diff. Используя GNU diff, вы можете создать diff, подобный этому:

% diff -Npurd perl.pristine perl.mine

Убедитесь, что вы make realclean в вашей копии Perl, чтобы удалить любые артефакты сборки, иначе вы можете получить запутанный результат.

Сообщение о коммите

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

Первая строка сообщения о коммите должна быть кратким описанием без точки. Она не должна быть длиннее темы письма, 50 символов — хорошее практическое правило.

Многие инструменты Git (Gitweb, GitHub, git log --pretty=oneline, ...) будут отображать только первую строку (обрезанную до 50 символов) при представлении сводок коммитов.

Сообщение о коммите должно включать описание проблемы, которую исправляет патч, или новой функциональности, которую добавляет патч.

Как общее практическое правило, ваше сообщение о коммите должно помочь программисту, знающему ядро Perl, быстро понять, что вы пытались сделать, как вы пытались это сделать и почему это изменение важно для Perl.

  • Почему

    Ваше сообщение о коммите должно описывать, почему важно изменение, которое вы вносите. Когда кто-то посмотрит на ваше изменение через шесть месяцев или шесть лет, ваше намерение должно быть ясным.

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

  • Что

    Ваше сообщение о коммите должно описывать, какую часть ядра Perl вы изменяете и что вы ожидаете от вашего патча.

  • Как

    Хотя это не обязательно для изменений в документации, новых тестов или тривиальных патчей, часто стоит объяснить, как работает ваше изменение. Даже если это ясно для вас сегодня, это может быть не ясно разработчику в следующем месяце или в следующем году.

Сообщение о коммите не предназначено для замены комментариев в вашем коде. Сообщения о коммите должны описывать внесенные вами изменения, а комментарии к коду должны описывать текущее состояние кода.

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

Комментарии, комментарии, комментарии

Обязательно достаточно комментируйте свой код. Хотя комментирование каждой строки не обязательно, все, что использует побочные эффекты операторов, создает изменения, которые будут ощущаться за пределами исправленного метода, или что другие могут найти запутанным, должно быть задокументировано. Если вы собираетесь ошибаться, лучше ошибаться в сторону добавления слишком большого количества комментариев, чем слишком малого.

Лучшие комментарии объясняют, почему код делает то, что он делает, а не что он делает.

Стиль

В целом, пожалуйста, следуйте конкретному стилю кода, который вы исправляет.

В частности, следуйте этим общим рекомендациям для исправления исходного кода Perl:

  • Отступы шириной 4 символа для кода, отступы шириной 2 символа для вложенных CPP #defines, с табуляцией шириной 8 символов.

  • Используйте пробелы для отступов, а не символы табуляции.

    База кода представляет собой смесь табуляции и пробелов для отступов, и мы переходим только на пробелы. Преобразование строк, которые вы исправляет, из 8-символьной табуляции в пробелы поможет этой миграции.

  • Старайтесь не превышать 79 столбцов

  • Прототипы ANSI C

  • Не вложенные else и стиль "K&R" для отступа управляющих конструкций

  • Нет комментариев в стиле C++ (//)

  • Отметьте места, которые необходимо пересмотреть, с помощью XXX (и пересматривайте часто!)

  • Открывающая фигурная скобка на той же строке, что и "if", когда условие занимает несколько строк; в противном случае должна быть в конце строки

  • В определениях функций имя начинается в столбце 0 (тип возвращаемого значения находится на предыдущей строке)

  • Один пробел после ключевых слов, за которыми следуют скобки, без пробела между именем функции и следующей скобкой

  • Избегайте присваиваний в условных выражениях, но если они неизбежны, используйте дополнительные скобки, например, "if (a && (b = c)) ..."

  • "return foo;" вместо "return(foo);"

  • "if (!foo) ..." вместо "if (foo == FALSE) ..." и т. д.

  • Не объявляйте переменные с помощью "register". Это может быть контрпродуктивным с современными компиляторами и устарело в C++, под которым регулярно компилируется исходный код Perl.

  • Встроенные функции, которые находятся в заголовках, доступных для кода XS, должны быть способны компилироваться без предупреждений с часто используемыми дополнительными флагами компиляции, такими как -Wswitch-default gcc, который выдает предупреждение, если оператор switch не имеет случая "default". Использование этих дополнительных флагов позволяет обнаружить потенциальные проблемы в легальном коде C и часто используется агрегаторами Perl, такими как дистрибуторы Linux.

Тестовый набор

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

Ваши дополнения к тестовому набору в целом должны соответствовать следующим рекомендациям (благодаря Gurusamy Sarathy <gsar@activestate.com>):

  • Знайте, что вы тестируете. Читайте документацию и исходный код.

  • Стремитесь к неудаче, а не к успеху.

  • Строго интерпретируйте результаты.

  • Используйте несвязанные функции (это выявит странные взаимодействия).

  • Используйте нестандартные идиомы (в противном случае вы не тестируете TIMTOWTDI).

  • По возможности избегайте использования жестко закодированных тестовых чисел (EXPECTED/GOT, найденный в t/op/tie.t, гораздо более удобен в обслуживании и дает лучшие отчеты об ошибках).

  • Выдавайте содержательные сообщения об ошибках при сбое теста.

  • Избегайте использования qx// и system(), если вы не тестируете их. Если вы используете их, убедитесь, что вы охватываете _все_ платформы perl.

  • Удаляйте любые временные файлы, которые вы создаете.

  • Превращайте непредвиденные предупреждения в ошибки с помощью $SIG{__WARN__}.

  • Обязательно используйте библиотеки и модули, поставляемые с тестируемой версией, а не те, которые уже были установлены.

  • Добавляйте комментарии к коду, объясняющие, что вы тестируете.

  • Сделайте обновление строки '1..42' ненужным. Или убедитесь, что вы обновили ее.

  • Тестируйте _все_ поведения данного оператора, библиотеки или функции.

    Тестируйте все необязательные аргументы.

    Тестируйте возвращаемые значения в различных контекстах (булево, скаляр, список, lvalue).

    Используйте как глобальные, так и лексические переменные.

    Не забывайте об исключительных, патологических случаях.

Внесение изменений в основной модуль

Это работает так же, как и исправление чего-либо еще, с одним дополнительным моментом.

Модули в каталоге cpan/ дерева исходного кода поддерживаются за пределами ядра Perl. Когда автор обновляет модуль, обновления просто копируются в ядро. См. документацию этого модуля или его список на https://metacpan.org/ для получения дополнительной информации о сообщении об ошибках и отправке патчей.

В большинстве случаев патчи для модулей в cpan/ должны отправляться в исходный проект и не должны применяться к ядру Perl по отдельности. Если патч для файла в cpan/ абсолютно не может ждать исправления в исходном проекте, выпуска в CPAN и копирования в blead, вы должны добавить (или обновить) запись CUSTOMIZED в файл "Porting/Maintainers.pl", чтобы указать, что внесены локальные изменения. См. "Porting/Maintainers.pl" для получения более подробной информации.

В отличие от этого, модули в каталоге dist/ поддерживаются в ядре.

Обновление perldelta

Для изменений, достаточно значительных, чтобы гарантировать запись в pod/perldelta.pod, разработчики будут очень признательны, если вы отправите запись delta вместе с вашим фактическим изменением. Значительные изменения включают, но не ограничиваются:

  • Добавление, устаревание или удаление основных функций

  • Добавление, устаревание, удаление или обновление основных или двойных модулей

  • Добавление новых основных тестов

  • Исправление проблем безопасности и видимых пользователям ошибок в ядре

  • Изменения, которые могут нарушить существующий код, как на уровне perl, так и на уровне C

  • Значительные улучшения производительности

  • Добавление, удаление или значительное изменение документации в каталоге pod/

  • Важные изменения, специфичные для платформы

Пожалуйста, убедитесь, что вы добавили запись perldelta в нужный раздел внутри pod/perldelta.pod. Дополнительная информация о том, как писать хорошие записи perldelta, доступна в разделе Style Porting/how_to_write_a_perldelta.pod.

Что делает патч хорошим?

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

Соответствует ли концепция общим целям Perl?

Наши цели включают, но не ограничиваются:

  1. Быстро, просто и полезно.

  2. Поддерживать функции/концепции максимально ортогональными.

  3. Без произвольных ограничений (платформы, размеры данных, культуры).

  4. Поддерживать открытость и интерес к использованию/патчингу/пропаганде Perl повсюду.

  5. Ассимилировать новые технологии или строить мосты к ним.

Где реализация?

Все разговоры в мире бесполезны без реализации. Почти в каждом случае от человека или людей, которые выступают за новую функцию, ожидается, что они будут теми, кто ее реализует. Портеры, способные кодировать новые функции, имеют свои собственные планы и не могут реализовать вашу (возможно, хорошую) идею.

Обратная совместимость

Нарушение существующих программ Perl — это тяжкий грех. Новые предупреждения могут быть спорными — некоторые говорят, что программа, которая выдает предупреждения, не сломана, а другие говорят, что сломана. Добавление ключевых слов может привести к поломке программ, изменение смысла существующих последовательностей токенов или функций может привести к поломке программ.

Ядро Perl 5 включает механизмы, которые помогают портерам сделать несовместимые с обратной совместимостью изменения более совместимыми, такие как модули feature и deprecate. Пожалуйста, используйте их, когда это уместно.

Может ли это быть модулем?

Perl 5 имеет механизмы расширения, модули и XS, специально для того, чтобы избежать необходимости постоянно изменять интерпретатор Perl. Вы можете писать модули, которые экспортируют функции, вы можете давать этим функциям прототипы, чтобы их можно было вызывать как встроенные функции, вы даже можете писать код XS, чтобы возиться со структурами данных времени выполнения интерпретатора Perl, если вы хотите реализовать действительно сложные вещи.

Всякий раз, когда это возможно, новые функции должны быть созданы в виде прототипа в модуле CPAN, прежде чем они будут рассматриваться для ядра.

Достаточно ли универсальна функция?

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

Может ли это привести к появлению новых ошибок?

Радикальные переписывания больших фрагментов интерпретатора Perl могут привести к появлению новых ошибок.

Насколько это велико?

Чем меньше и более локализовано изменение, тем лучше. Аналогично, серия небольших патчей намного предпочтительнее одного большого патча.

Препятствует ли это другим желательным функциям?

Патч, скорее всего, будет отклонен, если он закроет будущие пути развития. Например, патч, который дал бы истинное и окончательное толкование прототипам, скорее всего, будет отклонен, потому что все еще есть варианты будущего прототипов, которые не были рассмотрены.

Надежна ли реализация?

Хорошие патчи (компактный код, полный, правильный) имеют больше шансов быть принятыми. Небрежные или неправильные патчи могут быть отложены до тех пор, пока у администратора не будет времени их исправить, или могут быть вообще отброшены без дальнейшего уведомления.

Достаточно ли универсальна реализация для обеспечения переносимости?

Худшие патчи используют функции, специфичные для системы. Весьма маловероятно, что непереносимые дополнения к языку Perl будут приняты.

Протестирована ли реализация?

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

Без тестов, предоставленных исходным автором, как кто-либо еще, изменяющий perl в будущем, может быть уверен, что он невольно не сломал поведение, реализованное патчем? И без тестов, как автор патча может быть уверен, что его/ее тяжелая работа, вложенная в патч, не будет случайно выброшена кем-то в будущем?

Достаточно ли документации?

Патчи без документации, вероятно, плохо продуманы или неполны. Никакие функции не могут быть добавлены или изменены без документации, поэтому важно отправить патч для соответствующих документов pod, а также для исходного кода.

Есть ли другой способ сделать это?

Ларри сказал: «Хотя слоган Perl — There's More Than One Way to Do It, я колеблюсь, чтобы сделать 10 способов сделать что-то». Однако это сложная эвристика для навигации — то, что для одного человека является существенным дополнением, для другого — бессмысленным мусором.

Создает ли это слишком много работы?

Работа для администратора, работа для программистов Perl, работа для авторов модулей, ... Perl должен быть простым.

Патчи говорят громче слов

Рабочий код всегда предпочтительнее планов на будущее. Патч для добавления функции имеет гораздо больше шансов попасть в язык, чем случайный запрос функции, независимо от того, как рьяно может быть аргументирован этот запрос. Это связано с вопросом «Будет ли это полезно?», поскольку тот факт, что кто-то потратил время на создание патча, демонстрирует сильное желание получить эту функцию.

ТЕСТИРОВАНИЕ

Ядро использует тот же стиль тестирования, что и остальная часть Perl, простой прогон «ok/not ok» через Test::Harness, но есть несколько особых моментов.

Есть три способа написать тест в ядре: Test::More, t/test.pl и ad hoc print $test ? "ok 42\n" : "not ok 42\n". Решение о том, какой из них использовать, зависит от того, над какой частью тестового набора вы работаете. Это мера для предотвращения сбоя высокого уровня (например, поломки Config.pm) от того, чтобы вызывать сбои в тестах базовой функциональности.

Библиотека t/test.pl предоставляет некоторые функции Test::More, но избегает загрузки большинства модулей и использует как можно меньше основных функций.

Если вы пишете свой собственный тест, используйте Test Anything Protocol.

  • t/base, t/comp и t/opbasic

    Поскольку мы не знаем, работает ли require, или даже подпрограммы, используйте для этих трех ad hoc тесты. Действуйте осторожно, чтобы избежать использования тестируемой функции. Тесты в t/opbasic, например, были помещены туда, а не в t/op, потому что они проверяют функциональность, которую t/test.pl предполагает уже продемонстрированную как работающую.

  • Все остальные подкаталоги t/

    Теперь, когда базовые require() и подпрограммы протестированы, вы можете использовать библиотеку t/test.pl.

    Вы также можете условно использовать определенные библиотеки, такие как Config, но обязательно корректно пропустите тест, если его нет.

  • Тестовые файлы, не найденные в t/

    Эта категория включает файлы .t в подкаталогах, таких как dist, ext и lib. Поскольку ядро Perl теперь протестировано, Test::More может и теперь должен использоваться. Вы также можете использовать полный набор основных модулей в тестах. (Как отмечено в разделе "Патчинг основного модуля" выше, изменения в файлах .t, найденных в cpan/, должны быть отправлены основным разработчикам этих модулей.)

Когда вы говорите «make test», Perl использует программу t/TEST для запуска тестового набора (за исключением Win32, где вместо него используется t/harness). Все тесты запускаются из каталога t/, а не из каталога, содержащего тест. Это вызывает некоторые проблемы с тестами в lib/, поэтому здесь есть возможность для некоторых патчей.

Вы должны быть втройне внимательны к проблемам кроссплатформенности. Обычно это сводится к использованию File::Spec, избеганию таких вещей, как fork() и system(), если это абсолютно необходимо, и не предполагая, что данный символ имеет определенное порядковое значение (кодовую точку) или что его представление UTF-8 состоит из определенных байтов.

Существует несколько функций, доступных для указания символов и кодовых точек переносимым образом в тестах. Всегда предварительно загруженные функции utf8::unicode_to_native() и ее обратная utf8::native_to_unicode() принимают кодовые точки и переводят их соответствующим образом. Файл t/charset_tools.pl содержит несколько полезных функций. Он содержит версии двух предыдущих функций, которые принимают строки в качестве входных данных — не отдельные числовые кодовые точки: uni_to_native() и native_to_uni(). Если вы должны посмотреть на отдельные байты, составляющие строку, закодированную в UTF-8, byte_utf8a_to_utf8n() принимает в качестве входных данных строку этих байтов, закодированных для ASCII-платформы, и возвращает эквивалентную строку на родной платформе. Например, byte_utf8a_to_utf8n("\xC2\xA0") возвращает последовательность байтов на текущей платформе, которые образуют UTF-8 для U+00A0, поскольку "\xC2\xA0" — это байты UTF-8 на ASCII-платформе для этой кодовой точки. Эта функция возвращает "\xC2\xA0" на ASCII-платформе и "\x80\x41" на EBCDIC 1047.

Но проще всего, если символ можно указать как литерал, например "A" или "%", использовать его; если он не так специфически указывается, вы можете использовать \N{}, если побочные эффекты не вызывают проблем. Просто укажите все ваши символы в шестнадцатеричном формате, используя \N{U+ZZ} вместо \xZZ. \N{} — это имя Unicode, поэтому оно всегда дает вам символ Unicode. \N{U+41} — это символ, чья кодовая точка Unicode равна 0x41, следовательно, это 'A' на всех платформах. Побочные эффекты:

  • Они выбирают правила Unicode. Это означает, что в строках, заключенных в двойные кавычки, строка всегда преобразуется в UTF-8, чтобы принудительно выполнить интерпретацию Unicode (вы можете utf8::downgrade() после этого для преобразования обратно в non-UTF8, если это возможно). В шаблонах регулярных выражений преобразование не выполняется, но если модификатор набора символов в противном случае был бы /d, он изменяется на /u.

  • Если вы используете форму \N{character name}, модуль charnames автоматически загружается. Это может быть неподходящим для того уровня тестирования, который вы выполняете.

Если вы тестируете локали (см. perllocale), в t/loc_tools.pl есть вспомогательные функции, которые позволяют вам увидеть, какие локали доступны на текущей платформе.

Специальные make test цели

Существуют различные специальные цели make, которые можно использовать для тестирования Perl немного иначе, чем стандартная цель "test". Не от всех из них ожидается 100% успешность. Многие из них имеют несколько псевдонимов, и многие из них недоступны в некоторых операционных системах.

  • test_porting

    Это запускает некоторые базовые тесты на работоспособность исходного дерева и помогает обнаружить основные ошибки до отправки патча.

  • minitest

    Запускает miniperl на тестах t/base, t/comp, t/cmd, t/run, t/io, t/op, t/uni и t/mro.

    miniperl - это минималистичный perl, созданный для загрузки расширений, утилит, документации и т.д. Он не поддерживает динамическую загрузку и, в зависимости от этапа сборки, будет иметь доступ только к ограниченному набору основных модулей. miniperl не предназначен для повседневного использования.

  • test.valgrind check.valgrind

    (Только в Linux) Запускает все тесты с помощью инструмента для обнаружения утечек памяти и некорректного доступа к памяти "valgrind". Файлы журналов будут называться testname.valgrind.

  • test_harness

    Запускает набор тестов с помощью управляющей программы t/harness вместо t/TEST. t/harness более сложен и использует модуль Test::Harness, поэтому использование этой цели тестирования предполагает, что perl в основном работает. Основное преимущество для наших целей заключается в том, что он выводит подробное резюме неудачных тестов в конце. Кроме того, в отличие от t/TEST, он не перенаправляет stderr в stdout.

    Обратите внимание, что под Win32 всегда используется t/harness вместо t/TEST, поэтому специальной цели "test_harness" нет.

    Под Win32 в целевом объекте "test" вы можете использовать переменные среды TEST_SWITCHES и TEST_FILES для управления поведением t/harness. Это означает, что вы можете сказать

    nmake test TEST_FILES="op/*.t"
nmake test TEST_SWITCHES="-torture" TEST_FILES="op/*.t"

  • test-notty test_notty

    Устанавливает PERL_SKIP_TTY_TEST в true перед запуском обычного теста.

Параллельные тесты

Основное дистрибутив теперь может запускать свои регрессионные тесты параллельно на unix-подобных платформах. Вместо запуска make test, установите TEST_JOBS в вашей среде на количество тестов для параллельного запуска и запустите make test_harness. В оболочке Bourne-подобного типа это можно сделать так:

TEST_JOBS=3 make test_harness  # Run 3 tests in parallel

Переменная среды используется вместо самого параллельного make, потому что TAP::Harness должен иметь возможность планировать отдельные неконфликтующие тестовые сценарии самостоятельно, и нет стандартного интерфейса для make утилит для взаимодействия с их планировщиками заданий.

Обратите внимание, что в настоящее время некоторые тестовые сценарии могут завершиться неудачей при параллельном запуске (в первую очередь dist/IO/t/io_dir.t). При необходимости запустите снова только неудачные сценарии последовательно и посмотрите, исчезнут ли сбои.

Запуск тестов вручную

Вы можете запустить часть тестового набора вручную, используя одну из следующих команд из каталога t/:

./perl -I../lib TEST list-of-.t-files

или

./perl -I../lib harness list-of-.t-files

(Если вы не указываете тестовые сценарии, будет запущен весь тестовый набор.)

Использование t/harness для тестирования

Если вы используете harness для тестирования, у вас есть несколько доступных параметров командной строки. Аргументы следующие и должны быть указаны в том порядке, в котором они должны появляться, если используются вместе.

harness -v -torture -re=pattern LIST OF FILES TO TEST
harness -v -torture -re LIST OF PATTERNS TO MATCH

Если LIST OF FILES TO TEST опущен, список файлов получается из манифеста. Список файлов может включать подстановочные знаки оболочки, которые будут развернуты.

  • -v

    Запускает тесты в подробном режиме, чтобы вы могли видеть, какие тесты были запущены, и вывод отладки.

  • -torture

    Запускает тесты на стресс-тестирование, а также обычный набор.

  • -re=PATTERN

    Фильтровать список файлов так, чтобы все запущенные тестовые файлы соответствовали PATTERN. Обратите внимание, что эта форма отличается от формы -re СПИСОК ШАБЛОНОВ ниже тем, что позволяет также указать список файлов.

  • -re СПИСОК ШАБЛОНОВ

    Фильтровать список файлов так, чтобы все запущенные тестовые файлы соответствовали /(LIST|OF|PATTERNS)/. Обратите внимание, что в этой форме шаблоны соединяются с помощью '|' и вы не можете указать список файлов, вместо этого тестовые файлы берутся из MANIFEST.

Вы можете запустить отдельный тест с помощью команды, подобной

./perl -I../lib path/to/foo.t

за исключением того, что программы подготовки устанавливают некоторые переменные среды, которые могут повлиять на выполнение теста:

  • PERL_CORE=1

    указывает, что мы запускаем этот тест как часть тестового набора ядра perl. Это полезно для модулей, которые имеют двойную жизнь на CPAN.

  • PERL_DESTRUCT_LEVEL=2

    устанавливается в 2, если он еще не установлен (см. "PERL_DESTRUCT_LEVEL" в perlhacktips).

  • PERL

    (используется только t/TEST) если установлено, переопределяет путь к исполняемому файлу perl, который должен использоваться для запуска тестов (по умолчанию ./perl).

  • PERL_SKIP_TTY_TEST

    если установлено, указывает пропустить тесты, которым требуется терминал. На самом деле он устанавливается автоматически Makefile, но его также можно искусственно установить, запустив 'make test_notty'.

Другие переменные среды, которые могут влиять на тесты

  • PERL_TEST_Net_Ping

    Установка этой переменной запускает все тесты модулей Net::Ping, в противном случае пропускаются некоторые тесты, которые взаимодействуют с внешним миром. См. perl58delta.

  • PERL_TEST_NOVREXX

    Установка этой переменной пропускает тесты vrexx.t для OS2::REXX.

  • PERL_TEST_NUMCONVERTS

    Это устанавливает переменную в op/numconvert.t.

  • PERL_TEST_MEMORY

    Установка этой переменной включает тесты в t/bigmem/. Она должна быть установлена в количество гигабайт памяти, доступной для тестирования, например, PERL_TEST_MEMORY=4 указывает, что тесты, которым требуется 4 ГБ доступной памяти, могут быть запущены безопасно.

См. также документацию для модулей Test и Test::Harness, для получения дополнительной информации о переменных среды, влияющих на тестирование.

Тестирование производительности

Файл t/perf/benchmarks содержит фрагменты кода perl, которые предназначены для тестирования производительности на разных версиях perl с помощью инструмента Porting/bench.pl. Если вы исправите или улучшите проблему производительности, вы можете добавить репрезентативный образец кода в файл, а затем запустить bench.pl для предыдущих и текущих версий perl, чтобы увидеть, какую разницу это внесло и не замедлилось ли что-либо ещё в результате.

Файл t/perf/opcount.t предназначен для проверки того, был ли конкретный фрагмент кода скомпилирован в optree, содержащий указанное количество определенных типов операций. Это хорошо подходит для проверки того, действительно ли оптимизации, которые изменяют операции, такие как преобразование операции aelem в операцию aelemfast, делают это.

Файлы t/perf/speed.t и t/re/speed.t предназначены для тестирования вещей, которые работают в тысячи раз медленнее, если конкретная оптимизация сломана (например, кэш длины utf8 для длинных строк utf8). Добавьте тест, который обычно займет долю секунды, а в противном случае - минуты, вызывая тайм-аут файла теста при сбое.

Сборка perl на старых коммитах

В процессе работы над основным дистрибутивом Perl, вам может потребоваться настроить, собрать и протестировать perl на старом коммите. Иногда make будет завершаться неудачей в процессе этого процесса. В этом случае вы сможете исправить ситуацию, используя библиотеку Devel::PatchPerl из CPAN (не включенную в ядро), чтобы привести исходный код в этом коммите в состояние, пригодное для сборки.

Вот реальный пример, взятый из работы, проделанной для решения perl #10118. Использование Porting/bisect.pl определило коммит ba77e4cc9d1ceebf472c9c5c18b2377ee47062e6 как коммит, в котором была исправлена ошибка. Для подтверждения разработчик P5P хотел настроить и собрать perl в коммите ba77e4c^ (предположительно "плохой"), а затем в ba77e4c (предположительно "хороший"). Была предпринята обычная настройка и сборка:

$ sh ./Configure -des -Dusedevel
$ make test_prep

make, однако, завершился неудачей с выводом (фрагмент) примерно таким:

cc -fstack-protector -L/usr/local/lib -o miniperl \
  gv.o toke.o perly.o pad.o regcomp.o dump.o util.o \
  mg.o reentr.o mro.o hv.o av.o run.o pp_hot.o sv.o \
  pp.o scope.o pp_ctl.o pp_sys.o doop.o doio.o regexec.o \
  utf8.o taint.o deb.o universal.o globals.o perlio.o \
  perlapi.o numeric.o mathoms.o locale.o pp_pack.o pp_sort.o  \
  miniperlmain.o opmini.o perlmini.o
pp.o: In function `Perl_pp_pow':
pp.c:(.text+0x2db9): undefined reference to `pow'
...
collect2: error: ld returned 1 exit status
makefile:348: recipe for target 'miniperl' failed
make: *** [miniperl] Error 1

Другой участник P5P рекомендовал установить и использовать Devel::PatchPerl в этой ситуации, сначала чтобы определить версию perl в рассматриваемом коммите, а затем чтобы исправить исходный код в этой точке для облегчения сборки.

$ perl -MDevel::PatchPerl -e \
    'print Devel::PatchPerl->determine_version("/path/to/sourcecode"), "\n";'
5.11.1
$ perl -MDevel::PatchPerl -e \
    'Devel::PatchPerl->patch_source("5.11.1", "/path/to/sourcecode");'

После того, как исходный код был исправлен, ./Configure и make test_prep были вызваны и успешно завершены, что позволило подтвердить результаты в RT #72414.

ДОПОЛНИТЕЛЬНАЯ ЛИТЕРАТУРА ДЛЯ ХАКЕРОВ

Чтобы взломать внутренности Perl, вам нужно будет прочитать следующее:

  • perlsource

    Обзор дерева исходных кодов Perl. Это поможет вам найти нужные файлы.

  • perlinterp

    Обзор исходного кода интерпретатора Perl и некоторые подробности о том, как Perl делает то, что он делает.

  • perlhacktut

    Этот документ описывает создание небольшого патча к C-коду Perl. Если вы только начинаете работать с Perl core hacking, это поможет вам понять, как это работает.

  • perlhacktips

    Более подробная информация о взломе ядра Perl. Этот документ сосредоточен на деталях более низкого уровня, таких как написание тестов, проблемы компиляции, переносимость, отладка и т.д.

    Если вы планируете заниматься серьезным C-хакингом, обязательно прочитайте это.

  • perlguts

    Это имеет первостепенное значение, поскольку это документация того, что находится где в исходном коде Perl. Прочтите это несколько раз, и это может начать иметь смысл - не беспокойтесь, если это еще не так, потому что лучший способ изучить это - читать его вместе с изучением исходного кода Perl, и мы сделаем это позже.

    "Иллюстрированный perlguts" Gisle Aas, также известный как illguts, содержит очень полезные изображения:

    https://search.cpan.org/dist/illguts/

  • perlxstut и perlxs

    Рабочее знание программирования XSUB невероятно полезно для взлома ядра; XSUB используют методы, взятые из кода PP, части внутренностей, которая фактически выполняет программу Perl. Гораздо проще изучить эти методы из простых примеров и объяснений, чем из самого ядра.

  • perlapi

    Документация для API Perl объясняет, что делают некоторые внутренние функции, а также многие макросы, используемые в исходном коде.

  • Porting/pumpkin.pod

    Это собрание мудрых слов для портера Perl; некоторые из них полезны только для владельца тыквы, но большинство из них применимо к любому, кто хочет заниматься разработкой Perl.

ТЕСТЕРЫ CPAN И КУРИЛЬЩИКИ PERL

Тестеры CPAN ( http://cpantesters.org/ ) — это группа добровольцев, которые тестируют модули CPAN на различных платформах.

Perl Smokers ( https://www.nntp.perl.org/group/perl.daily-build/ и https://www.nntp.perl.org/group/perl.daily-build.reports/ ) автоматически тестируют исходные релизы Perl на платформах с различными конфигурациями.

Оба проекта приветствуют добровольцев. Чтобы принять участие в дымовом тестировании самого Perl, посетите https://metacpan.org/release/Test-Smoke. Чтобы начать дымовое тестирование модулей CPAN, посетите https://metacpan.org/release/CPANPLUS-YACSmoke или https://metacpan.org/release/minismokebox или https://metacpan.org/release/CPAN-Reporter.

WHAT NEXT?

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

Вот ещё несколько рекомендаций

  • Подпишитесь на perl5-porters, следите за патчами и старайтесь понимать их; не бойтесь спрашивать, если есть часть, которая вам непонятна — кто знает, может быть, вы обнаружите ошибку в патче...

  • Прочитайте README, связанный с вашей операционной системой, например, README.aix в ОС IBM AIX. Не стесняйтесь предоставлять патчи к этому README, если вы обнаружите что-либо отсутствующее или измененное в новом релизе ОС.

  • Найдите область Perl, которая кажется вам интересной, и посмотрите, можете ли вы понять, как она работает. Просмотрите исходный код и пошагово пройдите его в отладчике. Играйте, копайте, исследуйте, экспериментируйте! Вероятно, вы поймете не только выбранную вами область, но и гораздо более широкий спектр деятельности perl, и, вероятно, быстрее, чем вы думаете.

"The Road goes ever on and on, down from the door where it began."

Если вы смогли сделать эти вещи, вы начали долгий путь к портированию Perl. Спасибо за желание помочь сделать Perl лучше — и счастливого хакинга!

Метафорические цитаты

Если вы узнали цитату о Дороге выше, вам повезло.

Большинство программных проектов начинают каждый файл с буквального описания цели каждого файла. Perl вместо этого начинает каждый файл с литературной аллюзией на цель этого файла.

Как главы во многих книгах, все исходные файлы Perl верхнего уровня (наряду с некоторыми другими здесь и там) начинаются с эпиграфической надписи, которая косвенно и метафорически намекает на материал, который вы собираетесь прочитать.

Цитаты взяты из сочинений Дж. Р. Р. Толкина, относящихся к его Легендариуму, почти всегда из Властелина колец. Номера глав и страниц приводятся с использованием следующих изданий:

  • Хоббит, Дж. Р. Р. Толкин. Было использовано твердое издание к 70-летию 2007 года, опубликованное в Великобритании издательством Harper Collins Publishers и в США издательством Houghton Mifflin Company.

  • Властелин колец, Дж. Р. Р. Толкин. Было использовано твердое издание к 50-летию 2004 года, опубликованное в Великобритании издательством Harper Collins Publishers и в США издательством Houghton Mifflin Company.

  • Песни Белерианда, Дж. Р. Р. Толкин, опубликовано посмертно его сыном и литературным исполнителем К. Дж. Р. Толкином, будучи 3-м из 12 томов в монументальной Истории Средиземья Кристофера. Номера страниц взяты из твердого переплета, впервые опубликованного в 1983 году издательством George Allen & Unwin; номера страниц не изменились для специального 3-томного собрания изданий 2002 года или различных изданий в мягкой обложке, все снова издательствами Harper Collins или Houghton Mifflin.

Другие книги Дж.Р.Р. Толкина, подходящие для цитат, включают Приключения Тома Бомбадила, Сильмариллион, Неоконченные сказания и История детей Хурина, все, кроме первой, собраны посмертно К.Дж.Р. Толкином. Но сам Властелин колец прекрасно подходит и, вероятно, лучше всего цитировать, при условии, что вы сможете найти там подходящую цитату.

Поэтому, если бы вы предоставили новый, полный исходный файл верхнего уровня для добавления в Perl, вы должны следовать этой своеобразной практике, самостоятельно выбрав подходящую цитату из Толкина, сохранив оригинальное написание и пунктуацию и используя тот же формат, что и у остальных цитат. Косвенный и непрямой подход вполне подходит; помните, это метафора, поэтому быть мета — это, в конце концов, то, для чего она предназначена.

АВТОР

Этот документ был первоначально написан Натаном Торкингтоном и поддерживается списком рассылки perl5-porters.

© 1993–2020 Larry Wall and others
Licensed under the GNU General Public License version 1 or later, or the Artistic License.
The Perl logo is a trademark of the Perl Foundation.
https://perldoc.perl.org/5.32.0/perlhack

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API