Escribir código bien formateado es muy importante, los programas pequeños son fáciles de entender, pero a medida que los programas se vuelven más complejos, se vuelven más y más difíciles de entender. En algún momento, ni siquiera puedes entender el código escrito por ti. Para evitar esto, es necesario escribir el código en un formato legible. Aquí Black entra en juego, Black asegura la calidad del código.
¿Qué es el negro?
Linters como pycodestyle o flake8 muestran si su código está de acuerdo con el formato PEP8, que es la guía de estilo oficial de Python. Pero el problema es que les da una carga a los desarrolladores arreglar este estilo de formato. Aquí Black entra en juego no solo informa errores de formato sino que también los corrige.
Para citar el proyecto README:
Black es el formateador de código Python intransigente. Al usarlo, acepta ceder el control sobre las minucias del formateo manual. A cambio, Black le brinda velocidad, determinismo y libertad de las molestias de estilo pycode sobre el formato. Ahorrarás tiempo y energía mental para asuntos más importantes.
Nota: Black se puede integrar fácilmente con muchos editores como Vim, Emacs, VSCode, Atom o un sistema de control de versiones como GIT.
Instalación y uso de Black:
Black requiere Python 3.6.0+ con pip instalado:
$ pip install black
Es muy simple de usar negro. Ejecute el siguiente comando en la terminal.
$ black [file or directory]
Esto reformateará su código usando el estilo de código Black.
Ejemplo 1: Vamos a crear un nombre de archivo sin formato «sample.py» y queremos formatearlo usando negro. A continuación se muestra la implementación.
Python3
def is_unique( s ): s = list(s ) s.sort() for i in range(len(s) - 1): if s[i] == s[i + 1]: return 0 else: return 1 if __name__ == "__main__": print( is_unique(input()) )
Después de crear este archivo, ejecute el siguiente comando.
Archivo de salida:
Python3
def is_unique(s): s = list(s) s.sort() for i in range(len(s) - 1): if s[i] == s[i + 1]: return 0 else: return 1 if __name__ == "__main__": print(is_unique(input()))
En el ejemplo anterior, ambos son el mismo código de pieza, pero después de usar negro, se formatea y, por lo tanto, es fácil de entender.
Ejemplo 2: Vamos a crear otro archivo “sample1.py” que contenga el siguiente código.
Python3
def function(name, default=None, *args, variable="1123", a, b, c, employee, office, d, e, f, **kwargs): """This is function is created to demonstrate black""" string = 'GeeksforGeeks' j = [1, 2, 3]
Después de escribir el comando anterior nuevamente en la terminal.
Archivo de salida:
Python3
def function( name, default=None, *args, variable="1123", a, b, c, employee, office, d, e, f, **kwargs ): """This is function is created to demonstrate black""" string = "GeeksforGeeks" j = [1, 2, 3]
Publicación traducida automáticamente
Artículo escrito por itsvinayak y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA