Dicas para Escrever Código Python como um Programador Sênior

Olá pessoal! Neste artigo, é referente ao desafio de projeto 'Criando Artigos Técnicos com ChatGPT e Lexica.art, Bootcamp Formação ChatGPT for Devs. Vamos falar sobre algumas dicas importantes para escrever código Python de forma profissional e eficiente. Vamos lá!

Quando escrevemos código Python, é muito importante que ele seja fácil de ler e entender. Aqui estão algumas boas práticas que podem te ajudar nisso:

🏷️ 1. Nomeie suas variáveis de forma clara e significativa: Use a convenção snake_case, que consiste em escrever palavras em minúsculas, separadas por underscores(_). Por exemplo: nome_completo ou idade_usuario.

nome_completo = "João da Silva"
idade_usuario = 25

📝 2. Indentação adequada: Python utiliza a indentação para organizar o código em blocos. Certifique-se de usar espaços ou tabulações de forma consistente para que o código fique bem alinhado e fácil de ler.

def saudacao():
  print("Olá!")
  print("Bem-vindo ao nosso programa.")

🗒️ 3. Comentários úteis: Adicione comentários ao seu código para explicar partes mais complexas ou que possam não ser óbvias à primeira vista. Isso ajuda outras pessoas (e você mesmo no futuro) a entenderem o que o código está fazendo. Utilize o # para fazer os comentários em Python e sempre comece a letra maiúscula

# Calcula a média de uma lista de números
def calcular_media(lista):
  total = sum(lista)
  quantidade = len(lista)
  media = total / quantidade
  return media

📏 4. Evite linhas muito longas: Tente manter as linhas de código com até 79 caracteres. Se precisar de mais espaço, quebre a linha em partes menores para facilitar a leitura.

mensagem = "Este é um exemplo de uma linha muito longa que precisamos quebrar em partes menores para melhorar a legibilidade."

⚙️ 5. Use espaços em branco adequadamente: Adicione espaços em branco em torno de operadores para melhorar a legibilidade, como por exemplo, x = 5 + 3 em vez de x=5+3.

numero1 = 5
numero2 = 3
soma = numero1 + numero2

Além de escrever código legível, também é importante torná-lo fácil de manter e atualizar. Aqui estão algumas dicas para garantir a manutenibilidade do seu código:

🧩 1. Divida seu código em funções: Organize o código em funções pequenas e autônomas, cada uma realizando uma tarefa específica. Isso torna o código mais modular e mais fácil de entender e atualizar.

def calcular_media(lista):
  total = sum(lista)
  quantidade = len(lista)
  media = total / quantidade
  return media

def imprimir_resultado(media):
  print(f"A média é: {media}")

notas = [8, 9, 7, 6, 9]
media_notas = calcular_media(notas)
imprimir_resultado(media_notas)

♻️ 2. Evite repetição de código: Se você estiver escrevendo o mesmo trecho de código várias vezes, considere criar uma função para reutilizá-lo. Isso reduzirá a quantidade de código duplicado e facilitará as alterações futuras.

def calcular_area_retangulo(comprimento, largura):
  return comprimento * largura

def calcular_perimetro_retangulo(comprimento, largura):
  return 2 * (comprimento + largura)

comprimento = 5
largura = 3

area = calcular_area_retangulo(comprimento, largura)
perimetro = calcular_perimetro_retangulo(comprimento, largura)

🔤 3. Utilize constantes e variáveis bem nomeadas: Em vez de usar números ou strings diretamente no código, atribua-os a constantes ou variáveis com nomes descritivos. Use a convenção UPPER_CASE para constantes, como por exemplo TAXA_JUROS e a convenção snake_case para variáveis, como nome_cliente.

TAXA_JUROS = 0.05
valor_emprestimo = 1000

valor_juros = valor_emprestimo * TAXA_JUROS

❗ 4. Trate erros e exceções: Antecipe possíveis erros e exceções no seu código e inclua tratamentos adequados para lidar com eles. Isso evita falhas inesperadas e ajuda a identificar e resolver problemas mais facilmente.

try:
  arquivo = open("dados.txt", "r")
  # Código para ler o arquivo...
except FileNotFoundError:
  print("Arquivo não encontrado. Verifique o nome e o diretório.")

🧪 5. Realize testes unitários: Escreva testes automatizados para verificar se suas funções estão produzindo os resultados esperados. Isso ajuda a garantir que o código continue funcionando corretamente mesmo após alterações ou atualizações.

import unittest

class TestCalculadora(unittest.TestCase):
  def test_soma(self):
      resultado = soma(2, 3)
      self.assertEqual(resultado, 5)

  def test_subtracao(self):
      resultado = subtracao(5, 3)
      self.assertEqual(resultado, 2)

unittest.main()

Aqui está a explicação dos estilos de nomenclatura em Python, de uma forma mais simples e adequada:

🐍 snake_case:

 - Utilização: Quando você cria nomes para variáveis, funções, métodos, arquivos ou coisas assim.

 - Descrição: Esse estilo é como uma cobra rastejando! As palavras são escritas em letras pequenas e separadas por traços baixos (_).

Exemplo:

  🐍 nome_completo = "João da Silva"

  🐍 calcular_media = calcular_notas(lista)

🐫 camelCase:

 - Utilização: Quando você cria nomes para classes e métodos.

 - Descrição: Esse estilo é como um camelo andando! As palavras começam com uma letra pequena e cada nova palavra começa com uma letra grande. Não tem espaços entre as palavras.

Exemplo:

  🐫 minhaVariavel = 10

  🐫 calcularMedia = calcularNotas(lista)

📢 UPPER_CASE ou UPPERCASE:

 - Utilização: Quando você cria nomes para coisas que não mudam, chamadas de constantes.

 - Descrição: Esse estilo é como um megafone gritando! Todas as letras são grandes e as palavras são separadas por traços baixos (_). Fica bem chamativo!

Exemplo:

  📢 TAXA_JUROS = 0.05

  📢 VALOR_MAXIMO = 100

Lembre-se de que essas são apenas maneiras diferentes de escrever palavras no código e não há uma forma certa ou errada. É importante seguir as regras do projeto em que você está trabalhando e sempre escolher um estilo de nomenclatura que torne o código fácil de entender e ler.

📣 Call to Action:

Espero que essas dicas tenham sido úteis para você!

🎬 Fontes de produção

imagens geradas por: lexica.art

Conteúdo gerado por: ChatGPT com revisões humanas

 🌟 Hashtags:

#Python #CódigoLegível