Merge pull request #5 from buserbrasil/ruff-check-and-format

style/pep: apply ruff auto-fixes and formatting

Author: ecarrara

.github/workflows/test.yml

@@ -9,6 +9,22 @@ on:
       - main
 
 jobs:
+  code-quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the latest version of uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: ruff format --check
+        run: uv run ruff check
+
+      - name: ruff check
+        run: uv run ruff check
+
   test:
     runs-on: ubuntu-latest
     strategy:

pyproject.toml

@@ -3,29 +3,21 @@ name = "santander-python-sdk"
 dynamic = ["version"]
 description = "Client não oficial da API do Santander em Python"
 authors = [
-    { name = "Samuel Rodrigues Coelho", email = "[email protected]" }
+    { name = "Samuel Rodrigues Coelho", email = "[email protected]" },
 ]
 readme = "README.md"
 keywords = ["santander", "api", "client", "python"]
 requires-python = ">=3.11"
 
 classifiers = [
-  #   3 - Alpha
-  #   4 - Beta
-  #   5 - Production/Stable
-  "Development Status :: 3 - Alpha",
-
-  "Intended Audience :: Developers",
-  "Topic :: Software Development :: Libraries :: Python Modules",
-
-  "License :: OSI Approved :: MIT License",
-
-  "Programming Language :: Python :: 3.11"
-]
-dependencies = [
-    "python-dateutil~=2.0",
-    "requests>=2",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
+dependencies = ["python-dateutil~=2.0", "requests>=2"]
 
 [project.urls]
 homepage = "https://github.com/buserbrasil/santander-python-sdk"
@@ -38,4 +30,8 @@ dev-dependencies = [
     "requests-mock>=1.10.0",
     "pytest-cov>=4.0.0",
     "pytest-mock>=3.14.0",
+    "ruff>=0.9.5",
 ]
+
+[tool.ruff.lint]
+flake8-tidy-imports.ban-relative-imports = "all"

santander_client/api_client/__init__.py

@@ -1,34 +1,46 @@
 import logging
-from typing import TypedDict
-from .exceptions import SantanderConfigurationException, SantanderWorkspaceException
-from .workspaces import get_first_workspace_id_of_type
-from .client import SantanderApiClient
-from .client_configuration import SantanderClientConfiguration
-  
+from santander_client.api_client.exceptions import (
+    SantanderConfigurationException,
+    SantanderWorkspaceException,
+)
+from santander_client.api_client.workspaces import get_first_workspace_id_of_type
+from santander_client.api_client.client import SantanderApiClient
+from santander_client.api_client.client_configuration import (
+    SantanderClientConfiguration,
+)
+
 logger = logging.getLogger("santanderLogger")
-      
+
 santander_client_configuration = None
-      
+
+
 def set_configuration(configuration: SantanderClientConfiguration) -> None:
     if not isinstance(configuration, SantanderClientConfiguration):
         raise SantanderConfigurationException("Configuração inválida fornecida.")
-    
+
     global santander_client_configuration
     santander_client_configuration = configuration
-      
+
+
 def get_client() -> SantanderApiClient:
     """
     Creates and returns an instance of SantanderApiClient based on the provided configuration.
     """
     if not santander_client_configuration:
-        raise SantanderConfigurationException("Configuração do client (SantanderClientConfiguration) não foi denida.")
+        raise SantanderConfigurationException(
+            "Configuração do client (SantanderClientConfiguration) não foi denida."
+        )
 
     santander_client_instance = SantanderApiClient(santander_client_configuration)
 
     if not santander_client_configuration.workspace_id:
-        workspace_id = get_first_workspace_id_of_type(santander_client_instance, "PAYMENTS")
+        workspace_id = get_first_workspace_id_of_type(
+            santander_client_instance, "PAYMENTS"
+        )
         if not workspace_id:
-            raise SantanderWorkspaceException("Conta sem configuração de workspace na configuração e na conta.")
+            raise SantanderWorkspaceException(
+                "Conta sem configuração de workspace na configuração e na conta."
+            )
 
         logger.info(f"Workspace obtido e configurado com sucesso: {workspace_id}")
         santander_client_configuration.set_workspace_id(workspace_id)

santander_client/api_client/client.py

@@ -62,7 +62,8 @@ def patch(self, endpoint: str, data: dict) -> dict:
     @property
     def is_authenticated(self) -> bool:
         return bool(
-            self.token and (self.token_expires_at - BEFORE_EXPIRE_TOKEN_SECONDS) > datetime.now()
+            self.token
+            and (self.token_expires_at - BEFORE_EXPIRE_TOKEN_SECONDS) > datetime.now()
         )
 
     def _ensure_requirements(self) -> None:
@@ -75,7 +76,9 @@ def _authenticate(self) -> None:
         if not self.token:
             raise SantanderClientException("Token de autenticação não encontrado")
 
-        self.token_expires_at = datetime.now() + timedelta(seconds=token_data.get("expires_in", 120))
+        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,
@@ -93,13 +96,20 @@ def _request_token(self) -> dict:
         }
         try:
             response = self.session.post(
-                url, data=data, headers=headers, verify=True, timeout=60, cert=self.config.cert
+                url,
+                data=data,
+                headers=headers,
+                verify=True,
+                timeout=60,
+                cert=self.config.cert,
             )
             response.raise_for_status()
         except requests.exceptions.RequestException as e:
             status_code = getattr(e.response, "status_code", None)
             response = try_parse_response_to_json(e.response)
-            raise SantanderRequestException(f"Erro na obtenção do Token: {e}", status_code, response)
+            raise SantanderRequestException(
+                f"Erro na obtenção do Token: {e}", status_code, response
+            )
         token_data = response.json()
         return token_data
 
@@ -112,19 +122,25 @@ def _prepare_url(self, endpoint: str) -> str:
             url = url.replace(":workspaceid", self.config.workspace_id)
         return url
 
-    def _request(self, method: str, endpoint: str, data: dict = None, params: dict = None) -> dict:
+    def _request(
+        self, method: str, endpoint: str, data: dict = None, params: dict = None
+    ) -> dict:
         self._ensure_requirements()
         url = self._prepare_url(endpoint)
 
         try:
-            response = self.session.request(method, url, json=data, params=params, timeout=60)
+            response = self.session.request(
+                method, url, json=data, params=params, timeout=60
+            )
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
             status_code = getattr(e.response, "status_code", None)
             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)
+            raise SantanderRequestException(
+                status_description, status_code, error_content
+            )
         except Exception as e:
             raise SantanderRequestException(f"Erro na requisição: {e}", None, None)

santander_client/api_client/client_configuration.py

@@ -1,6 +1,12 @@
 class SantanderClientConfiguration:
-
-    def __init__(self, client_id: str, client_secret: str, cert: str, base_url: str, workspace_id: str = ""):
+    def __init__(
+        self,
+        client_id: str,
+        client_secret: str,
+        cert: str,
+        base_url: str,
+        workspace_id: str = "",
+    ):
         self.client_id = client_id
         self.client_secret = client_secret
         self.workspace_id = workspace_id
@@ -10,6 +16,7 @@ def __init__(self, client_id: str, client_secret: str, cert: str, base_url: str,
     def set_workspace_id(self, workspace_id: str):
         self.workspace_id = workspace_id
 
-
     def __repr__(self):
-        return f'SantanderClientConfiguration<client_id={self.client_id} cert={self.cert}>'
+        return (
+            f"SantanderClientConfiguration<client_id={self.client_id} cert={self.cert}>"
+        )

santander_client/api_client/helpers.py

@@ -7,7 +7,11 @@
 import re
 import requests
 
-from santander_client.api_client.exceptions import SantanderRequestException, SantanderValueErrorException
+from santander_client.api_client.exceptions import (
+    SantanderRequestException,
+    SantanderValueErrorException,
+)
+
 logger = logging.getLogger("santanderLogger")
 
 LENGTH_CNPJ = 14
@@ -81,12 +85,16 @@ def get_status_code_description(status_code: int | str) -> str:
 
 
 def today():
-    now = timezone.now().replace(tzinfo=tz.UTC).astimezone(tz.gettz("America/Sao_Paulo"))
+    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
 
+
 def is_valid_cpf(cpf):
     clean_cpf = only_numbers(cpf)
     if (
@@ -98,9 +106,7 @@ def is_valid_cpf(cpf):
     digit = {0: 0, 1: 0}
     a = 10
     for c in range(2):
-        digit[c] = sum(
-            i * int(clean_cpf[idx]) for idx, i in enumerate(range(a, 1, -1))
-        )
+        digit[c] = sum(i * int(clean_cpf[idx]) for idx, i in enumerate(range(a, 1, -1)))
 
         digit[c] = int(11 - (digit[c] % 11))
         if digit[c] > 9:
@@ -129,6 +135,7 @@ def is_valid_cnpj(cnpj):
 
     return True
 
+
 def retry_one_time_on_request_exception(func):
     def wrapper(*args, **kwargs):
         try:
@@ -139,6 +146,7 @@ def wrapper(*args, **kwargs):
 
     return wrapper
 
+
 def convert_to_decimal(cents: int) -> Decimal:
     return Decimal(cents) / 100
 
@@ -148,4 +156,4 @@ def document_type(document_number: str) -> str:
         return "CPF"
     if len(document_number) == 14:
         return "CNPJ"
-    raise SantanderValueErrorException('Unknown document type "{document_number}"')
+    raise SantanderValueErrorException('Unknown document type "{document_number}"')

santander_client/api_client/workspaces.py

@@ -28,14 +28,21 @@ def get_workspaces(client: SantanderAbstractApiClient):
     return response.get("_content", None)
 
 
-def get_first_workspace_id_of_type(client: SantanderAbstractApiClient, workspace_type: WorkspaceType) -> str | None:
+def get_first_workspace_id_of_type(
+    client: SantanderAbstractApiClient, workspace_type: WorkspaceType
+) -> str | None:
     _check_client_instance(client)
     workspaces = get_workspaces(client)
     if len(workspaces) == 0:
         return None
 
     workspace_id = next(
-        (w["id"] for w in workspaces if w.get("type") == workspace_type and w.get("status") == "ACTIVE"), None
+        (
+            w["id"]
+            for w in workspaces
+            if w.get("type") == workspace_type and w.get("status") == "ACTIVE"
+        ),
+        None,
     )
     return workspace_id
 
@@ -45,4 +52,6 @@ def _check_client_instance(client):
         raise SantanderClientException("O client é obrigatório")
 
     if not issubclass(client.__class__, SantanderAbstractApiClient):
-        raise SantanderClientException("O client deve ser uma instância de Herança de BaseSantanderApiClient")
+        raise SantanderClientException(
+            "O client deve ser uma instância de Herança de BaseSantanderApiClient"
+        )