Test Documento

'''Exemplo de formatação Código Python

Docstrings são importantes também em módulos.
Indique autoria e contato, data.
Comente sobre a função do módulo e casos de uso.

Importante:
    Não precisa ensinar Python em DocStrings ou comentários, explique o "porque"
     da existência, cite um caso de uso - e pode escrever a vontade, é grátis!

Autor: <nome do autor> mesmo se usa git!
Data:  <indique >
'''

VAR_GLOBAL = None  # var globais são MAIUSCULAS

NUMEROS = [1,2,3,4,5,]  # definidas no início

LETRAS = ['a', 'b', 'c', 'd', ]  # nome da var, indique o conteúdo ou função

ENUM_LETRAS = {'A': 1, 'B': 2, 'C':3}  # comentarios tem 2 espaços antes `#` e um (1) " " (espaço) depois


def funcao_externa(par1, par2=1, par3=''):
    ''' Docstrings sao mandatórias

    mesmo nas funcoes mais simples.

    Args:
        par1 (int): dividendo
        par2 (int): divisor
        par3 (str): string para elucidar a resp - padrão='' string vazia

    ex.: em python podemos usar DocTests e exemplificar o uso.
    >>> uncao_externa(2, 1)
    Resposta:  2
    '''
    x = para1/para2+par3

    resp = (f'Resposta: {para4} {x}')

    return resp


# antes de entidades de primeira classe, pulo 2 linhas !
class KlassExemplo:
    '''Classe exemplo de código Python.

    bacana adicionar docstrings para classes também
    '''

    def __init__(self, ):
        '''metodo para mostrar exemplo de formatação de código.'''

        print ("iniciou!")

    @classmethod
    def metodo_da_classe(cls, param01):
        ''' método usado para exemplo

        recebe a própria classe como parametro

        Args:
            param01 (_type_): um parameto qualquer
        '''
        if param01 == 1:  # olha o if ! ;)
            # linhas de comentários te 2 e 1 espaços antes e depois do `#` (sharp) respectivamente
            print("parametro é igual a 1")
            return 1


    def metodo_exemplo(self, param_a, n_param=''):
        '''
        metodo para exemplo

        Args:
        param_a (_type_): parametro posisicional 1
        n_param (str, optional):parametro nomeado. Defaults to ''.
        '''
        if param_a == 1:
            print(f'O n_param={n_param}')
            return 1
        else:
            print("parametro NÃO é igual a 1")
            return 2