fix typing support #65
Conversation
| @@ -0,0 +1,2 @@ | |||
| # Marker file to support type hints in exported package | |||
| # See https://peps.python.org/pep-0561/ | |||
There was a problem hiding this comment.
¿Para que sirve este fichero? Ahora mismo por lo que veo estaría vacio (ya que entiendo que las líneas que empiezan por # se interpretan como comentarios)
There was a problem hiding this comment.
Es un requisito de la PEP para exportar la información de tipado de la biblioteca: https://peps.python.org/pep-0561/#packaging-type-information . Por lo que entiendo de la PEP, el fichero es solo un marcador pero debe existir y distribuirse junto con la librería, incluyéndolo en el setup.
|
Creo que estaría bien aprovechar esta PR para incluir una GitAction que verifique el Python typing en este repositorio. Sino, corremos el riesgo de romper y no darnos cuenta, con lo que podriamos generar versiones de tc-etl-lib que a ciertos usuarios (los que no tenga Python typing en sus estornos) les irian bien y a ciertos otros (los que sí lo tengan) mal. Supongo que mirando como se está haciendo en otros repos (pe. el de urbo-deployer) está muy a tiro incluirlo |
Al intentar usar la librería tc-etl-lib desde otros proyectos, siempre tenemos problemas con los tipos. mypy se queja de que la librería no está tipada.
Por lo que parece, para exportar información de tipo en los paquetes de instalación de las librerías, hay que seguir unos pasos que están en la PEP 0561 (https://peps.python.org/pep-0561/)
Esta PR implementa la primera de las opciones descrita en la PEP (fichero
py.typed). Adicionalmente, corrige todos los warnings que genera mypy al validar el código de la propia librería.