Crea tus snippets favoritos en Visual studio Code

Los snippets son trozos de código que solemos repetir frecuentemente al escribir nuestras aplicaciones. En Visual Studio Code podemos crear nuestros snippets personalizados y utilizarlos rápidamente invocando una palabra clave.

Los snippets pueden ser creados para cualquier lenguaje de programación.

En python utilizo mucho funciones para el acceso a la base de datos y traer los datos que necesito con una Select. Este tipo de código lo invoco con un snippet.

def nombre_funcion(parametros):
    try:
        comm = cx.conectar()
        cursor = comm.cursor()

        query = """

                """

        cursor.execute(query, (parametros,))
        return cursor.fetchall()

    finally:
        if(comm):
            cursor.close()
            comm.close()

Para crear un snippet personalizado debes de pulsar la combinación de teclas:

Ctrl + shift + p (Windows)

Mayúsculas + Cmd + p (Mac)

En el campo desplegado teclea snippets

Seleccionas la opción “Preferencias: Configurar fragmentos de usuario

A continuación debemos seleccionar el lenguaje de programación en el cual vamos a crear el snippet. En el caso de python se abrirá el archivo python.json, aquí es donde debemos crear nuestro nuevo snippet

En la parte superior del archivo podemos ver unas instrucciones para la creación del snippet, así como un ejemplo.

El snippet consta de un nombre entre comillas para identificarlo y dentro de las llaves se encuentra el objeto que forma el snippet. 

Tiene tres parametros:

  • Prefix – Es el nombre con el cual invocaremos a nuestro snippet.
  • Body – Es el código del snippet. Cada linea debe ir entre comillas y todas terminadas en coma, menos la última.
  • Description – La descripción del snippet.

El código anterior queda de la siguiente forma:

"Funcion db": {
        "prefix": "funcion_db",
        "body": [
            "def $1($2):",
            "\ttry:",
            "\t\tcomm = cx.conectar()",
            "\t\tcursor = comm.cursor()",
            "",
            "\t\tquery = \"\"\"",
            "\t\t\t\t$3",
            "\t\t\t\t\"\"\"",
            "",
            "\t\tcursor.execute(query, ($4,))",
            "\t\treturn cursor.fetchall()",
            "",
            "\tfinally:",
            "\t\tif(comm):",
            "\t\t\tcursor.close()",
            "\t\t\tcomm.close()"
        ],
        "description": "Funciones base de datos"
    }

Explicamos los comandos utilizados:

  • \ – La barra invertida sirve para escapar caracteres especiales.
  • \t – Con cada \t, insertamos una tabulación.
  • \” – Insertamos una doble comilla, que no afecta al código del snippet, al estar entrecomillada cada linea. Estas dobles comillas serán parte de la función.
  • $1 – Este comando nos permite, una vez utilizado el snippet en nuestro código, desplazar el cursor por cada uno de ellos al pulsar la tecla “tabulador”. Al invocar al snippet, el cursor se posiciona en el primer $, ponemos el nombre de la función y al presionar tabulador, el cursor se deplaza al siguiente $, y así sucesivamente.

Para invocar el snippet en nuestro código simplemente tendremos que utilizar el nombre que le dimos en “prefix“, veremos que al ir escribiendo dicho nombre, en el menu intelligence de Visual Studio Code, ya aparece nuestro snippet. Para poder utilizar los snippets de cada lenguaje de programación debemos tener seleccionado en el archivo el modo de lenguaje, esto lo podemos ver en la barra inferior en la parte derecha. Como es obvio, si estamos en un archivo de css, no podremos utilizar snippets de python. Cada modo de lenguaje utiliza sus propios snippets.

Puedes encontrar más información en relación a los snippets en https://code.visualstudio.com/docs/editor/userdefinedsnippets

Share