Merge pull request #6 from buserbrasil/fix-pyright-errors

Fix pyright errors

Author: ecarrara

santander_client/api_client/abstract_client.py

@@ -3,7 +3,7 @@
 
 class SantanderAbstractApiClient(ABC):
     @abstractmethod
-    def get(self, endpoint: str, params: dict = None) -> dict:
+    def get(self, endpoint: str, params: dict | None = None) -> dict:
         pass
 
     @abstractmethod

santander_client/api_client/client.py

@@ -36,15 +36,15 @@ class SantanderApiClient(SantanderAbstractApiClient):
 
     def __init__(self, config: SantanderClientConfiguration):
         if not isinstance(config, SantanderClientConfiguration):
-            raise SantanderClientConfiguration("Objeto de autenticação inválido")
+            raise SantanderClientException("Objeto de autenticação inválido")
 
         self.base_url = config.base_url.rstrip("/")
         self.config = config
         self.session = requests.Session()
         self.token = None
         self.token_expires_at = datetime.now()
 
-    def get(self, endpoint: str, params: dict = None) -> dict:
+    def get(self, endpoint: str, params: dict | None = None) -> dict:
         return self._request("GET", endpoint, params=params)
 
     def post(self, endpoint: str, data: dict) -> dict:
@@ -79,12 +79,14 @@ def _authenticate(self) -> None:
         self.token_expires_at = datetime.now() + timedelta(
             seconds=token_data.get("expires_in", 120)
         )
-        self.session.headers = {
-            "Authorization": f"Bearer {self.token}",
-            "X-Application-Key": self.config.client_id,
-        }
+        self.session.headers.update(
+            {
+                "Authorization": f"Bearer {self.token}",
+                "X-Application-Key": self.config.client_id,
+            }
+        )
         self.session.verify = True
-        self.session.cert = self.config.cert
+        self.session.cert = self.config.cert  # pyright: ignore
 
     def _request_token(self) -> dict:
         url = urljoin(self.base_url, TOKEN_ENDPOINT)
@@ -105,7 +107,7 @@ def _request_token(self) -> dict:
             )
             response.raise_for_status()
         except requests.exceptions.RequestException as e:
-            status_code = getattr(e.response, "status_code", None)
+            status_code = getattr(e.response, "status_code", 0)
             response = try_parse_response_to_json(e.response)
             raise SantanderRequestException(
                 f"Erro na obtenção do Token: {e}", status_code, response
@@ -123,7 +125,11 @@ def _prepare_url(self, endpoint: str) -> str:
         return url
 
     def _request(
-        self, method: str, endpoint: str, data: dict = None, params: dict = None
+        self,
+        method: str,
+        endpoint: str,
+        data: dict | None = None,
+        params: dict | None = None,
     ) -> dict:
         self._ensure_requirements()
         url = self._prepare_url(endpoint)
@@ -135,12 +141,12 @@ def _request(
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
-            status_code = getattr(e.response, "status_code", None)
+            status_code = getattr(e.response, "status_code", 0)
             error_content = try_parse_response_to_json(e.response)
             status_description = get_status_code_description(status_code)
 
             raise SantanderRequestException(
                 status_description, status_code, error_content
             )
         except Exception as e:
-            raise SantanderRequestException(f"Erro na requisição: {e}", None, None)
+            raise SantanderRequestException(f"Erro na requisição: {e}", 0, None) from e

santander_client/api_client/helpers.py

@@ -1,7 +1,5 @@
 from decimal import ROUND_DOWN, Decimal
-from datetime import timezone
 import logging
-from dateutil import tz
 from itertools import cycle
 from typing import Literal
 import re
@@ -84,13 +82,6 @@ def get_status_code_description(status_code: int | str) -> str:
     return f"{status_code} - {SANTANDER_STATUS_DESCRIPTIONS.get(int(status_code), 'Erro desconhecido')}"
 
 
-def today():
-    now = (
-        timezone.now().replace(tzinfo=tz.UTC).astimezone(tz.gettz("America/Sao_Paulo"))
-    )
-    return now.date()
-
-
 def only_numbers(s):
     return re.sub("[^0-9]", "", s) if s else s
 

santander_client/api_client/workspaces.py

@@ -33,7 +33,7 @@ def get_first_workspace_id_of_type(
 ) -> str | None:
     _check_client_instance(client)
     workspaces = get_workspaces(client)
-    if len(workspaces) == 0:
+    if workspaces is None or len(workspaces) == 0:
         return None
 
     workspace_id = next(

santander_client/pix.py

@@ -1,7 +1,7 @@
 from decimal import Decimal as D
 import logging
 from time import sleep
-from typing import List, Literal
+from typing import List, Literal, cast
 
 from santander_client.api_client import get_client
 from santander_client.api_client.exceptions import (
@@ -22,8 +22,9 @@
     BeneficiaryDataDict,
     ConfirmOrderStatus,
     CreateOrderStatus,
-    SantanderAPIErrorResponse,
-    SantanderCreatePixResponse,
+    OrderStatus,
+    OrderStatusType,
+    SantanderPixResponse,
     TransferPixResult,
 )
 
@@ -40,8 +41,6 @@
     "checking": "CONTA_CORRENTE",
 }
 
-SantanderPixResponse = SantanderCreatePixResponse | SantanderAPIErrorResponse
-
 
 def transfer_pix_payment(
     pix_info: str | BeneficiaryDataDict, value: D, description: str, tags=[]
@@ -74,16 +73,21 @@ def transfer_pix_payment(
 
         if not pix_id:
             raise SantanderClientException(
-                "ID do pagamento PIX não foi retornada pela criação do pagamento"
+                "ID do pagamento não foi retornada na criação"
+            )
+
+        if payment_status is None:
+            raise SantanderClientException(
+                "Status do pagamento não retornado na criação"
             )
 
         confirm_response = _confirm_pix_payment(pix_id, value, payment_status)
 
-        return {"success": True, "data": confirm_response}
+        return {"success": True, "data": confirm_response, "error": ""}
     except Exception as e:
         error_message = str(e)
         logger.error(error_message)
-        return {"success": False, "error": error_message}
+        return {"success": False, "error": error_message, "data": None}
 
 
 def _pix_payment_status_polling(
@@ -92,7 +96,11 @@ def _pix_payment_status_polling(
     context: Literal["CREATE", "CONFIRM"],
     max_attempts: int,
 ) -> SantanderPixResponse:
-    for attempt in range(max_attempts):
+    response = _request_pix_payment_status(pix_id, context)
+    if response.get("status") in until_status:
+        return response
+
+    for attempt in range(max_attempts - 1):
         response = _request_pix_payment_status(pix_id, context)
         payment_status = response.get("status")
         logger.info(
@@ -102,7 +110,7 @@ def _pix_payment_status_polling(
         if payment_status in until_status:
             break
 
-        if attempt == max_attempts - 1:
+        if attempt == max_attempts - 2:
             raise SantanderTimeoutToChangeStatusException(
                 "Limite de tentativas de atualização do status do pagamento PIX atingido",
                 context,
@@ -114,7 +122,7 @@ def _pix_payment_status_polling(
 
 
 def _confirm_pix_payment(
-    pix_id: str, value: D, payment_status: CreateOrderStatus
+    pix_id: str, value: D, payment_status: OrderStatusType
 ) -> SantanderPixResponse:
     """Confirma o pagamento PIX, realizando polling até que o status seja PAYED ou permaneça PENDING_CONFIRMATION.
 
@@ -169,7 +177,7 @@ def _confirm_pix_payment(
 
 
 def _request_create_pix_payment(
-    pix_info: BeneficiaryDataDict, value: D, description: str, tags=[]
+    pix_info: BeneficiaryDataDict | str, value: D, description: str, tags=[]
 ) -> SantanderPixResponse:
     """Cria uma ordem de pagamento. Caso o status seja REJECTED, a exceção SantanderRejectedTransactionException é lançada.
     Regra de negócio aqui: pagamento por beneficiário na request deve ser informado o bank_code ou ispb, nunca os dois."""
@@ -193,13 +201,16 @@ def _request_create_pix_payment(
                 "documentNumber": pix_info["bank_account"]["document_number"],
                 "name": pix_info["recebedor"]["name"],
             }
-            if pix_info.get("bank_account"):
-                if pix_info["bank_account"].get("bank_code_compe"):
-                    beneficiary["bankCode"] = pix_info["bank_account"][
-                        "bank_code_compe"
-                    ]
-                else:
-                    beneficiary["ispb"] = pix_info["bank_account"]["bank_code_ispb"]
+            bank_account = pix_info["bank_account"]
+            bank_code = bank_account.get("bank_code_compe", "")
+            bank_ispb = bank_account.get("bank_code_ispb", "")
+            if bank_code:
+                beneficiary["bankCode"] = bank_code
+            elif bank_ispb:
+                beneficiary["ispb"] = bank_ispb
+            else:
+                raise SantanderValueErrorException("A chave de entrada é inválida")
+
             data.update({"beneficiary": beneficiary})
         except KeyError as e:
             raise SantanderValueErrorException(
@@ -209,7 +220,7 @@ def _request_create_pix_payment(
         raise SantanderValueErrorException("Chave PIX ou Beneficiário não informado")
 
     client = get_client()
-    response = client.post(PIX_ENDPOINT, data=data)
+    response = cast(SantanderPixResponse, client.post(PIX_ENDPOINT, data=data))
     _check_for_rejected_exception(response, "Criação do pagamento PIX")
     return response
 
@@ -231,6 +242,7 @@ def _request_confirm_pix_payment(pix_payment_id: str, value: D) -> SantanderPixR
         "paymentValue": truncate_value(value),
     }
     response = client.patch(f"{PIX_ENDPOINT}/{pix_payment_id}", data=data)
+    response = cast(SantanderPixResponse, response)
     _check_for_rejected_exception(response, "Confirmação do pagamento PIX")
     return response
 
@@ -249,13 +261,14 @@ def _request_pix_payment_status(
 
     client = get_client()
     response = client.get(f"{PIX_ENDPOINT}/{pix_payment_id}")
+    response = cast(SantanderPixResponse, response)
     _check_for_rejected_exception(response, step_description)
     return response
 
 
 def _check_for_rejected_exception(pix_response: SantanderPixResponse, step: str):
     """Uma transação quando rejeitada com status REJECTED, não deve ser continuada"""
-    if pix_response.get("status") == "REJECTED":
+    if pix_response.get("status") == OrderStatus.REJECTED:
         reject_reason = pix_response.get(
             "rejectReason", "Motivo não retornado pelo Santander"
         )

santander_client/types.py

@@ -120,7 +120,12 @@ class OrderStatus(ConfirmOrderStatus, CreateOrderStatus):
     pass
 
 
-class SantanderCreatePixResponse(TypedDict):
+OrderStatusType = Literal[
+    "READY_TO_PAY", "PENDING_VALIDATION", "PAYED", "PENDING_CONFIRMATION", "REJECTED"
+]
+
+
+class SantanderTransferResponse(TypedDict):
     """
     Resposta da criação de transações pix do Santander (POST).
     - Os campos mais importantes aqui são o id, status, paymentValue e transaction.
@@ -148,75 +153,38 @@ class SantanderCreatePixResponse(TypedDict):
     transaction: SantanderTransaction
     tags: list[str]
     paymentValue: str
-    status: Literal["READY_TO_PAY", "PENDING_VALIDATION", "REJECTED"]
+    status: OrderStatusType
     dictCode: str | None
     dictCodeType: Literal["CPF", "CNPJ", "CELULAR", "EMAIL", "EVP"] | None
     beneficiary: SantanderBeneficiary | None
 
 
-class SantanderPixStatusResponse(TypedDict):
-    """
-    Resposta de transações pix do Santander tanto pelo PATCH quanto pelo GET.
-    - Os campos mais importantes aqui são o id, status, paymentValue e transaction.
+class BankAccountDict(TypedDict):
+    agencia: str
+    conta: str
+    conta_dv: str
+    tipo_conta: Literal["checking", "savings", "salary", "payment"]
+    document_number: str
+    bank_code_compe: str | None
+    bank_code_ispb: str | None
 
-    ### Status
-    'status' de sucesso:
-        - PAYED é o status de pagamento efetuado com sucesso.
-        - PENDING_CONFIRMATION é o status de pendência de confirmação do pagamento, esse status
-        pode acontecer caso alguma câmara de compensação fique fora do ar no exato momento da
-        chamada das APIs, se o banco recebedor está avaliando a transação, se o cliente ficar sem saldo
-        em conta, entre outros casos.
-
-    'status' de erro:
-        - REJECTED é o status de rejeição do pagamento.
 
-    ### Campos de retorno opcionais (meramente informativos, que inclusive são enviados por nós):
-       - Caso seja um pagamento por chave, o campo dictCode e dictCodeType.
-       - O mesmo vale para o beneficiary, caso seja um pagamento por beneficiário.
-    """
-
-    id: str
-    workspaceId: str
-    debitAccount: str
-    remittanceInformation: str
-    nominalValue: str
-    totalValue: str
-    payer: SantanderPayer
-    transaction: SantanderTransaction
-    tags: list[str]
-    paymentValue: str
-    status: Literal[
-        "READY_TO_PAY",
-        "PENDING_VALIDATION",
-        "PAYED",
-        "PENDING_CONFIRMATION",
-        "REJECTED",
-    ]
-    dictCode: str | None
-    dictCodeType: Literal["CPF", "CNPJ", "CELULAR", "EMAIL", "EVP"] | None
-    beneficiary: SantanderBeneficiary | None
+class ReceiverDataDict(BankAccountDict):
+    name: str
 
 
 class BeneficiaryDataDict(TypedDict):
     """Dados do beneficiário para transferência PIX"""
 
-    class BankAccountDict(TypedDict):
-        agencia: str
-        conta: str
-        conta_dv: str
-        tipo_conta: Literal["checking", "savings", "salary", "payment"]
-        document_number: str
-        bank_code_compe: str | None
-        bank_code_ispb: str | None
-
-    class ReceiverDataDict(BankAccountDict):
-        name: str
-
     "Dados do recebedor para transferência PIX"
     bank_account: BankAccountDict
     recebedor: ReceiverDataDict
 
 
+SantanderPixResponse = SantanderTransferResponse | SantanderAPIErrorResponse
+
+
 class TransferPixResult(TypedDict):
     success: bool
-    data: SantanderPixStatusResponse | None
+    data: SantanderPixResponse | None
+    error: str