Configuración en el settings.json
{
...
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
},
...
}
Escribir código limpio en Python empieza por conocer el PEP 8, el documento oficial que reúne las reglas de estilo para escribir código legible. Si estás iniciando un proyecto y quieres que tu código sea claro tanto para ti como para tu equipo, aquí aprenderás las convenciones esenciales y cómo automatizarlas con Ruff.
El PEP 8 fue escrito por Guido van Rossum, el creador de Python, y forma parte de los documentos PEP, que son propuestas de mejora para el lenguaje. La idea central es sencilla: el código se lee muchas más veces de las que se escribe, así que vale la pena que sea consistente.
¿Qué reglas del PEP 8 debo aplicar al escribir código Python?
Desde el minuto uno del proyecto conviene fijar las reglas de estilo. La primera es la documentación del archivo, que siempre va en la parte de arriba usando triple comilla. En el ejemplo se coloca "Sistema de análisis de noticias con APIs múltiples" como descripción inicial [00:44].
De ahí en adelante, estas son las convenciones clave que se trabajan en el proyecto:
DEFAULT_LANGUAGE, que aquí se usa para traer noticias en español por defecto [01:14].Un truco práctico: en Visual Studio Code puedes activar editor.renderWhitespace en la opción all dentro del JSON de settings, y así ver los espacios sin tener que seleccionarlos [02:12].
¿Qué es el PEP 8? Es el documento oficial de Python que define cómo escribir código legible y consistente: nombres de variables, identación, uso de comillas y organización de imports. Fue escrito por Guido van Rossum.
¿Cómo organizo funciones e imports según la convención?
La organización lógica del archivo también forma parte del estilo. Entre funciones que no están relacionadas se dejan dos líneas en blanco para separarlas visualmente. En el ejemplo, clean_text, que limpia y formatea texto, se separa de la función que valida una API key [02:48].
Hay una jerarquía clara: primero las funciones de utilidad y después las funciones principales, que hacen el trabajo real del proyecto. Cuando una función todavía no está implementada, se coloca un pass para que el código siga siendo válido [03:20].
Un detalle sobre el idioma: en el curso la documentación se escribe en español, pero el código se escribe en inglés como buena convención [03:38].
Los imports tienen su propio orden recomendado:
json.requests.Si un import no se usa, la herramienta de formateo lo elimina automáticamente al guardar [05:24].
¿En qué orden van los imports en Python? Primero los de la librería estándar, luego los paquetes de terceros y al final los módulos locales. Cada grupo se separa y se ordena de forma explícita según el PEP 8.
¿Cómo formateo mi código automáticamente con Ruff?
Recordar todas las reglas del PEP 8 es casi imposible, y aquí viene lo interesante: no hace falta. La mayoría de desarrolladores usamos una herramienta que formatea el código por nosotros. La recomendada es Ruff, creada por el equipo Astral y construida sobre Rust, lo que la hace muy rápida [05:52].
Para usarla dentro del editor, el flujo es directo:
Para no depender del clic derecho, puedes activar Format On Save en el settings.json. Así, cada vez que guardas, el código se ajusta solo [06:48]. También puedes agregar configuraciones que organicen los imports automáticamente al guardar, siguiendo el mismo formato del PEP 8 [07:07].
Ruff también funciona desde la terminal con el comando ruff format, al que le puedes pasar un archivo o una carpeta completa. Si quieres explorar todas sus opciones, ejecuta:
bash ruff format --help
Este comando muestra la ayuda completa de lo que Ruff puede hacer como formatter [08:37].
¿Qué es Ruff en Python? Es una herramienta creada por Astral y construida en Rust que formatea automáticamente tu código para cumplir el PEP 8. También incluye un linter que detecta errores antes de ejecutar el código.
Además del formateo, Ruff trae un linter. Esta parte del linting te ayuda a identificar variables sin usar o código que podría fallar antes de ejecutarse, mostrándotelo directamente en el editor [09:02].
¿Cuáles son las mejores prácticas de estilo que debo recordar?
Si tuvieras que quedarte con un resumen accionable, estas son las prácticas que se implementan en el proyecto:
Como reto, ve a la documentación oficial del PEP 8, busca la regla que más te guste y compártela en los comentarios para iniciar una discusión con otro compañero. ¿Cuál elegirías tú?
Escribir código limpio en Python empieza por conocer el PEP 8, el documento oficial que reúne las reglas de estilo para escribir código legible. Si estás iniciando un proyecto y quieres que tu código sea claro tanto para ti como para tu equipo, aquí aprenderás las convenciones esenciales y cómo automatizarlas con Ruff.
El PEP 8 fue escrito por Guido van Rossum, el creador de Python, y forma parte de los documentos PEP, que son propuestas de mejora para el lenguaje. La idea central es sencilla: el código se lee muchas más veces de las que se escribe, así que vale la pena que sea consistente.
Desde el minuto uno del proyecto conviene fijar las reglas de estilo. La primera es la documentación del archivo, que siempre va en la parte de arriba usando triple comilla. En el ejemplo se coloca "Sistema de análisis de noticias con APIs múltiples" como descripción inicial [00:44].
De ahí en adelante, estas son las convenciones clave que se trabajan en el proyecto:
DEFAULT_LANGUAGE, que aquí se usa para traer noticias en español por defecto [01:14].Un truco práctico: en Visual Studio Code puedes activar editor.renderWhitespace en la opción all dentro del JSON de settings, y así ver los espacios sin tener que seleccionarlos [02:12].
¿Qué es el PEP 8? Es el documento oficial de Python que define cómo escribir código legible y consistente: nombres de variables, identación, uso de comillas y organización de imports. Fue escrito por Guido van Rossum.
La organización lógica del archivo también forma parte del estilo. Entre funciones que no están relacionadas se dejan dos líneas en blanco para separarlas visualmente. En el ejemplo, clean_text, que limpia y formatea texto, se separa de la función que valida una API key [02:48].
Hay una jerarquía clara: primero las funciones de utilidad y después las funciones principales, que hacen el trabajo real del proyecto. Cuando una función todavía no está implementada, se coloca un pass para que el código siga siendo válido [03:20].
Un detalle sobre el idioma: en el curso la documentación se escribe en español, pero el código se escribe en inglés como buena convención [03:38].
Los imports tienen su propio orden recomendado:
json.requests.Si un import no se usa, la herramienta de formateo lo elimina automáticamente al guardar [05:24].
¿En qué orden van los imports en Python? Primero los de la librería estándar, luego los paquetes de terceros y al final los módulos locales. Cada grupo se separa y se ordena de forma explícita según el PEP 8.
Recordar todas las reglas del PEP 8 es casi imposible, y aquí viene lo interesante: no hace falta. La mayoría de desarrolladores usamos una herramienta que formatea el código por nosotros. La recomendada es Ruff, creada por el equipo Astral y construida sobre Rust, lo que la hace muy rápida [05:52].
Para usarla dentro del editor, el flujo es directo:
Para no depender del clic derecho, puedes activar Format On Save en el settings.json. Así, cada vez que guardas, el código se ajusta solo [06:48]. También puedes agregar configuraciones que organicen los imports automáticamente al guardar, siguiendo el mismo formato del PEP 8 [07:07].
Ruff también funciona desde la terminal con el comando ruff format, al que le puedes pasar un archivo o una carpeta completa. Si quieres explorar todas sus opciones, ejecuta:
bash ruff format --help
Este comando muestra la ayuda completa de lo que Ruff puede hacer como formatter [08:37].
¿Qué es Ruff en Python? Es una herramienta creada por Astral y construida en Rust que formatea automáticamente tu código para cumplir el PEP 8. También incluye un linter que detecta errores antes de ejecutar el código.
Además del formateo, Ruff trae un linter. Esta parte del linting te ayuda a identificar variables sin usar o código que podría fallar antes de ejecutarse, mostrándotelo directamente en el editor [09:02].
Si tuvieras que quedarte con un resumen accionable, estas son las prácticas que se implementan en el proyecto:
Como reto, ve a la documentación oficial del PEP 8, busca la regla que más te guste y compártela en los comentarios para iniciar una discusión con otro compañero. ¿Cuál elegirías tú?
Configuración en el settings.json
{
...
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
},
...
}

En mi perfil de LinkedIn tengo una serie completa de PEP 8.
💡 Escribir código Python limpio, legible y escalable usando las buenas prácticas de PEP 8 y la automatización de Ruff.
📜 Documentación al principio
"""
Sistema de análisis de noticias con APIs múltiples.
"""
🔤 Constantes
Usa comillas dobles siempre DEFAULT_LANGUAGE = "español"
🧭 Mantén el mismo formato en todo el proyecto.
🐍 Funciones y variables: snake_case ✏️ Ejemplo:
def clean_text(texto: str) -> str:
"""Limpia y formatea texto."""
pass
📏 Reglas visuales
🧠 Usa nombres descriptivos y coherentes.
1️⃣ Funciones utilitarias
2️⃣ Funciones principales
3️⃣ Bloque de ejecución →
if __name__ == "__main__":
...
🌍 Código en inglés
📝 Documentación en español (opcional)
📚 Sigue este orden PEP 8:
✅ Orden explícito y consistente 🚫 Elimina imports no usados
💎 Usa un único tipo de comillas
➡️ Recomendado: dobles "texto"
🔍 En VS Code activa:
Settings → JSON → Editor Render White Space → All para visualizar espacios y tabulaciones.
🚀 Ruff (hecho en Rust) aplica PEP 8 automáticamente:
1️⃣ Instala la extensión Ruff
2️⃣ Clic derecho → Formatear documento
3️⃣ En settings.json agrega:
{
"format_on_save": true
}
💾 Al guardar → Ruff corrige comillas, espacios y estilo. ✨ Tu código siempre limpio.
💡 Configura VS Code para:
🔥 Todo sucede automáticamente al guardar.
🧩 Formatear proyecto completo: ruff format
📘 Ayuda detallada: ruff format help
🧹 Linter activo: Detecta variables no usadas y posibles errores. 👉 Lo muestra directamente en el editor.
Si buscan leer el PEP 8 en español y con un formato visualmente más atractivo, les recomiendo esta página que lo presenta de manera excelente:
Correcto:
x = 5
y = x + 2
Incorrecto:
x=5
y=x+2
Me parece interesante que utilizan doble guion bajo para diferencias las subclases de las clases :o
Para acceder al settings.json en Visual Studio Code, presiona Ctrl + Shift + P (o Cmd + Shift + P en Mac), escribe "Open User Settings (JSON)" y selecciónalo.
esta es la regla que mas me gusta Comentarios en línea
Utilice los comentarios en línea con moderación.
Un comentario en línea es un comentario que aparece en la misma línea que una instrucción. Los comentarios en línea deben estar separados de la instrucción por al menos dos espacios. Deben comenzar con un símbolo # seguido de un espacio.
Los comentarios en línea son innecesarios y, de hecho, distraen si afirman lo obvio. No hagas esto:
x = x + 1 # Increment x
Pero a veces, esto es útil:
x = x + 1 # Compensate for border
Para código de operaciones con múltiples lineas, la sugerencia es romper la linea antes del operador binario para facilitar la lectura.
income = (gross_wages
+ taxable_interest
+ (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)
Me parece que el operador binario al inicio sirve como viñeta para saber donde continuar leyendo con facilidad.
Para mi la regla más interesante es la que se refiere a operadores binarios: Donald Knuth explains the traditional rule in his Computers and Typesetting series: “Although formulas within a paragraph always break after binary operations and relations, displayed formulas always break before binary operations. Al ver un ejemplo en la documentación si hace mucho más sencillo entender qu´´valor se suma, resta o multiplica
Francisco Ponce
Juan Camilo Infante Barón
Company_adminBlanca Segura Garcia
Daniel Alfredo García Serna
Gabriel Obregón
Diego Alejandro Landaeta Garrido
Yosneiker Montaguth
Jordan Stiwart Santa Palacios
German Diaz
Gerardo Enrique Campos Escobar
Bayron Zamudio
Miguel Angel Moreno C.
Carlos R. Mendez O.
Luis Martinez
ProfesorThiago Aranda
Hernán García Urrutia
Pablo Rangel
Daniel Rodriguez
Brayan William Orozco Wayner
Claudio Mosquera
MARIEL CONSUELO VIRGINIA AYALA HERNÁNDEZ
Melvin Gabriel Ventura Valenzuela
Francisco Alejandro Bernal Castro
Francisco Ponce
Diego Alejandro Pérez Cardona
Luis Martinez
ProfesorNicolas E Duque Aguirre
Configuración en el settings.json
{ ... "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.ruff": "explicit", "source.organizeImports.ruff": "explicit" }, ... }
gracias
Gracias! Lamentablemente me perdí en los settings. En dónde lo agrego?
En mi perfil de LinkedIn tengo una serie completa de PEP 8.
🐍✨ PEP 8 + Ruff + VS Code
🎯 Propósito
💡 Escribir código Python limpio, legible y escalable usando las buenas prácticas de PEP 8 y la automatización de Ruff.
🧱 1️⃣ Inicio del archivo
📜 Documentación al principio
"""
Sistema de análisis de noticias con APIs múltiples.
"""
🔤 Constantes
Usa comillas dobles siempre DEFAULT_LANGUAGE = "español"
🧭 Mantén el mismo formato en todo el proyecto.
🧩 2️⃣ Nombres y estilo
🐍 Funciones y variables: snake_case ✏️ Ejemplo:
def clean_text(texto: str) -> str:
"""Limpia y formatea texto."""
pass
📏 Reglas visuales
🧠 Usa nombres descriptivos y coherentes.
⚙️ 3️⃣ Estructura lógica del código
1️⃣ Funciones utilitarias
2️⃣ Funciones principales
3️⃣ Bloque de ejecución →
if __name__ == "__main__":
...
🌍 Código en inglés
📝 Documentación en español (opcional)
📦 4️⃣ Orden correcto de imports
📚 Sigue este orden PEP 8:
✅ Orden explícito y consistente 🚫 Elimina imports no usados
💬 5️⃣ Comillas y espacios
💎 Usa un único tipo de comillas
➡️ Recomendado: dobles "texto"
🔍 En VS Code activa:
Settings → JSON → Editor Render White Space → All para visualizar espacios y tabulaciones.
🧰 6️⃣ Automatiza con Ruff
🚀 Ruff (hecho en Rust) aplica PEP 8 automáticamente:
🪄 Cómo configurarlo en VS Code
1️⃣ Instala la extensión Ruff
2️⃣ Clic derecho → Formatear documento
3️⃣ En settings.json agrega:
{
"format_on_save": true
}
💾 Al guardar → Ruff corrige comillas, espacios y estilo. ✨ Tu código siempre limpio.
🔄 7️⃣ Organización automática de imports
💡 Configura VS Code para:
🔥 Todo sucede automáticamente al guardar.
🧮 8️⃣ Comandos Ruff esenciales
🧩 Formatear proyecto completo: ruff format
📘 Ayuda detallada: ruff format help
🧹 Linter activo: Detecta variables no usadas y posibles errores. 👉 Lo muestra directamente en el editor.
boof, tremendo resumen
Si buscan leer el PEP 8 en español y con un formato visualmente más atractivo, les recomiendo esta página que lo presenta de manera excelente:
✔️ Espacios alrededor de operadores
Correcto:
x = 5 y = x + 2
Incorrecto:
x=5 y=x+2
Totalmente de acuerdo, me estresa leer codigo con los signos pegados jaja
Me parece interesante que utilizan doble guion bajo para diferencias las subclases de las clases :o
Para acceder al settings.json en Visual Studio Code, presiona Ctrl + Shift + P (o Cmd + Shift + P en Mac), escribe "Open User Settings (JSON)" y selecciónalo.
esta es la regla que mas me gusta Comentarios en línea
Utilice los comentarios en línea con moderación.
Un comentario en línea es un comentario que aparece en la misma línea que una instrucción. Los comentarios en línea deben estar separados de la instrucción por al menos dos espacios. Deben comenzar con un símbolo # seguido de un espacio.
Los comentarios en línea son innecesarios y, de hecho, distraen si afirman lo obvio. No hagas esto:
x = x + 1 # Increment x
Pero a veces, esto es útil:
x = x + 1 # Compensate for border
Para código de operaciones con múltiples lineas, la sugerencia es romper la linea antes del operador binario para facilitar la lectura.
income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)
Me parece que el operador binario al inicio sirve como viñeta para saber donde continuar leyendo con facilidad.
buena practica! me gusta como se lee el código así
Se ve mucho más ordenado. Me gusta porque se entiende qué variables se están trabajando
Para mi la regla más interesante es la que se refiere a operadores binarios: Donald Knuth explains the traditional rule in his Computers and Typesetting series: “Although formulas within a paragraph always break after binary operations and relations, displayed formulas always break before binary operations. Al ver un ejemplo en la documentación si hace mucho más sencillo entender qu´´valor se suma, resta o multiplica
La regla que más me llamó la atención fue la de cómo se deben de poner las importaciones de otros archivos. Esto ayuda a que el usuario pueda entender de dónde llega el código. Además de que siempre deben ponerse arriba, o sea, al principio del archivo, para que se tenga una buena organización de un proyecto.
{
"editor.fontSize": 14,
"terminal.integrated.fontSize": 14,
"editor.wordWrap": "on",
"editor.renderWhitespace": "all",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
}
}
No debe haber espacios antes ni después del signo = en la definición de una función.
Lo correcto es siempre escribir las cosas seguidas. Por ejemplo:
def func(key1='val1', key2='val2'): return key1, key2
En el video 02 el examen me sale en ingles
a mi me gusta la regla de identacion a 4 espacio, mantener ese estandar le da mucho orden al codigo
Por mucho una de mis convenciones favoritas es la de usar el salto de línea antes de los operadores binarios, era un dolor de cabeza cada vez que encontraba código legado que no seguía este formato y era una de las cosas que cambiaba a la menor provocación si me tocaba realizar un cambio en esos archivos. Claro a veces no era posible si era un un código complejo o viejo y el cambio "real" que tenía que realizar en el archivo era pequeño, pero me alegra bastante que sea parte del PEP8.
Ustedes o alguien a quien hayan conocido le parecía mejor o prefería un formato distinto para estos casos particulares?
Aproximadamente en el minuto 02:09 Blanca. Abre la paleta de comandos dándole clic o puedes hacerlo presionando el shortcut CTRL + Shift + P
Me parece que con el tema de las llaves, corchetes y paréntesis es adecuado el orden que sugiere la segunda forma de poder hacerlo según PEP 8 ya que da mucha más facilidad de estructura en el código:
Igual ten en cuenta que es de gustos y los proyectos suelen usar una de las dos maneras, así que lo que toca hacer muchas veces es acoplarse a lo que ya decidieron los creadores del proyecto.
# la regla de espacios me parece muy adecuada # Avoid extraneous whitespace in the following situations: # Immediately inside parentheses, brackets or braces: # Correct: spam(ham[1], {eggs: 2}) # Wrong: spam( ham[ 1 ], { eggs: 2 } ) Between a trailing comma and a following close parenthesis: # Correct: foo = (0,) # Wrong: bar = (0, ) Immediately before a comma, semicolon, or colon: # Correct: if x == 4: print(x, y); x, y = y, x # Wrong: if x == 4 : print(x , y) ; x , y = y , x