diff --git a/aula156/documentando_class.py b/aula156/documentando_class.py new file mode 100644 index 0000000..fc38aeb --- /dev/null +++ b/aula156/documentando_class.py @@ -0,0 +1,59 @@ +"""Este é um módulo de exemplo + +Este módulo contém funções e exemplos de documentação de funções. +A função soma você já conhece bastante. +""" +variavel_1 = 1 + +# def soma(x, y): + + +class Foo: + """Este é um módulo de exemplo + + Este módulo contém funções e exemplos de documentação de funções. + A função soma você já conhece bastante. + """ + + def soma(self, x: int | float, y: int | float) -> int | float: + """Soma x e y + + Este módulo contém funções e exemplos de documentação de funções. + A função soma você já conhece bastante. + + :param x: Número 1 + :type x: int or float + :param y: Número 2 + :type y: int or float + + :return: A soma entre x e y + :rtype: int or float + """ + return x + y + + def multiplica( + self, + x: int | float, + y: int | float, + z: int | float | None = None + ) -> int | float: + """Multiplica x, y e/ou z + + Multiplica x e y. Se z for enviado, multiplica x, y, z. + """ + if z is None: + return x * y + return x * y * z + + def bar(self) -> int: + """O que ele faz + + :raises NotImplementedError: Se o método não for definido + :raises ValueError: Se o método não for definido + """ + raise NotImplementedError('Teste') + + +variavel_2 = 2 +variavel_3 = 3 +variavel_4 = 4 diff --git a/aula156/main.py b/aula156/main.py index 371a2c2..4ca995d 100644 --- a/aula156/main.py +++ b/aula156/main.py @@ -1,9 +1,10 @@ # import uma_linha # import varias_linhas -import documentando_funcoes +# import documentando_funcoes +import documentando_class # print(dir(uma_linha)) # print(uma_linha.__doc__) # print(uma_linha.__file__) # print(uma_linha.__name__) -help(documentando_funcoes) +help(documentando_class)