Configurar VSCode para Python: Guía completa

¿Por qué utilizar VSCode para Python?

Virtual Studio Code (VSCode) es un entorno de desarrollo integrado perfecto para Python. Es sencillo e incluye funciones integradas que mejoran la experiencia de desarrollo. Las extensiones Python de VSCode incluyen potentes funciones como autocompletar la sintaxis, linting, depuración, pruebas unitarias, GitOps, entornos virtuales, cuadernos, herramientas de edición y la posibilidad de personalizar el editor.  

Características principales:

1. Paleta de comandos para acceder a todos los comandos escribiendo palabras clave.
2. Atajos de teclado totalmente personalizables.
3. Extensión Jupyter para la ciencia de datos. Ejecución de Jupyter Notebook dentro del IDE.
4. Autolinting y formateado.
5. Depuración y pruebas.
6. Integración Git.
7. Fragmentos de código personalizados.
8. Herramientas de edición mejoradas. Selección de cursor múltiple, selección de columna, vista de esquema, vista previa lado a lado, búsqueda y modificación.

En este tutorial, empezaremos instalando Python y VSCode, y luego ejecutaremos un script Python en VSCode. Después personalizaremos el editor para mejorar la experiencia de desarrollo en Python instalando extensiones esenciales y aprendiendo sobre las funciones integradas. Al final, aprenderemos trucos de productividad de Python. 

Configuración de Python y Visual Studio Code

En esta parte aprenderemos a instalar Python y VSCode y a ejecutar un código Python sencillo. 

Instalar Python

Descargar e instalar la última versión de Python es sencillo. Ve a Python.org y descarga la última versión para Windows. El instalador también está disponible para Linux/Unix, macOS y otras plataformas. Tras descargar el instalador, instala Python con la configuración por defecto.          

Imagen de Python.org

La forma más popular de instalar Python es a través de la distribución Anaconda. Incluye un paquete preinstalado y software para que empecemos a programar sin contratiempos. Está disponible para los sistemas operativos Windows, macOS y Linux. 

Imagen de Anaconda

Después de instalar Python en nuestro sistema operativo, comprueba si funciona correctamente escribiendo el siguiente comando en CLI/terminal.

python --version

Salida:

Python 3.9.13

Otros métodos de instalación de Python

También podemos instalar Python utilizando diferentes herramientas CLI o a través de la tienda de Windows. 

• Tienda de Windows
• Homebrew
• Winget
• Chocolatey Software
• apt-get

Puedes consultar nuestra guía completa sobre cómo instalar Python para más detalles. Del mismo modo, nuestro curso interactivo Introducción a Python te ayuda a dominar los fundamentos de la sintaxis de Python, las listas, las funciones, los paquetes y Numpy.

Instalar VSCode

Instalar VSCode es supersencillo. Descarga la versión estable desde el sitio web oficial e instálala. El instalador está disponible para todo tipo de sistemas operativos, incluidos los navegadores web. 

Imagen de Visual Studio Code

Otros métodos de instalación de VSCode

Podemos instalarlo utilizando la tienda de Microsoft, Snap Store y varias herramientas CLI para Windows, Linux y macOS. 

• Winget
• Tienda de Microsoft
• Chocolatey Software
• Scoop
• Homebrew
• Snap Store
• APT

Ejecutar Python en VSCode

Tras instalar Python y VSCode, es hora de escribir un código sencillo y ejecutar el archivo Python dentro del IDE. 

Crear un nuevo archivo 

Al empezar, verás la nota de bienvenida. Ignórala y ve a File > New Text File o utiliza el atajo de teclado Ctrl + N para crear un nuevo archivo. Después, escribe una expresión de impresión sencilla para mostrar "Hello World".

Guardar archivo Python

Guarda el archivo utilizando Ctrl + S. Selecciona el directorio del archivo y escribe el nombre del archivo. Asegúrate de añadir `.py` al final del nombre del archivo. 

Seleccionar el intérprete 

Para ejecutar el archivo Python, tenemos que seleccionar el intérprete de Python. Por defecto, el entorno Anaconda incluye la versión 3.9.13 de Python.

Ejecutar un archivo Python

Para ejecutar el archivo Python, simplemente haz clic en el botón Run de la parte superior izquierda, como se muestra en la imagen. Se inicializará el terminal y se ejecutará el archivo Python para mostrar la salida. 

También puedes escribir python test.py en el terminal para ejecutar el archivo presente en el directorio actual. 

Instalación de las extensiones esenciales Python de VSCode

Las extensiones Python de VSCode nos proporcionarán funciones de ayuda para la edición de código, docstrings, linting, formateo, depuración, pruebas y selección de entornos. 

Cómo instalar una extensión VSCode 

Haz clic en el icono del recuadro de la barra de actividades o utiliza un atajo de teclado: Ctrl + Mayús + X para abrir el panel de extensiones. Escribe cualquier palabra clave en la barra de búsqueda para explorar todo tipo de extensiones. 

Instalar la extensión Python de VSCode

En nuestro caso, escribiremos Python e instalaremos la extensión Python haciendo clic en el botón de instalación, como se muestra arriba. 

Lista de extensiones esenciales de Python 

1. Python

La extensión Python instala automáticamente las extensiones Pylance, Jupyter e isort. Incluye una completa colección de herramientas para ciencia de datos, desarrollo web e ingeniería de software. 

Características principales:

La extensión de Python incluye IntelliSense, linting, depuración, navegación por el código, formateo del código, refactorización, explorador de variables y explorador de pruebas.

• IntelliSense (autocompletar código)
• Linting (Pylint, Flake8)
• Formateo de código (black, autopep)
• Depuración
• Pruebas (unittest, pytest)
• Jupyter Notebooks
• Entornos (venv, pipenv, conda)
• Refactorización 

2. Indent-rainbow

Las extensiones Indent-rainbow nos proporcionan una sangría coloreada multinivel para mejorar la legibilidad del código. Obtenemos colores alternos en cada paso, y nos ayuda a evitar errores comunes de sangría. 

3. Python Indent

La extensión Python Indent nos ayuda a crear sangrías. Al pulsar la tecla Intro, la extensión analizará el archivo Python y determinará cómo debe sangrarse la siguiente línea. Ahorra tiempo. 

4. Jupyter Notebook Renderers

Jupyter Notebook Renderers forma parte del paquete de extensiones Jupyter. Nos ayuda a renderizar salidas plotly, vega, gif, png, svg y jpeg. 

5. autoDocstring

La extensión autoDocstring nos ayuda a generar rápidamente docstrings para las funciones de Python. Escribiendo las comillas triples """ o ''' dentro de la función, podemos generar y modificar docstring. Aprende más sobre las docstrings siguiendo nuestro tutorial Docstrings de Python.

Nota: La mayoría de las funciones y extensiones de desarrollo de Python incluyen extensiones de Python. 

Visual Studio Code y Python para la ciencia de datos

Visual Studio Code permite a los usuarios ejecutar de forma sencilla el código de ciencia de datos en Jupyter Notebook. Podemos ejecutar la celda y visualizar el resultado dentro de VSCode. Admite todo tipo de lenguajes de programación e incluye funciones integradas para imitar el Jupyter Notebook basado en navegador que a todos nos encanta.

Aprende más sobre Jupyter Notebooks leyendo nuestro tutorial Cómo utilizar Jupyter Notebook.

Para utilizar la extensión de Jupyter Notebook, primero tenemos que instalar Jupyter Notebook. 

pip install jupyterlab

O 

pip install notebook

Nota: Jupyter Notebook y Jupyter Lab incluyen la distribución Anaconda, así que no tenemos que instalar nada. 

Instalar la extensión Jupyter

Después, instala la extensión Jupyter desde el mercado de Visual Studio. 

Para crear un archivo de Jupyter Notebook, podemos crear un nuevo archivo con extensión .ipynb o acceder a la paleta de comandos (Ctrl+Mayús+P) y seleccionar Jupyter: Crear nuevo Jupyter Notebook.

Elegir el kernel de Ipython

Para inicializar el servidor Jupyter, tenemos que seleccionar el kernel haciendo clic en el selector de kernel de la parte superior derecha del cuaderno, como se muestra en la imagen.

Nota: Por defecto, Anaconda incluye la versión 3.9.13 de Python. Puedes descargar la última versión de Python 3.11, pero no será compatible con todos los paquetes. 

Ejecutar la celda Jupyter

Escribe una expresión de impresión para mostrar "Hello World" y pulsa el botón de ejecución. 

Añadir otra celda

Puedes utilizar la tecla B o hacer clic en + Code para añadir una nueva celda y ejecutar la celda con Ctrl + ⤶ Intro. Puedes conocer los atajos de teclado de Jupyter en defkey.

Para los usuarios del lenguaje R, tenemos un tutorial de Cuadernos para R. Aprenderás a utilizar R en un Jupyter Notebook y funciones útiles.  

Nota: Si buscas una forma sencilla de utilizar Jupyter Notebook, prueba DataCamp Workspace. Incluye las bibliotecas esenciales de Python y un entorno de precompilación y admite la integración de diferentes bases de datos. 

Configurar el linting y el formateo en VSCode

Linting

Linting pone de manifiesto los problemas en el código fuente de Python y nos proporciona sugerencias. En general, destaca los problemas sintácticos y estilísticos. Linting te ayuda a identificar y corregir los problemas de código que pueden dar lugar a errores. 

Puedes seleccionar el método de linting seleccionando Python: Selecciona el comando Linter en la paleta de comandos (Ctrl+Mayús+P). También puedes activar manualmente el método de linting en los ajustes. 

Seleccionar el método de linting

En nuestro caso, hemos seleccionado el método flake8. También puedes consultar la lista de métodos de linting disponibles.

• Activar/desactivar linting: selecciona Python: Activa/desactiva el linting en la paleta de comandos. 
• Ejecutar linting: paleta de comandos (Ctrl+Mayús+P) > Python: Ejecuta el linting.

Solucionar el error

Después de ejecutar el linter de Python, verás los problemas con las sugerencias. 

Nota: Si activas otro linter, se te pedirá que instales el paquete de Python necesario.

Formateo

El formateo hace que el código sea legible. Sigue reglas específicas para el interlineado, las sangrías, el espaciado entre operadores y los corchetes de cierre. La extensión de Python admite tres métodos de formateo de Python: autopep8, black o yapf.

Leyendo sobre PEP-8: Normas de programación y convenciones de nomenclatura de Python, puedes aprender la guía de estilo y las normas de formateo de Python.

Seleccionar el formateador de Python

Para acceder a la opción de formateo, tenemos que abrir el panel de ajustes yendo a Preferences -> Settings o utilizando el atajo de teclado: Ctrl +,. Después, escribe "python formatting provider" en la barra de búsqueda y selecciona "black" en el menú desplegable.

Configurar el formateador de Python

Para dar formato al archivo Python al guardarlo, tenemos que buscar format on save en Settings y activar Editor: Format on Save option.

Depuración y pruebas en VSCode

Depuración

La extensión Python incluye depuración para todo tipo de aplicaciones, como aplicaciones multihilo, web y remotas. Podemos establecer puntos de interrupción, inspeccionar datos y ejecutar programas paso a paso. 

Seleccionar una configuración de depuración

Abre la pestaña de depuración haciendo clic en el icono de depuración de la barra de acciones o utilizando el atajo de teclado Ctrl + Mayús +D. Para personalizar las opciones de depuración, haz clic en create a launch.json file y selecciona Python File. 

Panel de depuración

Ejecuta la depuración pulsando el botón azul Run and Debug, y ejecutará el archivo Python y nos mostrará las variables, la vigilancia, la pila de llamadas y los puntos de interrupción. 

Depuración rápida

Para una depuración rápida, siempre puedes hacer clic en la flecha hacia abajo situada junto al botón Run y seleccionar Debug Python File.

Pruebas

La extensión de Python es compatible con los marcos de pruebas unittest y pytest. En lugar de leer los resultados de las pruebas en un terminal, puedes revisar y resolver los problemas dentro de la pestaña Testing en una barra activa.   

Configurar las pruebas de Python

Después de hacer clic en el botón Testing, haremos clic en el botón Configure Python Tests y seleccionaremos el marco de pruebas. Normalmente, VSCode detecta automáticamente el marco y muestra todas las pruebas en una vista de árbol. 

Aprende sobre pruebas unitarias en Python implementando el marco de pruebas pytest de Python siguiendo nuestro tutorial sobre cómo utilizar pytest para pruebas unitarias.

Nota: El ejemplo de prueba que utilizamos procede de la documentación oficial de Visual Studio Code. 

Ejecutar unittest 

Podemos ejecutar la prueba unitaria haciendo clic en el botón Run Test de la pestaña Testing y analizando los resultados. 

Como podemos observar, 1 de cada 2 pruebas ha sido superada, y se ha mostrado el razonamiento que hay detrás del resultado fallido. Las pruebas VSCode son muy interactivas y fáciles de usar. 

Integración Git

VSCode incluye integración Git. Se acabó escribir comandos Git en terminales. La integración Git proporciona una GUI fácil de usar y funciones útiles para diff, views, staging, branching, committing, merge y mucho más. 

Consulta nuestra hoja de trucos de Git para conocer los distintos comandos y funciones de Git. 

Nota: Para activar la integración Git, debes instalar Git desde el sitio oficial. 

Inicializar Git 

Podemos acceder a él a través de la barra de acciones o utilizando el atajo de teclado: Ctrl + Mayús + G. Antes de empezar a usar commit, tenemos que inicializar el repositorio.

Commit de Git 

Después, añade y confirma los cambios con el mensaje. Es así de sencillo. 

Crear un repositorio GitHub y enviar el código

Incluso puedes crear un repositorio GitHub y enviar tu código a un servidor remoto iniciando sesión en tu cuenta de GitHub. 

Repositorio privado GitHub

Hemos creado un repositorio privado GitHub de archivos y carpetas Python. 

Ahora puedes simplemente confirmar los cambios y enviarlos al servidor remoto sin salir de VSCode. 

Sigue nuestro tutorial de GitHub y Git para aprenderlo todo sobre Git y GitHub. 

Trucos y consejos para un desarrollo eficiente de Python en VSCode

VSCode incluye increíbles extensiones y funciones de desarrollo en Python. Podemos personalizarlas según nuestras necesidades y aumentar la productividad. En esta sección, aprenderemos trucos y consejos para un desarrollo eficiente en Python. 

1. Para empezar: Help > Get Started. Aprende sobre la personalización y las funciones de VSCode siguiendo tutoriales guiados. 
2. Paleta de comandos: accede a todos los comandos disponibles utilizando el atajo de teclado: Ctrl+Mayús+P. Escribiendo palabras clave, podemos acceder a comandos específicos.  
3. Atajos de teclado: mejores que las paletas de comandos. Podemos modificar los atajos de teclado o memorizarlos utilizando hojas de referencia del teclado. Nos ayudará a acceder directamente a los comandos, en lugar de buscar con la palabra clave.
4. Línea de comandos: abre el editor VSCode a través de la interfaz de la línea de comandos escribiendo `code .`. También podemos personalizar cómo se abre el editor añadiendo argumentos adicionales. 
5. Errores y advertencias: salta rápidamente a los errores y advertencias de un proyecto utilizando el atajo de teclado: Ctrl+Mayús+M. También podemos recorrer los errores con F8 o Mayús+F8.
6. Personalización: VSCode nos permite personalizar temas, atajos de teclado, validación JSON, ajustes de depuración, fuentes y muchas cosas más. Es un IDE totalmente personalizable. 
7. Extensiones: otras extensiones de Python mejoran nuestra experiencia de desarrollo. Busca extensiones populares en elmercado de Visual Studio.
8. Selección multicursor: es un salvavidas. Añade cursores en posiciones arbitrarias utilizando Alt+Clic. Nos permitirá modificar varias líneas de código a la vez. También podemos utilizar Ctrl+Mayús+L para modificar todas las apariciones de la selección actual.
9. Buscar y modificar: es la mejor herramienta para buscar y modificar varias expresiones a la vez. También podemos cambiar el nombre del símbolo seleccionándolo y pulsando F2. 
10. Integración Git: nos permite realizar todas las tareas relacionadas con Git dentro del IDE. Proporciona una GUI fácil de usar para diff, views, staging, branching, committing, merging y mucho más.
11. Fragmentos de código: es nuestro mejor amigo. Igual que Autohotkey, estamos creando plantillas para repetir patrones de código. Para crear un fragmento de código personalizado, selecciona File > Preferences > Configure User Snippets y, a continuación, selecciona el lenguaje.
12. GitHub Copilot: es una extensión ganadora para todo tipo de desarrollo. Mejora la experiencia de programación con inteligencia artificial (IA) sugiriendo líneas de código o funciones enteras.

Bonus: sincroniza tu configuración iniciando sesión en tu cuenta de GitHub. Sincronizará tu configuración en todos los equipos. 

Conclusión

VSCode no es solo un editor de código. Es un ecosistema completo para el desarrollo eficiente de Python. Nos proporciona atajos, paleta de comandos, IntelliSense, linting, formateo, depuración, integraciones Git, Jupyter Notebook, extensiones de terceros y una experiencia de desarrollo totalmente personalizable. 

VSCode es muy recomendable para los principiantes que están aprendiendo los fundamentos de Python y la ciencia de datos. Completa el programa profesional Científico de datos con Python para convertirte en un maestro en Python y ciencia de datos. El programa profesional consta de 25 cursos y 6 proyectos que te prepararán para convertirte en un científico de datos profesional.