Remove CORREIOS API site support

CORREIOS add captcha to CEP site.
mstuttgart · Sep 5, 2024 · d4d6d87 · d4d6d87
1 parent 6f03ab1
commit d4d6d87
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,6 @@ Currently supports several CEP API's:
 - [ViaCEP](https://viacep.com.br)
 - [ApiCEP (WideNet)](https://apicep.com)
 - [OpenCEP](https://opencep.com/)
-- [Correios (site)](https://www2.correios.com.br/sistemas/buscacep/resultadoBuscaEndereco.cfm)
 
 > [!NOTE]
 > **BrazilCEP** is the new name of former **PyCEPCorreio** python library.

diff --git a/brazilcep/client.py b/brazilcep/client.py
@@ -11,8 +11,9 @@
 
 import enum
 import re
+from warnings import warn
 
-from . import apicep, correios, opencep, viacep
+from . import apicep, opencep, viacep
 
 NUMBERS = re.compile(r"[^0-9]")
 DEFAULT_TIMEOUT = 5  # in seconds
@@ -32,7 +33,8 @@ class WebService(enum.Enum):
 
 
 services = {
-    WebService.CORREIOS: correios.fetch_address,
+    # TOFIX: compatibility adjust. remove CORREIOS in next version
+    WebService.CORREIOS: opencep.fetch_address,
     WebService.VIACEP: viacep.fetch_address,
     WebService.APICEP: apicep.fetch_address,
     WebService.OPENCEP: opencep.fetch_address,
@@ -59,11 +61,12 @@ def get_address_from_cep(cep, webservice=WebService.APICEP, timeout=None, proxie
 
     """
 
+    if webservice == WebService.CORREIOS:
+        warn("CORREIOS is going to be deprecated. Please, use other webservice.", DeprecationWarning, stacklevel=2)
+
     if webservice not in (value for _, value in WebService.__dict__.items()):
         raise KeyError(
-            """Invalid webservice. Please use this options:
-        WebService.VIACEP, WebService.APICEP, WebService.CORREIOs or WebService.OPENCEP
-    """
+            """Invalid webservice. Please use this options: WebService.VIACEP, WebService.APICEP or WebService.OPENCEP"""
         )
 
     kwargs = {}

diff --git a/brazilcep/correios.py b/brazilcep/correios.py
diff --git a/docs/index.md b/docs/index.md
@@ -60,6 +60,5 @@ Its objective is to provide a common query interface to all these search service
   * [ViaCEP](https://viacep.com.br)
   * [ApiCEP (WideNet)](https://apicep.com)
   * [OpenCEP](https://opencep.com/)
-  * [Correios (site)](https://www2.correios.com.br/sistemas/buscacep/resultadoBuscaEndereco.cfm)
 
 BrazilCEP started as a personal study project and evolved into a serious and open source project that is used by many developers on a daily basis.
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ classifiers = [
   "Natural Language :: Portuguese (Brazilian)",
 ]
 
-dependencies = ["zeep>=4.2.1", "requests>=2.28.2", "beautifulsoup4>=4.12.3"]
+dependencies = ["zeep>=4.2.1", "requests>=2.28.2"]
 
 [project.optional-dependencies]
 
@@ -41,6 +41,7 @@ dev = [
   "black>=23.0,<24.0",
   "isort>=5.12,<5.13",
   "ruff",
+  "ipdb",
 ]
 
 coverage = ["coveralls>=3.3.1", "pytest-cov>=4.0.0", "requests-mock>=1.10.0"]

diff --git a/tests/test_client.py b/tests/test_client.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-from brazilcep import get_address_from_cep, WebService
+from brazilcep import WebService, get_address_from_cep
 from brazilcep.client import _format_cep
 
 

diff --git a/tests/test_correios.py b/tests/test_correios.py