Estruturação de programas Python

Neste artigo, você conhecerá a estruturação e a formatação adequadas de seus programas Python.

Instruções Python Em geral, o interpretador lê e executa as instruções linha por linha, ou seja, sequencialmente. Porém, existem algumas instruções que podem alterar esse comportamento, como as instruções condicionais. Geralmente, as instruções python são escritas em um formato que uma instrução é escrita apenas em uma única linha. O intérprete considera o 'caractere de nova linha' como o terminador de uma instrução. Mas, escrever várias instruções por linha também é possível, você pode encontrar abaixo um exemplo disso.

Exemplos:

# Exemplo 1

print('Bem-vindo ao Acervo Lima')

# Exemplo 2

x = [1, 2, 3, 4]

# x[1:3] significa que começa do index 1 e vai até o 3
print(x[1:3])

""" No formato mencionado acima,
o primeiro índice é incluído,
mas o último índice não é incluído. """

Várias instruções por linha Também podemos escrever várias instruções por linha, mas não é uma boa prática, pois reduz a legibilidade do código. Tente evitar escrever várias instruções em uma única linha. Mas, ainda assim, você pode escrever várias linhas encerrando uma instrução com a ajuda de ‘;’. ‘;’ É usado como o terminador de uma instrução neste caso. Por exemplo, considere o código a seguir.

# Exemplo 

a = 10; b = 20; c = b + a

print(a); print(b); print(c)

Saída:

10
20
30

Continuação de linha para evitar rolagem para a esquerda e para a direita
Algumas declarações podem se tornar muito longas e forçar você a rolar a tela para a esquerda e para a direita com frequência. Você pode ajustar seu código de forma que não precise rolar aqui e ali. Python permite que você escreva uma única instrução em várias linhas, também conhecido como continuação de linha. A continuação da linha também melhora a legibilidade.

# Má prática, pois a largura deste código é muito grande.
# código

x = 10
y = 20
z = 30

não_de_professores = x
não_de_estudantes_masculinos = y
não_de_estudantes_femininos = z

if (não_de_professores == 10 and não_de_estudantes_femininos == 30 and não_de_estudantes_masculinos == 20 and (x + y) == 30):
    print('Esse jeito é válido')

# Isso poderia ser feito em vez disso:
if (não_de_professores == 10 and não_de_estudantes_femininos == 30
    and não_de_estudantes_masculinos == 20 and x + y == 30):

    print('Esse jeito é válido')

Tipos de continuação de linha
Em geral, existem dois tipos de continuação de linha:

Continuação de linha implícita
Esta é a técnica mais direta para escrever uma declaração que se estenda por várias linhas. Qualquer instrução contendo parênteses de abertura '(', colchetes '[' ou chaves '{' é considerada incompleta até que todos os parênteses, colchetes e chaves correspondentes tenham sido encontrados. Até então, o instrução pode ser continuada implicitamente nas linhas sem gerar um erro.

Exemplo 1:

# Exemplo 1 
  
# Esse código é válido
a = [
    [1, 2, 3],
    [3, 4, 5],
    [5, 6, 7]
    ]

print(a)

Saída:

[[1, 2, 3], [3, 4, 5], [5, 6, 7]]

Exemplo 2:

# Exemplo 2
# O código abaixo tambem é válido

pessoa_1 = 18
pessoa_2 = 20
pessoa_3 = 12

if (
    pessoa_1 >= 18 and
    pessoa_2 >= 18 and
    pessoa_3 < 18
    ):
    print('2 pessoas devem ter carteiras de identidade')

Saída:

2 pessoas devem ter carteiras de identidade

Continuação de linha explícita
A união de linha explícita é usada principalmente quando a união de linha implícita não é aplicável. Nesse método, você deve usar um caractere que ajude o intérprete a entender que a instrução específica abrange mais de uma linha.
Barra invertida (\) é usada para indicar que uma instrução se estende por mais de uma linha. O ponto deve ser observado que a barra invertida deve ser o último caractere nessa linha, mesmo espaços em branco não é permitido.
Veja o exemplo a seguir para esclarecimentos.

# Exemplo

x = \
    1 + 2 \
    + 5 + 6 \
    + 10

print(x)

Saída:

24

Comentários em Python
Escrever comentários no código é muito importante e eles ajudam na legibilidade do código e também informam mais sobre o código. Isso ajuda você a escrever detalhes em uma instrução ou um pedaço de código. O intérprete ignora os comentários e não os conta nos comandos. Nesta seção, aprenderemos como escrever comentários em Python.
Os símbolos usados para escrever comentários incluem Hash (#) ou aspas duplas triplas ("""). O hash é usado para escrever comentários de uma única linha que não abrangem várias linhas. As aspas triplas são usadas para escrever comentários de várias linhas. Três aspas triplas para iniciar o comentário e novamente três aspas para encerrar o comentário.
Considere os seguintes exemplos:

# Exemplo 1

####### Esse exemplo não vai imprimir Hello World ####### print('Hello World')  # Porque isso é um comentário

# Exemplo 2
  
""" Esse exemplo vai
    demonstrar vários
    comentários """
  
""" A variável seguinte
    vai guardar o valor
    'How old are you?' 
"""
a = 'How old are you?'

""" A declaração seguinte
    imprime na tela
    o conteúdo da variável a """
print(a)

Nota: Observe que o hash (#) dentro de uma string não significa um comentário. Considere o seguinte exemplo para demonstração.

# Exemplo

""" A seguinte instrução imprime
    a string armazenada na variável """

a = 'Isso não # é um comentário #'
print(a) # imprime o conteúdo da variável a

Espaços em branco
Os caracteres de espaço em branco mais comuns são os seguintes:

Caractere	Código ASCII	Expressão Literal
Espaço em branco	32 (0x20)	''
Tab	9 (0x9)	'\t'
Nova linha	10 (0xA)	'\n'

* Você sempre pode consultar a Tabela ASCII clicando aqui.

O espaço em branco é quase sempre ignorado e não exigido pelo interpretador Python. Quando estiver claro onde um token termina e o próximo começa, os espaços em branco podem ser omitidos. Geralmente, esse é o caso quando caracteres especiais não alfanuméricos estão envolvidos.
Veja exemplos:

# Exemplo 1

# Correto, mas o espaço em branco pode melhorar a legibilidade

a = 1-2  # Melhor desse jeito a = 1 - 2

print(a)

# Exemplo 2

# Isso esta correto
# Espaços em branco podem melhorar a legibilidade
x = 10
flag =(x == 10)and(x<12)
print(flag)

""" Uma forma mais legivel pode ser assim:
x = 10
flag = (x == 10) and (x < 12)
print(flag)
"""

# Experimente o código mais legível

Espaços em branco são necessários para separar as palavras-chave das variáveis ou outras palavras-chave. Considere o seguinte exemplo.

# Exemplo

x = [1, 2, 3]
y = 2

""" Esse código esta errado e vai gerar um erro de sintaxe
a = yin x
"""

# Essa é a versão correta
a = y in x
print(a)

Espaços em branco como indentação
A sintaxe do Python é muito fácil, mas ainda assim você deve tomar alguns cuidados ao escrever o código. A indentação é usada na escrita de códigos Python.
Os espaços em branco antes de uma instrução têm um papel significativo e são usados na indentação. O espaço em branco antes de uma declaração pode ter um significado diferente. Vamos tentar um exemplo.

# Exemplo
  
print('foo') # Correto

   print('foo') # Isso vai gerar um erro

# O erro deve ser algo como 'unexpected indent'

Espaços em branco à esquerda são usados para determinar o agrupamento das instruções como em loops ou estruturas de controle, etc.
Exemplo:

# Exemplo

x = 10

while(x != 0):
    if(x > 5):   # Linha 1
        print('x > 5')  # Linha 2
    else:        # Linha 3
        print('x < 5') # Linha 4 
x -= 2       # Linha 5

"""
As linhas 1, 3 e 5 estão no mesmo nivel
A linha 2 vai ser executada apenas se x for maior que 5
A linha 4 vai ser executada apenas se x não for maior que 5
"""

x > 5
x > 5
x > 5
x < 5
x < 5

Artigo escrito por AnasShamoon e melhorado por harlinseritt
Traduzido por Acervo Lima de Structuring Python Programs

Anterior Próximo