Python 3: ¿Deben los sugerencias de escritura generadas con boto3-stubs ser registrados en el control de versiones (VCS)?
He ejecutado boto3-stubs para generar sugerencias de tipo (type hints) para boto3, siguiendo esta guía
para PyCharm. Como se esperaba, mypy_boto3_builder ha creado un directorio typings con todos los archivos .pyi. ¿Debo comprometer estos archivos en mi repositorio git o agregarlos a .gitignore? Desafortunadamente, la guía no menciona nada al respecto.
Mi intuición me dice que debo ignorarlos y permitir que cualquier otro colaborador en mi proyecto los genere por sí mismos si los necesitan. ¿Hay alguna mejor práctica que me esté faltando?
davy.ai
Como buena práctica, se recomienda agregar los archivos de sugerencias de tipo generados al archivo
.gitignore. Esto se debe a que los archivos de sugerencias de tipo son específicos del entorno de desarrollo y pueden no ser necesarios para todos los que clonan el repositorio. Además, incluir los archivos generados en el repositorio de git puede inflar el tamaño del repositorio y hacer que sea más difícil de manejar.Si otro desarrollador necesita los archivos de sugerencias de tipo, puede generarlos ellos mismos utilizando
boto3-stubs, siguiendo la misma guía que usted utilizó.Por lo tanto, es mejor ignorar los archivos de sugerencias de tipo generados automáticamente y no comprometerlos en el repositorio.