Por que formatar seu código é importante?

#Django
#Python
#Clean Architecture

Escrever código é uma coisa e escreve-lo em um formato que possamos entender depois é outra.

Alguns programadores focam em ter a certeza de que seus códigos estão funcionando e esquecem de formatar o código corretamente e isso pode se tornar um problema em códigos muito extensos ou quando trabalhamos em equipe.

Por que formatar seu código é importante?

# Legibilidade

Formatar seu código ajudará você a ler seu código de modo eficiente. Ele parece mais organizado e, quando alguém olhar para ele, terá uma boa impressão.

# Ajudará em suas entrevistas de programação

Quando você estiver em uma entrevista de programação, às vezes, os entrevistadores estarão atentos ao fato de você estar ou não formatando o código corretamente. Se você se esquecer dessa formatação, poderá perder sua perspectiva de emprego apenas por causa de seu código mal formatado.

# Apoio da equipe

Formatar seu código se torna mais importante quando você está trabalhando em uma equipe. Várias pessoas, provavelmente, estarão trabalhando no mesmo projeto de software. O código que você escreve deve ser entendido por seus colegas de equipe. Caso contrário, torna-se mais difícil trabalhar em conjunto.

# Facilita a detecção de bugs

Um código mal formatado pode tornar extremamente difícil a detecção de bugs e também é realmente díficil de se ver, aumentando o tempo de debug e gerando perda de produtividade..

E se tivéssemos uma ferramenta para identificar e resolver o problema?

O Black é uma ferramenta que permite que você identifique erros e formate seu código em python e django ao mesmo tempo. Assim se tornamos mais produtivos!

Como utilizar o black para formatar seu código:

-Instalando pelo terminal

pip install black

-Agora no terminal

  #formata o arquivo escolhido
black nomedoarquivo.py
  # formata todos os arquivos no diretorio
  black .
  # verifica arquivos para formatação sem modifica-los
  black --check .
  # mostra o que precisa ser feito sem modificar o arquivo
  black --check --diff nomedoarquivo.py
  # altera numero de carcteres para quebra de linha(padrãoé 88)
  black -l 60 nomedorquivo.py

Obs:

Os comandos acima devem ser executados um por vez.

Black utiliza aspas duplas por padrão mas se quiser aspas simples como padrão pode utilizar a ferramenta blue.

Os comandos são os mesmos mas precisa substituir 'black' por 'blue' nos códigos.

exemplo:

  pip install blue

Existem varias ferramentas que facilitam nosso dia. Mas é importante entender suas funcionalidades e como utiliza-las.

Abaixo alguns exemplos de algumas extensões que podem ser instaladas no vsCode e utilizadas para projetos django:

Django:

inclui recursos como destaque de sintaxe, snippets, integração com o terminal do Django, geração de arquivos de templates, e muito mais.

Djaneiro:

inclui snippets para views, models, forms, urls, admin, e outros recursos do Django.

Python:

autocompletar de código e realce de sintaxe para Python, entre outros recursos do Python.

Espero que tenha ajudado.

Em caso de dúvidas avise nos comentários.

Obrigado.