¿Cómo hacer cumplir los estándares PEP8 en los repositorios de Azure DevOps?

Answer

1. 

   davy.ai

   July 15, 2023 at 6:35 am

   Hay diferentes formas de aplicar los estándares PEP8 en los repositorios de Azure DevOps (ADO). Una solución posible es utilizar un gancho pre-commit que verifique el formato de código antes de permitir un push. A continuación se detallan los pasos para implementar esta solución:

   1. Crear un entorno virtual con los paquetes pylint y autopep8 instalados:

   python3 -m venv myenv
   source myenv/bin/activate
   pip install pylint autopep8
   

   1. Escribir un script en Python que utilice pylint y autopep8 para verificar y corregir el formato de código:

   #!/usr/bin/env python3
   import os
   import subprocess
   
   def main():
       repo_path = os.environ.get('BUILD_REPOSITORY_LOCALPATH')
       if repo_path:
           print(f"Verificando la conformidad PEP8 de {repo_path}")
           subprocess.run(f"autopep8 --in-place --recursive {repo_path}", shell=True)
           subprocess.run(f"pylint {repo_path}", shell=True)
       else:
           print("No se está ejecutando desde un repositorio ADO, se omiten las verificaciones de PEP8.")
   
   if __name__ == '__main__':
       main()
   

   1. Guardar el script como pre-commit.py en la raíz del repositorio de ADO.

   2. Hacer que el script sea ejecutable:

   chmod +x pre-commit.py
   

   1. Configurar ADO para ejecutar el script como un gancho pre-commit creando un archivo .git/hooks/pre-commit con el siguiente contenido:

   #!/bin/bash
   python3 pre-commit.py
   

   1. Guardar el archivo y hacerlo ejecutable:

   chmod +x .git/hooks/pre-commit
   

   Ahora, cuando un usuario intente agregar cambios al repositorio de ADO, el gancho pre-commit se ejecutará y verificará si el código cumple con los estándares PEP8. Si el código no cumple, el push será rechazado. Si el código solo tiene problemas de formato, el gancho los corregirá automáticamente antes de permitir el push.

   Es importante tener en cuenta que esta solución asume que el repositorio de ADO ya está configurado para ejecutar compilaciones y tiene acceso a un entorno de Python con los paquetes requeridos instalados. Si no es así, se requerirán pasos adicionales para configurar el entorno de compilación.

Comments are closed.