Merge pull request #300 from DevoInc/feat/AL-1340_warning_lookups

Feat/al 1340 warning lookups

Author: franjuan

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [6.0.3] - 2025-03-19
+
+### Deprecated
+ - Right now the upload of lookups is based on the `my.lookup.data` and `my.lookup.control` tables.
+This method will soon be deprecated on the Devo backend.
+As an alternative, you can use the Lookups API: [Lookups API Documentation](https://docs.devo.com/space/latest/127500289/Lookups+API).
+The Python SDK will support the Lookups API in future versions.
+
 ## [6.0.2] - 2025-03-07
 
 ### Added

devo/__version__.py

@@ -1,6 +1,6 @@
 __description__ = "Devo Python Library."
 __url__ = "http://www.devo.com"
-__version__ = "6.0.2"
+__version__ = "6.0.3"
 __author__ = "Devo"
 __author_email__ = "[email protected]"
 __license__ = "MIT"

devo/sender/lookup.py

@@ -1,10 +1,17 @@
 # -*- coding: utf-8 -*-
-"""File with utils for send Lookups to Devo"""
+"""File with utils for send Lookups to Devo
+
+This method, based on the `my.lookup.data` and `my.lookup.control` tables, will soon be deprecated on the Devo backend.
+As an alternative, you can use the Lookups API: [https://docs.devo.com/space/latest/127500289/Lookups+API].
+The Python SDK will support the Lookups API in future versions.
+"""
+
 
 import csv
 import re
 import sys
 import time
+import warnings
 
 from devo.sender.data import open_file
 
@@ -291,6 +298,15 @@ def send_control(self, event=None, headers=None, action=None):
         :param action: action, can be START or END
         :return:
         """
+        if event == self.EVENT_START:
+            warnings.warn(
+                "The lookup upload functionality based on the `my.lookup.data` and `my.lookup.control` tables "
+                "will be deprecated in the future. Instead, you can use the Lookups API: "
+                "https://docs.devo.com/space/latest/127500289/Lookups+API. The next version of the Python SDK will be "
+                "based on this API.",
+                DeprecationWarning,
+                stacklevel=2
+            )
         if event == self.EVENT_END:
             time.sleep(self.delay)
         line = "%s_%s|%s|%s" % (self.lookup_id, self.name, event, headers)

docs/sender/lookup.md

@@ -13,6 +13,13 @@
 
 <!-- /code_chunk_output -->
 
+> [!WARNING]  
+>  Right now the upload of lookups is based on the `my.lookup.data` and `my.lookup.control` tables. 
+> This method will soon be deprecated on the Devo backend.
+> As an alternative, you can use the Lookups API: [Lookups API Documentation](https://docs.devo.com/space/latest/127500289/Lookups+API).
+> The Python SDK will support the Lookups API in future versions.
+
+
 ## Overview
 
 This library allows you to send lookups to the Devo platform.

tests/integration/test_sender_send_lookup.py

@@ -366,6 +366,37 @@ def test_escape_quotes_in_send_csv_delete_index(setup):
         )
         clean_field.assert_called_with("ffffff", True, False)
 
+def test_deprecated_warning(setup):
+    engine_config = SenderConfigSSL(
+        address=(setup.ssl_address, setup.ssl_port),
+        key=setup.local_server_key,
+        cert=setup.local_server_cert,
+        chain=setup.local_server_chain,
+        check_hostname=False,
+        verify_mode=CERT_NONE,
+    )
+    con = Sender(engine_config)
+    with pytest.warns(DeprecationWarning) as record:
+        lookup = Lookup(name=setup.lookup_name, historic_tag=None, con=con)
+
+        with open(setup.lookup_file) as f:
+            line = f.readline()
+
+        lookup.send_csv(
+            setup.lookup_file,
+            headers=line.rstrip().split(","),
+            key=setup.lookup_key,
+        )
+
+    con.socket.shutdown(0)
+
+    assert len(record) == 1
+    warning = record[0]
+    expected_message = ("The lookup upload functionality based on the `my.lookup.data` and `my.lookup.control` tables "
+                        "will be deprecated in the future. Instead, you can use the Lookups API: "
+                        "https://docs.devo.com/space/latest/127500289/Lookups+API. The next version of the Python SDK "
+                        "will be based on this API.")
+    assert expected_message in str(warning.message)
 
 if __name__ == "__main__":
     pytest.main()