Dlaczego słowo kluczowe "pakiet" jest czasami oddzielone komentarzem od nazwy pakietu?

Question

źródła analizowanie modułów CPAN widzę coś takiego:

... 
package # hide from PAUSE 
    Try::Tiny::ScopeGuard; 
... 

Oczywiście, to pochodzący z Try::Tiny, ale widziałem tego rodzaju komentarzach między package Hasło i identyfikator pakietu w innych modułach też.

Dlaczego stosuje się tę procedurę? Jaki jest jego cel i jakie ma to zalety?

Answer 1

To rzeczywiście hack do ukrycia pakietu z indeksu PAUSE.

Po przesłaniu dystrybucji do PAUSE indeksator sprawdza każdy plik w przesyłanym pliku, szukając nazw pakietów zawartych w dystrybucji. Wszelkie indeksowane pakiety mogą pojawiać się w wynikach wyszukiwania CPAN.

Istnieje wiele powodów, dla których indeksowanie nie powinno być wykrywane. Twoja dystrybucja może zawierać wiele małych lub nieistotnych pakietów, które mogłyby zaśmiecić wyniki wyszukiwania twojego modułu. Możesz mieć pakiety zdefiniowane w twoim katalogu t (test) lub innym niestandardowym katalogu, który nie jest instalowany jako część dystrybucji. Twoja dystrybucja może zawierać pliki z zupełnie innej dystrybucji (napisanej przez kogoś innego).

Hack działa, ponieważ indeksator ściśle szuka słowa kluczowego package i wyrażenie, które wygląda jak nazwa pakietu w tym samym wierszu.

Obecnie możesz dołączyć do swojej dystrybucji plik META.yml. Indeksator PAUSE będzie szukać i respektować specyfikację no_index w tym pliku. Ale jest to względnie nowa funkcja indeksera, więc starsze moduły i współtwórcy starszego modułu CPAN będą nadal używać hackowania linii.

Oto przykład no_index specyfikacji z Forks::Super

no_index: 
    directory: 
     - t 
     - inc 
    package: 
     - Sys::CpuAffinity 
     - Signals::XSIG 
     - Signals::XSIG::Default 
     - Signals::XSIG::TieArray56 

Sys::CpuAffinity i Signals::XSIG są oddzielne dystrybucji, które są również dostarczone z Forks::Super. Niektóre skrypty testowe zawierają deklaracje package (np. Arbitrary::Test::Package), które nie powinny być indeksowane.

Answer 2

Okay, oto kolejny urywek tego fenomenu ... Od kilkunastu lat hołubię Perla, rzadko widywałem tego paczkę i być może po prostu zignorowałem i nigdy nie zawracałem sobie głowy badaniem. Jedno wydaje się jednak jasne. W PAUSE dzieje się coś hackerskiego, które zostało stworzone w dobrej myśli Perl'n'UNIX, która bez cienia wątpliwości obejmuje liniowe przetwarzanie tekstu, więc parsują te pliki Perla, być może nawet używając grep, ale raczej perl sam, kto wie, aby wyodrębnić nazwy pakietów, a następnie kopnąć z jakiejś procedury lub uzyskać pewne statystyki lub cokolwiek innego. I potknąć się o tę procedurę i zhakować się po niej, autor dzieli deklarację paczki na dwie linijki, więc niełatwa praca grep nie ma pojęcia, że ​​paczka jest zadeklarowana tuż pod jego nosem, a programista jest szczęśliwy z powodu swoich hakowatych umiejętności a statystyki PAUSE lub cokolwiek to jest, że są razem, są takie, jakie być powinny. Czy to ma sens?