Add deprecations

Author: laurynas

CHANGELOG.md

@@ -14,8 +14,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Switched to v3 API which uses updated language detection model
-- ⚠️ `simple_detect` method renamed to `detect_code`
 - ⚠️ `detect` method result fields are `language` and `score`
-- ⚠️ `detect` method no longer accept arrays - use `detect_batch` instead
-- ⚠️ `user_status` method renamed to `account_status`
-- HTTPS is used by default. Removed secure mode configuration.
+
+### Deprecated
+- Calling `detect()` with list argument. Use `detect_batch` instead.
+- `simple_detect()` - Use `detect_code()` instead. Will be removed in a future version.
+- `user_status()` - Use `account_status()` instead. Will be removed in a future version.
+
+### Removed
+- Secure mode configuration. HTTPS is used by default.

detectlanguage/__init__.py

@@ -5,5 +5,8 @@
 from .client import Client
 from .api import detect, detect_code, detect_batch, account_status, languages
 
+# deprecated functions
+from .api import simple_detect, user_status
+
 configuration = Configuration()
 client = Client(configuration)

detectlanguage/api.py

@@ -1,8 +1,10 @@
 import detectlanguage
+import warnings
 
 def detect(data):
 	if isinstance(data, list):
-		raise ValueError('use detect_batch instead for multiple texts')
+		_warn_deprecated('use detect_batch instead for multiple texts')
+		return detect_batch(data)
 
 	return detectlanguage.client.post('detect', { 'q': data })
 
@@ -18,3 +20,45 @@ def account_status():
 
 def languages():
 	return detectlanguage.client.get('languages')
+
+
+### DEPRECATED
+
+def simple_detect(data):
+    """
+    DEPRECATED: This function is deprecated and will be removed in a future version.
+    Use detect_code() instead.
+
+    Args:
+        data: Text to detect language for
+
+    Returns:
+        str: Language code of the detected language
+    """
+    _warn_deprecated(
+        "simple_detect() is deprecated and will be removed in a future version. "
+        "Use detect_code() instead."
+    )
+    return detect_code(data)
+
+def user_status():
+    """
+    DEPRECATED: This function is deprecated and will be removed in a future version.
+    Use account_status() instead.
+
+    Returns:
+        dict: Account status information
+    """
+    _warn_deprecated(
+        "user_status() is deprecated and will be removed in a future version. "
+        "Use account_status() instead."
+    )
+    return account_status()
+
+def _warn_deprecated(message):
+    """Internal utility function to emit deprecation warnings."""
+    warnings.warn(
+        message,
+        DeprecationWarning,
+        stacklevel=2
+    )

tests/test_api.py

@@ -7,7 +7,7 @@
 class TestApi:
 	def setup_method(self):
 		detectlanguage.configuration.api_key = os.environ['DETECTLANGUAGE_API_KEY']
-		
+
 	def test_detect_code(self):
 		result = detectlanguage.detect_code("Hello world")
 		assert result == 'en'
@@ -17,7 +17,7 @@ def test_detect(self):
 		assert result[0]['language'] == 'en'
 
 	def test_detect_with_array(self):
-		with pytest.raises(ValueError):
+		with pytest.warns(DeprecationWarning, match="use detect_batch"):
 			detectlanguage.detect(["Hello world", "Ėjo ežiukas"])
 
 	def test_detect_unicode(self):
@@ -37,9 +37,18 @@ def test_languages(self):
 		result = detectlanguage.languages()
 		assert { 'code': 'en', 'name': 'English' } in result
 
+	def test_simple_detect(self):
+		with pytest.warns(DeprecationWarning, match="simple_detect.*deprecated"):
+			result = detectlanguage.simple_detect("Hello world")
+			assert result == 'en'
+
+	def test_user_status(self):
+		with pytest.warns(DeprecationWarning, match="user_status.*deprecated"):
+			result = detectlanguage.user_status()
+			assert result['status'] == 'ACTIVE'
+
 class TestApiErrors:
 	def test_invalid_key(self):
 		detectlanguage.configuration.api_key = 'invalid'
 		with pytest.raises(detectlanguage.DetectLanguageError):
 			detectlanguage.detect("Hello world")
-