implement new types of key by NathanAllmeida · Pull Request #1 · Mostela/pix-qrcode

NathanAllmeida · 2022-06-10T01:25:35Z

No description provided.

sourcery-ai · 2022-06-10T01:25:39Z

Sourcery Code Quality Report

❌ Merging this PR will decrease code quality in the affected files by 12.61%.

Quality metrics	Before	After	Change
Complexity	2.25 ⭐	5.32 ⭐	3.07 👎
Method Length	27.57 ⭐	39.62 ⭐	12.05 👎
Working memory	4.70 ⭐	7.00 🙂	2.30 👎
Quality	88.86% ⭐	76.25% ⭐	-12.61% 👎

Other metrics	Before	After	Change
Lines	73	139	66

Changed files	Quality Before	Quality After	Quality Change
pixqrcode/service/generate_code.py	89.44% ⭐	82.28% ⭐	-7.16% 👎
pixqrcode/service/validate_pix.py	88.70% ⭐	75.15% ⭐	-13.55% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
pixqrcode/service/generate_code.py	GenerateCode.generate	0 ⭐	91 🙂	21 ⛔	57.40% 🙂	Extract out complex expressions
pixqrcode/service/validate_pix.py	ValidatePix.detect_type_key	12 🙂	92 🙂	10 😞	58.61% 🙂	Extract out complex expressions
pixqrcode/service/validate_pix.py	ValidatePix.validateCPF	4 ⭐	129 😞	7 🙂	67.92% 🙂	Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

NathanAllmeida · 2022-06-10T01:25:49Z

Olá
Vi seu repositório e vi que aceitava apenas chave telefone, fiz umas mudanças para aceitar outras. Sou iniciante em python então aceito sugestões também

Mostela

Tem algumas correções simples como nome de variável que não segue o padrão do código, alguns blocos de código um pouco confusos e algumas coisas ligadas a padrão de projetos que pode ser melhorado.

Mostela · 2022-07-12T03:46:17Z

pixqrcode/service/generate_code.py

-        return f"00020126360014{self.merchant.globally_unique_identifier}0114{pix.mobile}520400005303986540" \
+        valPix = ValidatePix(pix)
+        detect_type = valPix.detect_type_key
+        code = detect_type()


Tu pode instanciar a classe direto e já puxar o método não precisaria passar para dentro de outra variável.
Mesma coisa o code = detect_type() tu pode passar o método já direto dentro da string, ficaria igualmente legível.

Mostela · 2022-07-12T03:47:32Z

pixqrcode/service/generate_code.py


    def generate(self, pix: Pix):
-        return f"00020126360014{self.merchant.globally_unique_identifier}0114{pix.mobile}520400005303986540" \
+        valPix = ValidatePix(pix)


Aqui seguir o padrão de ter lowercase (snake_case) para as variáveis dentro de funções

Mostela · 2022-07-12T04:09:49Z

pixqrcode/service/validate_pix.py

+        if len(numbers) != 11 or len(set(numbers)) == 1:
+            return False
+
+        sum_of_products = sum(a*b for a, b in zip(numbers[0:9], range(10, 1, -1)))


A logica de validação de CPF ficou um pouco confusa sobre qual digito é. Coloque um comentário para ajudar a ler no futuro sobre qual é qual mais precisamente, vai ajudar bastante quando tu tem blocos de códigos parecidos

Mostela · 2022-07-12T04:11:23Z

pixqrcode/service/validate_pix.py

-    def mobile(self):
-        if not self.pix.mobile:
-            raise PixError("telefone nao informado")
+    def validateCPF(self):


o padrão para o nome dos métodos também segue como lowercase (snake_case). Mesmo CPF sendo "nome" o aconselhável é seguir como os demais métodos.

Mostela · 2022-07-12T04:16:54Z

pixqrcode/service/validate_pix.py

+    """
+    def detect_type_key(self):
+        key = self.pix.mobile
+        regex = re.search(r'^[a-zA-Z0-9._-]+@[a-zA-Z0-9]+\.[a-zA-Z\.a-zA-Z]{1,10}$', key)


o nome da variável pode deixar confuso durante o uso ao longo do código, talvez ser mais especifico regex_email = re....

Mostela · 2022-07-12T05:23:46Z

pixqrcode/service/validate_pix.py

+        # 0114 - Telefone
+
+        code = ""
+        if regex is None:


No fluxo de validação da chave ele acaba realizando uma dupla função, Descobrir qual tipo de chave é se é email, cpf, cnpj ou telefone e validar a chave, isso torna o fluxo mais difícil de entender e tb com if um dentro do outro como é esse o caso aqui.

Ai o que é interessante de se fazer, ter fluxos distintos para isso. Em um você Descobrir qual tipo de chave é e o segundo validar a chave com base no tipo se houver um match.

Podendo assim ter vários métodos um para cada tipo de chave, e ai chamar um método que identifica o tipo de chave no validade (linha 14) e chama o método corresponde para aquele tipo de chave.

Mostela · 2022-07-12T05:29:42Z

pixqrcode/service/validate_pix.py

+                code = '0111' #creio que o codigo esteja errado, nao achei nada sobre
            else:
-                self.pix.mobile = f"+{self.pix.mobile}"
+                raise Exception("A chave informada não foi identificada")


Voltar o Exception aqui vai disparar um erro que não está padronizado para tratamento. Utilizar a classe PixError, ai quando houver um erro que precise ser reportado tu não corre o risco de parar o código simulando uma Exception genérica.

Mostela · 2022-07-12T05:36:52Z

pixqrcode/service/generate_code.py


    def generate(self, pix: Pix):
-        return f"00020126360014{self.merchant.globally_unique_identifier}0114{pix.mobile}520400005303986540" \
+        valPix = ValidatePix(pix)


O ValidatePix é chamado no init.py dentro do metodo is_valid()
O code tu pode passar ele utilizando a DTO Pix o parametro que a classe recebe

Mostela · 2022-07-12T05:45:26Z

pixqrcode/service/validate_pix.py

+    def mobile(self):
+        if not self.pix.mobile:
+            raise PixError("Chave nao informado")
+        code = self.detect_type_key()


Em um debug do código, o método de detect_type_key executou duas vezes. Eu deduzo que isso não seja o comportamento espero

Mostela · 2022-07-12T06:18:06Z

pixqrcode/service/validate_pix.py

+        if not self.pix.mobile:
+            raise PixError("Chave nao informado")
+        code = self.detect_type_key()
+        if code == '0114':


Evitar a utilização de números mágicos como esse ao longo do código.

Mostela · 2022-07-12T06:20:39Z

Olá Vi seu repositório e vi que aceitava apenas chave telefone, fiz umas mudanças para aceitar outras. Sou iniciante em python então aceito sugestões também

Que legal!!
Fico muito feliz pela contribuição sua 😄

implement new types of key

7f70e54

sourcery-ai bot mentioned this pull request Jun 10, 2022

implement new types of key (Sourcery refactored) #2

Open

Mostela requested changes Jul 12, 2022

View reviewed changes

Conversation

NathanAllmeida commented Jun 10, 2022

Uh oh!

sourcery-ai bot commented Jun 10, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

NathanAllmeida commented Jun 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Mostela left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mostela commented Jul 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NathanAllmeida commented Jun 10, 2022 •

edited

Loading