Convenciones de nombres

Las convenciones de nombres en Scheme parecen preferir minúsculas con guiones, en el nombre de la función. Sin embargo, parto de la convención con los parámetros. Quiero nombres más descriptivos para mis parámetros y variables, y añado el prefijo «in» a los parámetros, así que, puedo, rapidamente, ver que valores entran en el script, más bien que los que se crean en el. Uso el prefijo «the» para las variables definidas en el script.

Atencion sociosanitaria

Es la convención del GIMP para nombrar sus funciones de códigos Script­Fu, porque así están listados en la base de datos de procedimientos, todos ellos se mostrarán bajo script­fu cuando se estén listando las funciones. Esto, también, ayuda a distinguirlos de los plug­ins.

Pasos para registrar el código

Para registrar nuestro script en elGIMP, llamamos a la función script­fu­register, rellenamos los siete parámetros requeridos y añadimos los nuestros propios, junto con una descripción y valores predefinidos para cada parámetro.

Los parámetros requeridos

• El nombre de la función que definimos. Esto es la llamada de función cuando nuestro script es invocado (el punto de entrada de nuestro script). Esto es necesario porque podriamos definir funciones adicionales bajo el mismo archivo, y GIMP necesita saber a cuales de estas funciones se llama. En nuestro ejemplo, solo definimos una función, text box, que registramos.
• La localización en el menú donde el script será insertado. El lugar exacto de el script está especificado, como una ruta en Unix, con la raiz de la ruta estando entre la caja de herramientas o click derecho. The location in the menu where the script will be inserted. The exact location of the script is specified like a path in Unix, with the root of the path being either toolbox or right­click.

Si su script no opera sobre una imagen existente (y crea una imagen nueva, como hará nuestro Text Box), querrá insertarlo en el menú de la caja de herramientas, este es el menu en la ventana principal del GIMP (donde se localizan todas las herramientas: herramientas de selección, lupa, etc.).

Branding

Si u script está intentando trabajar sobre una imagen que está siendo editada, querrá insertarla en el menú que aparece cuando pulsa el botón derecho sobre una imagen abierta. El resto de la ruta apunta a la lista de menú, menús y submenús. Resgistramos nuestro script Text Box en el menú Text de el menú Script­Fu del menú Exts, en el menú de la caja de herramientas ( Exts Script­Fu Text Text Box ).

Si se fija, el sub­menú Text, en el menú Script­Fu, no estaba allí cuando empezamos, el GIMP crea, automaticamente, cualquier menú que todavia no exista.

• Una descripción de su script, para ser mostrada en el Examinador de Procedimientos.
• Su nombre (el autor del código).
• Información del copyright.
• La fecha en que se hizó el código, o la última revisión del mismo.
• El tipo de imágenes con las trabaja el script. Puede ser uno de los siguientes: RGB, RGBA, GRAY, GRAYA, INDEXED,

INDEXEDA. O podría no ser ninguno de ellos, en nuestro caso, estamos creando una imagen, y no necesitamos definir el tipo de imagen sobre la que trabajaremos.

Convenciones de Nombres en Python:

1. Nombres de Variables:
   • Utiliza nombres descriptivos en minúsculas, separando las palabras con guiones bajos (snake_case). Ejemplo: nombre_de_usuario, cantidad_total, lista_de_clientes.
2. Nombres de Funciones y Métodos:
   • Utiliza nombres descriptivos en minúsculas, separando las palabras con guiones bajos (snake_case). Ejemplo: calcular_promedio, obtener_datos_usuario, guardar_archivo.
3. Nombres de Clases:
   • Utiliza nombres en mayúsculas y minúsculas (CamelCase o PascalCase) para denotar clases. Comienza cada palabra con mayúscula sin utilizar guiones bajos. Ejemplo: Usuario, ClienteNuevo, ManejadorDeArchivos.
4. Constantes:
   • Utiliza nombres en mayúsculas separando las palabras con guiones bajos (SNAKE_CASE) para definir constantes. Ejemplo: TASA_INTERES, VALOR_PI, DIAS_SEMANA.
5. Convenciones Generales:
   • Sé consistente en el estilo de nombres que utilizas en todo el código.
   • Evita nombres genéricos como data, temp, x, var, etc. Usa nombres descriptivos que reflejen su propósito o contenido.
   • Utiliza nombres que sean significativos y fáciles de entender para cualquier persona que lea el código.

Convenciones Específicas para GIMP y Python-Fu:

Cuando trabajas con complementos (plugins) para GIMP utilizando Python-Fu, es importante seguir las convenciones específicas para garantizar la compatibilidad y la legibilidad del código dentro del entorno de GIMP. Algunas recomendaciones adicionales son:

• Prefijo de Complemento:
  • Utiliza un prefijo descriptivo para los nombres de las funciones y complementos específicos de GIMP. Por ejemplo, gimp_my_plugin_function o python_fu_my_script.
• Parámetros de Funciones:
  • Utiliza nombres descriptivos para los parámetros de funciones en Python-Fu. Asegúrate de que los nombres reflejen el propósito de cada parámetro.
• Nombres de Menú:
  • Utiliza nombres de menú claros y descriptivos para organizar tus complementos dentro de GIMP. Por ejemplo, <Image>/Filtros/Mis Complementos/Mi Complemento.