Configuración de usuario de un script de shell. ¿Mejores prácticas?

¿Qué esperaría de un programa sano (un script de shell o no)?

• Nunca nunca tengo que modificar el archivo ejecutable para simplemente configurarlo. Esto no es un núcleo de sistema operativo.
• Puedo pasar cualquier configuración utilizando la línea de comandos. Esta es una necesidad para cada pieza de información que no tenga un valor predeterminado razonable. La única excepción es una contraseña que necesita una entrada interactiva.
• Opcionalmente, puedo pasar una configuración usando una variable de entorno.
• Puedo escribir las configuraciones en un archivo de configuración, y este archivo se usará si está presente con un nombre conocido, o se señala explícitamente mediante los dos métodos anteriores.
• El archivo de configuración usa los mismos nombres de configuración y sintaxis como línea de comando.

Cuando necesito escribir un script elaborado con varias opciones de configuración, uso Python con argparse y ConfigParser bibliotecas. Esos ayudan con la implementación, pero el proceso se aplica a cualquier script de shell:

1. Busque un archivo de configuración. Si existe una, lea cualquier configuración que tenga en una tabla de búsqueda / diccionario.
2. Analizar los argumentos de línea de comando nombrados. Para cada argumento proporcionado, invalide el valor cargado del archivo de configuración si existe. Para cualquier argumento que no se haya pasado en la línea de comandos y no en la configuración, use un valor predeterminado.
3. Ejecutar la función principal del script
4. Si el archivo de configuración no existe, escriba los valores pasados y / o predeterminados en él.

Mi preferencia es que un archivo de configuración contenga las opciones preferidas cuando se va a utilizar el script repetidamente, pero permita que se invaliden los argumentos de la línea de comandos. Escriba el archivo de configuración utilizando esos parámetros la primera vez que se ejecuta. El archivo de configuración se puede compartir y enviar a un repositorio de código.

En mi caso más reciente, también escribí los valores predeterminados en la sección [DEFAULT] en la parte superior del archivo de configuración, luego tuve una sección para cada "entorno" con las sustituciones apropiadas para cada uno. El "entorno" es el primer parámetro sin nombre del script. Entonces, en este caso, los parámetros se eligen como integrado por defecto - > archivo predeterminado de configuración - > valor de la sección del archivo de configuración - > parámetro de línea de comando . Un parámetro de línea de comando adicional ofrece la opción de sobrescribir la configuración existente con el valor de la última ejecución. Este archivo de configuración está escrito en el directorio actual por lo que se aplica por proyecto y se puede confirmar con el resto del código. Cualquier persona que revise el mismo proyecto comenzará con la misma configuración.

La edición de marcadores de posición es propensa a errores.

Me gustaría usar un archivo de configuración.

Su preocupación acerca de la dependencia es válida, sin embargo, no recuerdo haber usado demasiadas herramientas que estén compuestas por un solo archivo. Por lo tanto, teóricamente tienes razón, pero en la práctica debería estar bastante bien.

Una tercera opción es hacer que el software de configuración escriba una nueva versión adaptada que sea específica para las opciones y los parámetros seleccionados. Esto puede ser más difícil de escribir y probar, por supuesto :)