Skip to content

Como configurar o Black no VSCode

Published by Guilherme Haynes Howe on 11/08/2021

Last updated on 28/09/2023

Salve galerinhaaaa, Tudo certo com vocês?

Hoje vou deixar um mini tutorial de como instalar o Black e configurar ele no VSCode. (Dando algumas outras dicas de configurações para resolver sua vida nesse editor lindo <3)

O que é Black?

De acordo com o GitHub dele:

Black é o formatador de código Python intransigente. Ao usá-lo, você concorda em ceder o controle sobre as minúcias da formatação manual. Em troca, o Black oferece a você velocidade, determinismo e liberdade do estilo pycodestyle sobre a formatação. Você economizará tempo e energia mental para assuntos mais importantes.

Retirado e Traduzido do GitHub do Black

Por que usar o Black?

O Black é um formatador de código para o python, diferente do que muitos pensam, o PEP8 é só um guia de estilos para ser seguido, e não uma ferramenta que faz isso para você.

No caso, o Black entra como esse cara, que puxa a responsabilidade de formatar o código de acordo com os estilos da PEP8 enquanto você tem seu foco somente no que é necessário.

Como Instalar o Black?

Para isso vamos instalar ele utilizando o gerenciador de pacotes PIP

> pip install black --pre

utilizamos o parâmetro --pre por que o black esta na versão beta.

Como integrar o Black no VSCode?

Bom, primeiro você tem que ter a extensão do python oficial da Microsoft instalada no seu VSCode. Caso não tenha só acessar o link abaixo para instalar.

https://marketplace.visualstudio.com/items?itemName=ms-python.python

Vá para as configurações no seu código VS digitando Ctrl + , ou clicando na engrenagem na parte inferior esquerda e selecionando a opção “Configurações [Ctrl +,]”.

E coloque essas informações no arquivo settings.json

"editor.codeActionsOnSave": {
    "source.organizeImports": true
},
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"python.formatting.provider": "black",
"python.formatting.blackArgs": [
    "-t",
    "py37"
]

O que esse json faz?

codeActionsOnSave: Toda ação que vai ser executada quando um arquivo é salvo, no caso vai ser acionado o organizador de imports.

formatOnSave e formatOnPaste: É acionado o formatter toda vez que um código é colado ou salvo em um determinado arquivo. |

python.formatting.provider: estou informando a extensão do Python que o formatter que ele vai utilizar é o Black

python.formatting.blackArgs: estou passando alguns argumentos para ele, como por exemplo o -t, que é o estilo de código que ele vai utilizar. No caso o estilo da formatação do python3.7.

Comenta ai o que achou da publicação, e comenta também se tiver alguma dica de temas para abordar nos próximos posts <3

Published inProgramação