Capitolo 7. Nomi di file e corrispondenze di pattern

Indice

Denominazione semplice dei file
Eseguire comandi senza nomi di file
Mercurial vi dice cosa sta succedendo
Usare i pattern per identificare i file
I pattern glob sullo stile della shell
Fate attenzione!
Corrispondenze di espressioni regolari con i pattern re
Filtrare i file
Ignorare permanentemente file e directory indesiderate
Sensibilità alle maiuscole
Memorizzazione del repository sicura e portabile
Riconoscere i conflitti tra maiuscole e minuscole
Correggere un conflitto tra maiuscole e minuscole

Mercurial fornisce meccanismi che vi permettono di lavorare con i nomi dei file in modo coerente ed espressivo.

Denominazione semplice dei file

A livello di implementazione, Mercurial usa un unico meccanismo per gestire i nomi dei file. Tutti i comandi si comportano in maniera uniforme rispetto ai nomi dei file e lavorano nel modo seguente.

Se indicate esplicitamente nomi di file esistenti sulla riga di comando, Mercurial lavora esattamente con quei file, come vi aspettereste.

$ hg add COPIARE LEGGIMI esempi/semplice.py

Quando fornite un nome di directory, Mercurial interpreterà questa azione come la volontà di «operare su tutti i file in questa directory e nelle sue sottodirectory». Mercurial considera i file e le sottodirectory in una directory secondo l’ordine alfabetico. Quando incontra una sottodirectory, attraverserà quella sottodirectory prima di continuare con la directory corrente.

$ hg status sorgenti
? sorgenti/principale.py
? sorgenti/controllore/_controllore.c
? sorgenti/controllore/controllore.py
? sorgenti/xyzzy.txt

Eseguire comandi senza nomi di file

I comandi Mercurial che lavorano con i nomi di file assumono un utile comportamento predefinito quando li invocate senza passare alcun nome di file o pattern. Il comportamento che dovreste aspettarvi dipende dalla funzione del comando. Ecco alcune regole pratiche che potete usare per predire quello che un comando probabilmente farà se non gli date alcun nome con cui lavorare.

  • La maggior parte dei comandi opererà sull’intera directory di lavoro. Per esempio, questo è quello che fa il comando hg add.

  • Se gli effetti di un comando sono difficili o impossibili da invertire, sarete obbligati a fornirgli esplicitamente almeno un nome o un pattern (si veda più avanti). Questo vi protegge, per esempio, dalla cancellazione accidentale dei file causata da un’esecuzione di hg remove senza argomenti.

Se questi comportamenti predefiniti non vi soddisfano, è facile aggirarli. Se normalmente un comando opera sull’intera directory di lavoro, potete passargli il nome «.» per invocarlo solo sulla directory corrente e sulle sue sottodirectory.

$ cd sorgenti
$ hg add -n
aggiungo ../MANIFEST.in
aggiungo ../esempi/efficiente.py
aggiungo ../setup.py
aggiungo principale.py
aggiungo controllore/_controllore.c
aggiungo controllore/controllore.py
aggiungo xyzzy.txt
$ hg add -n .
aggiungo principale.py
aggiungo controllore/_controllore.c
aggiungo controllore/controllore.py
aggiungo xyzzy.txt

Sulla stessa falsariga, alcuni comandi normalmente stampano nomi di file relativi alla radice del repository anche quando li invocate da una sottodirectory. Questi comandi stamperanno nomi di file relativi alla vostra sottodirectory se passate loro nomi espliciti. Qui di seguito eseguiremo hg status da una sottodirectory e lo faremo agire sull’intera directory di lavoro pur stampando nomi di file relativi alla nostra sottodirectory, passandogli il risultato del comando hg root.

$ hg status
A COPIARE
A LEGGIMI
A esempi/semplice.py
? MANIFEST.in
? esempi/efficiente.py
? setup.py
? sorgenti/principale.py
? sorgenti/controllore/_controllore.c
? sorgenti/controllore/controllore.py
? sorgenti/xyzzy.txt
$ hg status `hg root`
A ../COPIARE
A ../LEGGIMI
A ../esempi/semplice.py
? ../MANIFEST.in
? ../esempi/performante.py
? ../setup.py
? principale.py
? controllore/_controllore.c
? controllore/controllore.py
? xyzzy.txt

Mercurial vi dice cosa sta succedendo

L’esempio di hg add nella sezione precedente illustra qualcos’altro che è utile sapere sui comandi Mercurial. Se un comando opera su un file che non avete nominato esplicitamente sulla riga di comando, di solito stamperà il nome del file in modo che non veniate sorpresi da quello che sta succedendo.

In questo caso, Mercurial segue il principio della minima sorpresa. Se avete fornito il nome esatto di un file sulla riga di comando, non ha senso ripetervelo. Se Mercurial sta agendo implicitamente su un file, per esempio perché non avete fornito alcun nome, o su una directory, o su un pattern (si veda più avanti), ritiene sia più sicuro farvi sapere su quali file sta lavorando.

Potete ridurre al silenzio i comandi che si comportano in questo modo usando l’opzione -q. Potete anche dire loro di stampare il nome di tutti i file, anche quelli che avete nominato esplicitamente, usando l’opzione -v.

Usare i pattern per identificare i file

Oltre a lavorare con i nomi di file e directory, Mercurial vi consente di usare i pattern per identificare i file. La gestione dei pattern da parte di Mercurial è espressiva.

Su sistemi di tipo Unix (Linux, Mac OS X, etc.), di solito è la shell che si occupa di trovare le corrispondenze tra i pattern e i nomi dei file. Su questi sistemi, dovete esplicitamente dire a Mercurial che un nome è un pattern. Su Windows, la shell non si occupa di espandere i pattern, quindi Mercurial identificherà automaticamente i nomi che sono pattern e li espanderà per voi.

Per fornire un pattern al posto di un nome ordinario sulla riga di comando, il meccanismo è semplice:

sintassi:corpodelpattern

Quindi, un pattern viene identificato da una breve stringa di testo che indica il tipo del pattern, seguita dai due punti, seguiti dall’effettivo pattern.

Mercurial supporta due tipi di sintassi per i pattern. Quello usato più spesso è chiamato glob: è lo stesso tipo di pattern usato dalla shell Unix e dovrebbe essere familiare anche agli utenti del prompt dei comandi di Windows.

Quando Mercurial effettua la corrispondenza automatica di un pattern su Windows, usa la sintassi glob. Quindi, potete omettere il prefisso «glob:» su Windows, ma se volete potete anche usarlo tranquillamente.

La sintassi re è più potente perché vi permette di specificare i pattern usando le espressioni regolari, indicate a volte con il termine regexp.

Notate che, negli esempi che seguono, farò molta attenzione a racchiudere tutti i miei pattern tra caratteri di apice, in modo che non vengano espansi dalla shell prima che Mercurial li veda.

I pattern glob sullo stile della shell

Questa è un’introduzione ai tipi di pattern che potete usare quando state cercando una corrispondenza con un pattern di tipo glob.

Il carattere «*» corrisponde a qualsiasi stringa all’interno di una singola directory.

$ hg add 'glob:*.py'
aggiungo principale.py

Il pattern «**» corrisponde a qualsiasi stringa e attraversa i confini delle directory. Non è un simbolo di tipo glob standard su Unix, ma viene accettato da diverse shell Unix popolari ed è molto utile.

$ cd ..
$ hg status 'glob:**.py'
A esempi/semplice.py
A sorgenti/principale.py
? esempi/efficiente.py
? setup.py
? sorgenti/controllore/controllore.py

Il pattern «?» corrisponde a qualsiasi carattere singolo.

$ hg status 'glob:**.?'
? sorgenti/controllore/_controllore.c

Il carattere «[» comincia una classe di caratteri. Questo pattern corrisponde a qualsiasi carattere compreso nella classe. La classe viene terminata da un carattere «]». Una classe può contenere molteplici intervalli della forma «a-f», che è una abbreviazione per «abcdef».

$ hg status 'glob:**[nr-t]'
? MANIFEST.in
? sorgenti/xyzzy.txt

Se il primo carattere dopo «[» in una classe di caratteri è «!», si ottiene l’effetto di negare la classe, facendola corrispondere a qualsiasi carattere non compreso nella classe.

Un carattere «{» comincia un gruppo di sottopattern, che trova una corrispondenza se un qualsiasi sottopattern nel gruppo trova una corrispondenza. Il carattere «,» separa i sottopattern e il carattere «}» termina il gruppo.

$ hg status 'glob:*.{in,py}'
? MANIFEST.in
? setup.py

Fate attenzione!

Non dimenticate che, se volete trovare corrispondenze a un pattern in qualsiasi directory, non dovreste usare il simbolo «*», dato che questo troverà corrispondenze solo in una directory, ma dovreste usare il simbolo «**». Questo piccolo esempio illustra la differenza tra i due.

$ hg status 'glob:*.py'
? setup.py
$ hg status 'glob:**.py'
A esempi/semplice.py
A sorgenti/principale.py
? esempi/efficiente.py
? setup.py
? sorgenti/controllore/controllore.py

Corrispondenze di espressioni regolari con i pattern re

Mercurial accetta la stessa sintassi per le espressioni regolari che viene usata dal linugaggio di programmazione Python (usa internamente il motore di regexp di Python). Questa sintassi è basata su quella del linguaggio Perl, che è il dialetto più popolare attualmente in uso (è anche utilizzato in Java, per esempio).

Non discuterò alcun dettaglio del dialetto di regexp di Mercurial in questo libro, dato che le espressioni regolari non vengono usate molto spesso. Le regexp in stile Perl sono comunque già documentate in maniera esauriente su una moltitudine di siti web e in numerosi libri. Invece, qui mi concentrerò su alcune cose che dovreste sapere se vi trovate ad aver bisogno di usare le espressioni regolari con Mercurial.

Un’espressione regolare cerca una corrispondenza con un intero nome di file, relativo alla radice del repository. In altre parole, anche se siete già nella sottodirectory foo, se volete una corrispondenza con i file in questa directory il vostro pattern dovrà cominciare con «foo/».

Una cosa da notare, se avete familiarità con le regexp in stile Perl, è che le espressioni regolari di Mercurial sono vincolate, nel senso che un’espressione regolare cerca una corrispondenza partendo sempre dall’inizio di una stringa e non da altre posizioni all’interno della stringa. Per cercare una corrispondenza in qualsiasi punto della stringa, il vostro pattern deve cominciare con «.*».

Filtrare i file

Mercurial non vi fornisce solo una varietà di modi per specificare i file, ma vi permette di vagliare ulteriormente quei file usando i filtri. I comandi che lavorano con i nomi dei file accettano due opzioni di filtraggio.

  • L’opzione -I, o --include, vi permette di specificare un pattern a cui i nomi dei file devono corrispondere per poter essere elaborati.

  • L’opzione -X, o --exclude, vi fornisce un modo per evitare di elaborare i file che corrispondono a questo pattern.

Potete passare più opzioni -I e -X sulla riga di comando e alternarle come preferite. Mercurial interpreta i pattern che riceve usando la sintassi glob per default (ma potete usare le espressioni regolari se ne avete bisogno).

Potete interpretare un filtro -I come una richiesta di «elaborare solo i file che corrispondono a questo filtro».

$ hg status -I '*.in'
? MANIFEST.in

L’interpretazione migliore del filtro -X è quella di una richiesta di «elaborare solo i file che non corrispondono a questo pattern».

$ hg status -X '**.py' sorgenti
? sorgenti/controllore/_controllore.c
? sorgenti/xyzzy.txt

Ignorare permanentemente file e directory indesiderate

Quando create un nuovo repository, è possibile che nel tempo cresca fino a contenere file che non dovrebbero essere gestiti da Mercurial, ma che non vorreste vedere elencati ogni volta che invocate hg status. Per esempio, i «prodotti di assemblaggio» sono file che vengono creati come parte dell’assemblaggio di un progetto ma che non dovrebbero essere gestiti da un sistema di controllo di revisione. I prodotti di assemblaggio più comuni sono i file di elaborazione generati da strumenti software come i compilatori. Un altro esempio sono i file di bloccaggio, i file di lavoro temporanei e i file di backup che gli editor di testo disseminano per le directory e che non ha alcun senso gestire.

Per fare in modo che Mercurial ignori permanentemente quei file, create un file chiamato .hgignore alla radice del vostro repository. Dovreste registrare questo file tramite hg add in modo che Mercurial ne tenga traccia insieme al resto dei contenuti del vostro repository, dato che anche i vostri collaboratori potrebbero trovarlo utile.

Mercurial si aspetta che il file .hgignore contenga una lista di espressioni regolari, una per riga. Le righe vuote vengono saltate. La maggior parte delle persone preferisce descrivere i file che vuole ignorare utilizzando la sintassi «glob» che abbiamo descritto in precedenza, quindi un tipico file .hgignore comincerà con questa direttiva:

syntax: glob

Questa riga dice a Mercurial di interpretare le righe che seguono come pattern di tipo glob, non espressioni regolari.

Ecco un esempio di un tipico file .hgignore.

syntax: glob
# Questa riga è un commento e verrà saltata.
# Anche le righe vuote vengono saltate.

# File di backup lasciati dall'editor Emacs.
*~

# File di bloccaggio usati dall'editor Emacs.
# Notate che il carattere "#" è preceduto da un backslash.
# Questo evita che venga interpretato come l'inizio di un commento.
.\#*

# File temporanei usati dall'editor vim.
.*.swp

# Un file nascosto creato dal Finder di Mac OS X.
.DS_Store

Sensibilità alle maiuscole

Se state lavorando in un ambiente di sviluppo misto che contiene sia sistemi Linux (o di tipo Unix) che Mac e Windows, dovreste tenere a mente che questi sistemi trattano le lettere maiuscole («N» rispetto a «n») nei nomi dei file in modi incompatibili tra loro. È improbabile che questo abbia effetti su di voi ed è facile occuparsene quando succede, ma potrebbe sorprendervi se non lo sapete.

I sistemi operativi e i file system differiscono nel modo in cui gestiscono le maiuscole dei caratteri nei nomi di file e directory. Esistono tre modi comuni di gestire le maiuscole nei nomi.

  • Completa insensibilità alle maiuscole. Le versioni maiuscole e minuscole di una lettera sono trattate come se fossero identiche, sia quando un file viene creato sia durante i successivi accessi. Questo è il funzionamento comune dei vecchi sistemi basati su DOS.

  • Conservazione delle maiuscole, ma insensibilità a esse. Quando un file o una directory vengono creati, le maiuscole nel loro nome vengono memorizzate e possono essere recuperate e visualizzate dal sistema operativo. Quando un file esistente viene cercato, le maiuscole nel suo nome vengono ignorate. Questa è la situazione standard su Windows e MacOS. I nomi foo e FoO identificano lo stesso file. Questo trattamento intercambiabile delle lettere maiuscole e minuscole è anche chiamato ripiegamento delle maiuscole (in inglese, case folding).

  • Sensibilità alle maiuscole. Le lettere maiuscole di un nome sono significative in ogni momento. I nomi foo e FoO identificano due file differenti. Questo è il modo in cui i sistemi Linux e Unix lavorano normalmente.

Su sistemi di tipo Unix è possibile avere uno qualsiasi o tutti e tre i modi di gestire le maiuscole in azione allo stesso tempo. Per esempio, se usate Linux per operare su una chiave USB formattata con un file system FAT32, il sistema operativo gestirà i nomi su quel file system in modo da conservare le maiuscole senza essere sensibile a esse.

Memorizzazione del repository sicura e portabile

Il meccanismo di memorizzazione dei repository Mercurial è sicuro per le maiuscole. Traduce i nomi dei file in modo che possano essere memorizzati senza problemi sia su file system sensibili alle maiuscole sia su quelli insensibili alle maiuscole. Questo significa che, per esempio, potete usare i normali strumenti per la copia di file per trasferire un repository Mercurial su una chiave USB, e spostare la chiave e il repository avanti e indietro tra un Mac, un PC con Windows e una macchina Linux senza problemi.

Riconoscere i conflitti tra maiuscole e minuscole

Quando opera sulla directory di lavoro, Mercurial segue la politica di denominazione del file system su cui la directory di lavoro si trova. Se il file system conserva le maiuscole ma è insensibile a esse, Mercurial tratterà i nomi che differiscono solo per le maiuscole come se fossero uguali.

È importante ricordare che questo approccio permette di eseguire su un file system sensibile alle maiuscole (tipicamente Linux o Unix) il commit di un changeset che creerà problemi per gli utenti di file system insensibili alle maiuscole (di solito Windows e MacOS). Se un utente Linux inserisce nel repository le modifiche a due file, uno chiamato miofile.c e l’altro chiamato MioFile.c, questi file verranno memorizzati correttamente. E gli stessi file verranno correttamente rappresentati come due file separati nella directory di lavoro di altri utenti Linux.

Se un utente Windows o Mac estrae questo changeset, inizialmente non avrà alcun problema, perché il meccanismo di memorizzazione di un repository Mercurial è sicuro per le maiuscole. Tuttavia, appena tenta di aggiornare la directory di lavoro a quel changeset tramite hg update, o di unire il proprio lavoro con quel changeset tramite hg merge, Mercurial individuerà il conflitto tra i due nomi di file che il file system tratterebbe come lo stesso nome e impedirà all’aggiornamento o all’unione di avvenire.

Correggere un conflitto tra maiuscole e minuscole

Se state usando Windows o Mac in un ambiente misto dove alcuni dei vostri collaboratori usano Linux o Unix, e Mercurial riporta un conflitto di ripiegamento delle maiuscole quando provate a eseguire hg update o hg merge, la procedura per correggere il problema è semplice.

Trovate la macchina Linux o Unix più vicina, clonatevi il repository problematico e usate il comando hg rename di Mercurial per cambiare i nomi di qualsiasi file o directory che crea complicazioni, in modo da non causare più alcun conflitto di ripiegamento delle maiuscole. Inserite queste modifiche nel repository, eseguite hg pull o hg push attraverso i vostri sistemi Windows o MacOS e usate hg update per aggiornare la directory di lavoro alla revisione che contiene i nomi senza conflitti.

Il changeset con i nomi in conflitto rimarrà nella cronologia del vostro progetto e non sarete comunque in grado di usare hg update per aggiornare la directory di lavoro a quel changeset su un sistema Windows o MacOS, ma potrete continuare a sviluppare senza impedimenti.

Volete rimanere aggiornati? Abbonatevi al feed delle modifiche per il libro italiano.

Copyright 2006, 2007, 2008, 2009 Bryan O’Sullivan. Icone realizzate da Paul Davey alias Mattahan.

Copyright 2009 Giulio Piancastelli per la traduzione italiana.