Aprimorando a Qualidade do Código Python com Pylint

Olá galera Dev!

Hoje venho compartilhar com a comunidade mais uma ferramenta que ajuda a implementar o PEP8 em nosso código Python. O nome desta biblioteca é Pylint, uma ferramenta incrível para manter a qualidade do nosso código.

Mais o que é PEP8?

PEP8 é um guia de estilo para Python que para garantir a consistência em nossos códigos. Criado pela comunidade Python, ele define convenções sobre como escrever um código Python mais legível e padronizado, incluindo indentação, espaçamento, nomeação de variáveis e muito mais.

O que é o Pylint?

Pylint é uma ferramenta que analisa nosso código Python para garantir que ele siga as normas do PEP8. Além disso, o Pylint atribui notas ao nosso código, ajudando-nos a identificar áreas que precisam de melhorias em termos de estilo e boas práticas.

Como instalar o Pylint no seu VS Code

Para instalar o Pylint no Visual Studio Code, siga os passos abaixo:

1. Abra o terminal integrado no VS Code.
2. Digite o comando abaixo para instalar o Pylint via pip:

pip install pylint

• Após a instalação, configure o VS Code para usar o Pylint:
• Vá em File > Preferences > Settings ou use Ctrl + ,.
• Pesquise por "Pylint" e certifique-se de que a opção Python > Linting: Pylint Enabled esteja marcada.

Como usar o Pylint via terminal

Para utilizar o Pylint através do terminal, basta seguir os passos:

• Navegue até o diretório onde seu arquivo Python está localizado. Utilize os comandos cd.. para retroceder alguma pasta ou cd nome_da_pasta para acessar o diretório descrito. Por exemplo, se seu arquivo se chama exemplo_jarvis.py, use o comando:

cd /caminho/para/seu/projeto

• Execute o Pylint no seu arquivo com o comando abaixo:

pylint exemplo_jarvis.py

Exemplo de código com Pylint

Suponha que você tenha o seguinte arquivo exemplo_jarvis.py:

"""
Módulo de exemplo para demonstrar o uso do Pylint.
"""


def saudacao():
  """
  Função que retorna uma saudação.
  """
  return 'Olá, mundo!'




if __name__ == "__main__":
  print(saudacao())

Ao rodar o Pylint no terminal, você poderá ver uma saída semelhante a esta:

************* Module exemplo_jarvis
exemplo_jarvis.py:1:0: C0114: Missing module docstring (missing-module-docstring)
exemplo_jarvis.py:3:0: C0116: Missing function or method docstring (missing-function-docstring)


------------------------------------------------------------------
Your code has been rated at 7.50/10 (previous run: 7.50/10, +0.00)

O Pylint apresenta todas as mudanças necessárias a serem feitas linha a linha, para que seja possível adequa-las ao PEP8. O Pylint também atribui uma nota inicial que é informada o acréscimo ou decréscimo da nota caso você altere o código.

Concluindo

O Pylint é uma ferramenta poderosa para desenvolvedores Python, especialmente para aqueles que estão começando. Ele não só ajuda a manter o código limpo e padronizado, como também oferece feedback valioso sobre como melhorar a qualidade do nosso código. Implementar o PEP8 com a ajuda do Pylint fará com que seu código seja mais legível, consistente e fácil de manter.

Espero que ter ajudado um pouco e que seja útil para melhorar ainda mais seus projetos em Python. Até a próxima!

Link da Documentação do Pylint: https://docs.pylint.org/

"Vamos Disseminar os Conhecimentos e Transbordar Tudo que Aprendemos"

Segue lá no GitHub: https://github.com/Carlos-CGS

Segue lá no LinkedIn: https://www.linkedin.com/in/carlos-cgs/