Mis apuntes · Aprende awk desde PHP

Se guardan solos en este navegador mientras escribes. Puedes usar Markdown. Al descargarlos, la primera línea es tu enlace personal al curso.

Lección 12 de 31 · Variables y control ✦ WebMCP implementado

printf: informes alineados

9 min de lectura 4 retos

print es rápido, pero imprime los números como le parece y no sabe alinear. Para un informe que se lea bien (columnas rectas, dos decimales, bytes en KB) está printf. Buena noticia: es el mismo printf() de PHP, con las mismas letras. Solo cambian dos detalles.

¿De dónde vienen los nombres?

printf = inglés print formatted (imprimir con formato)
Imprime siguiendo una plantilla con huecos. Viene del lenguaje C, igual que el printf() de PHP: por eso se parecen tanto.
sprintf = string printf
Hace lo mismo, pero en vez de imprimir devuelve el texto para que lo guardes en una variable. Es el sprintf() de PHP.
%s = string (texto)
Un hueco para un texto.
%d = decimal (número en base 10, sin decimales)
Un hueco para un número entero. El nombre confunde: «decimal» aquí es «en base diez», no «con decimales».
%f = floating point (coma flotante)
Un hueco para un número con decimales. Es el tipo float de PHP.
KB y MB = kilobyte y megabyte
Del griego khilioi (mil) y megas (grande). En informática 1 KB son 1024 bytes y 1 MB son 1024 KB (1 048 576 bytes).
En 4 ideas
1/4

En PHP printf("%s\n", $ip); lleva paréntesis y punto y coma. En awk es printf "%s\n", $1: mismas letras, sin paréntesis obligatorios y sin ;.

1 · printf no salta de línea

Primera diferencia con print, y la que más despista. Ejecuta esto:

awkprograma.awk
# En PHP: printf("%s ", $campos[0]);
{ printf "%s ", $1 }
# En PHP: echo PHP_EOL;
END { printf "\n" }
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Las 20 IP salen en una sola línea. print añade un salto de línea al final; printf imprime exactamente lo que le pides y ni un carácter más. Si quieres salto, lo escribes tú: \n. Es como dictar a alguien que escribe al pie de la letra: si no dices «punto y aparte», sigue en el mismo renglón.

PHP 8.5visitas.php
<?php
foreach (file("access.log", FILE_IGNORE_NEW_LINES) as $linea) {
    $campos = preg_split('/\s+/', trim($linea));
    // %s es un hueco para un texto; \n es el salto de línea
    printf("%s -> %s\n", $campos[0], $campos[6]);
}
awkprograma.awk
# En PHP: printf("%s -> %s\n", $campos[0], $campos[6]);
{ printf "%s -> %s\n", $1, $7 }
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Medido en el servidor del curso con access.log multiplicado hasta 1.000.000 líneas: PHP 8.5: 1,70 s · gawk: 619 ms · mawk: 570 ms. awk tarda 3,0 veces menos que PHP.

Quita los paréntesis y el punto y coma al de PHP y tienes el de awk. Lo primero es el formato (la plantilla, entre comillas dobles) y después, separados por comas, los valores que rellenan los huecos.

¿Por qué? · En PHP no existe

¿Por qué print salta de línea y printf no?

Porque son dos herramientas para dos momentos. print es para ir rápido: una línea del log, una línea de salida. printf es para cuando quieres controlar cada carácter, y eso incluye decidir dónde acaba la línea.

Sin salto automático puedes construir una línea a trozos: imprimir la IP ahora y el resto más tarde, o varias cosas seguidas dentro de un bucle. En PHP es la misma pareja: echo $x, PHP_EOL; frente a printf().

El fallo que trae: olvidar el \n. No da error; la salida sale toda pegada en un renglón. Si ves eso, ya sabes qué falta.

2 · Los huecos: %s, %d, %f y %%

El formato es como un impreso con casillas: «D./Dña. ____, con DNI ____». Cada % seguido de una letra es una casilla, y la letra dice qué clase de dato va dentro. Los valores se colocan en orden: el primero en el primer hueco, el segundo en el segundo.

HuecoPara quéEjemploSale
%sUn texto, tal cualprintf "%s", "/login"/login
%dUn número sin decimales (los corta)printf "%d", 17.817
%fUn número con decimales (6 si no dices cuántos)printf "%f", 17.817.800000
%.1fCon los decimales que tú digas, redondeandoprintf "%.1f", 17.8617.9
%%Un signo % de verdadprintf "%d%%", 4040%
awkprograma.awk
NR <= 3 {
    # En PHP: printf("%s respondio %d con %d bytes\n", $ip, $estado, $bytes);
    printf "%s respondio %d con %d bytes\n", $1, $9, $10
}
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Y la diferencia entre las tres letras, con el mismo número: los 18230 bytes de la hoja de estilos pasados a KB.

awkprograma.awk
BEGIN {
    kb = 18230 / 1024
    # print decide por ti: 6 cifras
    print kb
    # %d corta los decimales, no redondea
    printf "%d\n", kb
    # %f pone 6 decimales
    printf "%f\n", kb
    # %.2f deja 2 y redondea
    printf "%.2f\n", kb
    # %s lo trata como texto
    printf "%s KB\n", kb
}
$ awk -f programa.awk
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. Sin fichero de datos: este programa solo tiene BEGIN, así que no lee nada.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

¿Por qué? · En PHP no existe

¿Por qué no debo escribir printf $7 a secas?

Porque lo primero que recibe printf es el formato, y un dato del log puede llevar un % dentro. Una URL como /oferta-100%-gratis o /buscar?q=hola%20mundo es de lo más normal.

Si pones el dato como formato, awk ve ese %, cree que es un hueco, busca un valor que no existe y el programa muere a mitad del log:

awkprograma.awkSolo lectura: este programa falla a propósito
BEGIN {
    url = "/oferta-100%-gratis"
    # MAL: el dato hace de formato
    printf url
}
$ gawk -f programa.awk
gawk: programa.awk:3: fatal: not enough arguments to satisfy format string

La regla es la misma que en PHP con printf($url): el formato lo escribes tú, y los datos van siempre en un hueco. printf "%s\n", $7 no falla nunca, traiga lo que traiga la URL.

3 · Decimales: de bytes a KB y MB

El log guarda el tamaño en bytes, y 1048576 no hay quien lo lea. Dividir es fácil: entre 1024 salen KB y entre 1048576 (1024 × 1024) salen MB. El problema era imprimirlo, porque la división da decimales de sobra. Con %.1f te quedas con uno.

awkprograma.awk
{ total_bytes += $10 }
# solo las respuestas de mas de 15000 bytes
$10 > 15000 {
    # En PHP: printf("%s %.1f KB\n", $url, $bytes / 1024);
    printf "%s %.1f KB\n", $7, $10 / 1024
}
END {
    # En PHP: printf("Total: %.2f MB\n", $total_bytes / 1048576);
    printf "Total: %.2f MB\n", total_bytes / 1048576
}
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

El número detrás del punto son los decimales: %.1f uno, %.2f dos, %.0f ninguno. A diferencia de %d y de int(), que cortan, %.0f redondea: con 17.8, %d da 17 y %.0f da 18.

QuieresPHPawk
Dos decimalesnumber_format($n, 2, ".", "") o printf("%.2f", $n)printf "%.2f", n
Redondear a enteroround($n)printf "%.0f", n
Cortar los decimales(int) $nprintf "%d", n o int(n)

4 · Alinear columnas: el ancho

Un número entre el % y la letra es el ancho mínimo: cuántos caracteres ocupa el hueco como poco. Si el dato es más corto, awk rellena con espacios. Las barras | de este ejemplo están solo para que veas dónde empieza y acaba cada hueco:

awkprograma.awk
BEGIN {
    # ancho 8: rellena por la izquierda (el dato queda a la derecha)
    printf "|%8d|\n", 153
    # con un menos: el dato queda a la izquierda
    printf "|%-8d|\n", 153
    # con un cero delante: rellena con ceros
    printf "|%05d|\n", 153
    # con textos funciona igual
    printf "|%15s|\n", "192.0.2.55"
    printf "|%-15s|\n", "192.0.2.55"
    # ancho 8 en total, 2 de ellos decimales
    printf "|%8.2f|\n", 17.802734
}
$ awk -f programa.awk
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. Sin fichero de datos: este programa solo tiene BEGIN, así que no lee nada.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

FormatoQué haceEn PHP
%8dAncho 8, pegado a la derecha (lo normal para números: las unidades quedan debajo de las unidades)str_pad($n, 8, " ", STR_PAD_LEFT)
%-15sAncho 15, pegado a la izquierda (lo normal para textos)str_pad($s, 15)
%05dAncho 5, relleno con cerosstr_pad($n, 5, "0", STR_PAD_LEFT)
%8.2fAncho 8 en total (contando el punto) y 2 decimalessprintf("%8.2f", $n)

Ahora el log, en columnas. La IP más larga posible (255.255.255.255) tiene 15 caracteres: por eso su hueco es %-15s.

awkprograma.awk
# En PHP: printf("%-15s %3d %8d  %s\n", $ip, $estado, $bytes, $url);
{ printf "%-15s %3d %8d  %s\n", $1, $9, $10, $7 }
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

5 · sprintf: guardar en vez de imprimir

sprintf usa el mismo formato, pero no imprime nada: te devuelve el texto. Sirve para preparar un trozo y usarlo después. Aquí los paréntesis sí son obligatorios, porque es una función que devuelve algo, igual que en PHP.

awkprograma.awk
{ total_bytes += $10 }
END {
    # En PHP: $tamano = sprintf("%.2f MB", $total_bytes / 1048576);
    tamano = sprintf("%.2f MB", total_bytes / 1048576)
    print "Hoy se han servido " tamano " en " NR " visitas"
}
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

También es la forma de redondear un número y seguir haciendo cuentas con él: media = sprintf("%.1f", total / NR) + 0. El + 0 de la lección anterior lo vuelve a convertir en número.

6 · Un informe con cabecera y total

Juntando todo sale un informe de verdad. El truco para que la cabecera cuadre con los datos: usar los mismos anchos en las tres reglas. En la cabecera los huecos son %s (son textos) y en las filas %d y %.1f, pero el número del ancho no cambia.

awkprograma.awk
BEGIN {
    # la cabecera se imprime una vez, antes de leer el log
    printf "%-15s %6s %8s\n", "IP", "ESTADO", "KB"
}
$9 >= 400 {
    printf "%-15s %6d %8.1f\n", $1, $9, $10 / 1024
    errores++
    total_bytes += $10
}
END {
    # el total, con los mismos anchos
    printf "%-15s %6d %8.1f\n", "TOTAL", errores, total_bytes / 1024
}
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

BEGIN pone los títulos, la regla del medio imprime una fila por cada error y va sumando, y END cierra con el total. Es el esqueleto de casi cualquier informe en awk, y el que usarás en el proyecto final.

La pregunta que te vas a hacer

¿Es exactamente el printf() de PHP? ¿Qué le falta?

Las letras y los anchos de esta lección funcionan igual en los dos. Las diferencias que te vas a encontrar:

  • En awk no hay number_format(): no pone puntos de miles. 1166236 sale así, todo seguido.
  • PHP deja elegir el carácter de relleno (%'*10s rellena con asteriscos). En awk solo hay espacios o ceros.
  • PHP lanza ArgumentCountError si faltan valores. gawk y mawk también se paran, cada uno con su mensaje.
  • Los textos con tildes o eñes pueden descuadrar una columna en algunos awk, que cuentan bytes y no letras. En los informes del curso las columnas con ancho llevan IP, números y URL, que no tienen tildes.

Hora de practicar

Retos · 0/4 resueltos

Reto 1 de 4

Una línea por visita

El programa quiere imprimir una línea por visita con la IP, la página y el estado entre paréntesis, así: 203.0.113.7 -> / (200). Ejecútalo: sale todo pegado en un solo renglón. Arréglalo. Es el printf("%s -> %s (%d)\n", $ip, $url, $estado); de PHP.

Al pulsar Comprobar, tu programa se ejecuta en tu navegador con el fichero que ves y con otro distinto que no ves: tiene que acertar con los dos.

awkprograma.awk · editable
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Resumen

Lo que te llevas de esta lección

  1. printf "formato", valor1, valor2 es el printf("formato", $valor1, $valor2); de PHP: mismas letras, sin paréntesis obligatorios.
  2. printf no añade el salto de línea: lo pones tú con \n. print sí lo añade, como echo …, PHP_EOL;.
  3. %s texto, %d entero (corta), %f decimales, %.2f dos decimales redondeando (tu number_format($n, 2)), %% un % de verdad.
  4. El ancho va entre el % y la letra: %-15s a la izquierda, %8d a la derecha, %05d con ceros. Es el str_pad() de PHP dentro del formato.
  5. sprintf(...) devuelve el texto en vez de imprimirlo, como en PHP: tamano = sprintf("%.2f MB", total_bytes / 1048576).
  6. Los datos del log van siempre en un hueco (printf "%s\n", $7), nunca como formato: una URL con % rompería el programa.

Para recordarlo: «El menos, a la izquierda; el punto, los decimales; la ene, el salto»

-A la izquierda
%-15s
.Decimales
%.2f
\nSalto de línea
siempre al final

Tres signos y ya sabes leer cualquier formato: %-15s (el menos pega el dato a la izquierda), %.2f (lo de detrás del punto son los decimales) y \n al final, porque printf no salta de línea solo.

Los programas se ejecutan con GNU awk 5.4.1 compilado a WebAssembly, software libre con licencia GPL-3.0. Código fuente: gawk en ftp.gnu.org · receta de compilación.