Add function to retrieve supported glossary languages

Author: daniel-jones-dev

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
+* Add `Translator.get_glossary_languages()` to query language pairs supported for glossaries. 
 ### Changed
 ### Deprecated
 ### Removed

deepl/__main__.py

@@ -23,19 +23,26 @@ def action_usage(translator: deepl.Translator):
     print(usage_result)
 
 
-def action_languages(translator: deepl.Translator):
+def action_languages(translator: deepl.Translator, glossary: bool):
     """Action function for the languages command."""
-    source_languages = translator.get_source_languages()
-    target_languages = translator.get_target_languages()
-
-    print("Source languages available:")
-    for language in source_languages:
-        print(f"{language.code}: {language.name}")
-    print("Target languages available:")
-    for language in target_languages:
-        print(
-            f"{language.code}: {language.name}{' (supports formality)' if language.supports_formality else ''}"
-        )
+    if glossary:
+        glossary_languages = translator.get_glossary_languages()
+        print("Language pairs supported for glossaries: (source, target)")
+        for language_pair in glossary_languages:
+            print(f"{language_pair.source_lang}, {language_pair.target_lang}")
+    else:
+        source_languages = translator.get_source_languages()
+        target_languages = translator.get_target_languages()
+
+        print("Source languages available:")
+        for language in source_languages:
+            print(f"{language.code}: {language.name}")
+        print("Target languages available:")
+        for language in target_languages:
+            if language.supports_formality:
+                print(f"{language.code}: {language.name} (supports formality)")
+            else:
+                print(f"{language.code}: {language.name}")
 
 
 def action_document(
@@ -327,9 +334,14 @@ def add_common_arguments(subparser: argparse.ArgumentParser):
 
     # create the parser for the "languages" command
     languages_help_str = "print available languages"
-    subparsers.add_parser(
+    parser_languages = subparsers.add_parser(
         "languages", help=languages_help_str, description=languages_help_str
     )
+    parser_languages.add_argument(
+        "--glossary",
+        help="list language pairs supported for glossaries.",
+        action="store_true",
+    )
 
     # create the parser for the "glossary" command
     parser_glossary = subparsers.add_parser(

deepl/translator.py

@@ -318,6 +318,28 @@ def check_supported_glossary_languages(source_lang: str, target_lang: str):
             )
 
 
+class GlossaryLanguagePair:
+    """Information about a pair of languages supported for DeepL glossaries.
+
+    :param source_lang: The code of the source language.
+    :param target_lang: The code of the target language.
+    """
+
+    def __init__(self, source_lang: str, target_lang: str):
+        self._source_lang = source_lang
+        self._target_lang = target_lang
+
+    @property
+    def source_lang(self) -> str:
+        """Returns the code of the source language."""
+        return self._source_lang
+
+    @property
+    def target_lang(self) -> str:
+        """Returns the code of the target language."""
+        return self._target_lang
+
+
 class Formality(Enum):
     """Options for formality parameter."""
 
@@ -937,6 +959,21 @@ def get_target_languages(self, skip_cache=False) -> List[Language]:
             )
         return self._target_languages_cached
 
+    def get_glossary_languages(self) -> List[GlossaryLanguagePair]:
+        """Request the list of language pairs supported for glossaries."""
+        status, content, json = self._api_call(
+            "v2/glossary-language-pairs", method="GET"
+        )
+
+        self._raise_for_status(status, content, json)
+
+        return [
+            GlossaryLanguagePair(
+                language_pair["source_lang"], language_pair["target_lang"]
+            )
+            for language_pair in json["supported_languages"]
+        ]
+
     def get_usage(self) -> Usage:
         """Requests the current API usage."""
         status, content, json = self._api_call("v2/usage")
@@ -956,9 +993,10 @@ def create_glossary(
         languages, containing the entries in dictionary. The glossary may be
         used in the translate_text functions.
 
-        Only the following language pairs are supported: EN<->DE, EN<->FR, and
-        EN<->ES. A glossary with target language EN may be used to translate
-        texts into both EN-US and EN-GB.
+        Only certain language pairs are supported, currently the following:
+        EN<->DE, EN<->FR, and EN<->ES. The available language pairs can be
+        queried using get_glossary_languages(). A glossary with target language
+        EN may be used to translate texts into both EN-US and EN-GB.
 
         :param name: user-defined name to attach to glossary.
         :param source_lang: Language of source terms.

tests/test_cli.py

@@ -74,6 +74,11 @@ def test_languages(runner):
     assert "DE: German" in result.output
     assert "EN: English" in result.output
 
+    result = runner.invoke(deepl.__main__, "languages --glossary")
+    assert result.exit_code == 0, f"exit: {result.exit_code}\n {result.output}"
+    assert "supported for glossaries" in result.output
+    assert "de, en" in result.output
+
 
 def test_text(runner):
     result = runner.invoke(

tests/test_general.py

@@ -60,6 +60,14 @@ def test_language(translator):
         assert target_language.supports_formality is not None
 
 
+def test_glossary_languages(translator):
+    glossary_languages = translator.get_glossary_languages()
+    assert len(glossary_languages) > 0
+    for language_pair in glossary_languages:
+        assert len(language_pair.source_lang) > 0
+        assert len(language_pair.target_lang) > 0
+
+
 def test_server_url_selected_based_on_auth_key(server):
     translator_normal = deepl.Translator("ABCD")
     translator_free = deepl.Translator("ABCD:fx")