Skip to content

Translate

Experimental module to automate translations.

Translator

Class Translator is used for translation of of strings based on the Google Translate API.

The class supports V2 and V3 translation APIs.

Source code in packages/pyxecm/src/pyxecm_customizer/translate.py 
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
class Translator:
    """Class Translator is used for translation of of strings based on the Google Translate API.

    The class supports V2 and V3 translation APIs.
    """

    logger: logging.Logger = default_logger

    _config = None
    _headers = None

    def __init__(
        self,
        api_key: str,
        project_key: str = "",
        domain: str = "",
        logger: logging.Logger = default_logger,
    ) -> None:
        """Initialize the Translate objects.

        Args:
            api_key (str):
                The Google Translate API key.
            project_key (str, optional):
                The Google project. Defaults to "".
            domain (str, optional):
                The domain. Defaults to "".
            logger (logging.Logger, optional):
                The logging object to log all messages. Defaults to default_logger.

        """

        if logger != default_logger:
            self.logger = logger.getChild("translator")
            for logfilter in logger.filters:
                self.logger.addFilter(logfilter)

        translate_config = {}

        translate_config["apiKey"] = api_key
        translate_config["translateUrlV2"] = "https://translation.googleapis.com/language/translate/v2"
        translate_config["translateUrlV3"] = "https://translation.googleapis.com/v3/projects/{}:translateText".format(
            project_key,
        )
        translate_config["project"] = project_key
        translate_config["parent"] = "projects/{}/locations/global".format(project_key)
        translate_config["model"] = f"nmt{':{}'.format(domain) if domain else ''}"

        self._headers = {
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json; charset=utf-8",
        }

        self._config = translate_config

    def config(self) -> dict:
        """Return the configuration parameters.

        Returns:
            dict:
                The onfiguration parameters.

        """

        return self._config

    def translate(self, source_language: str, target_language: str, text: str) -> str:
        """Translate a string from one language to another using the Google Translate V2 API.

        Args:
            source_language (str):
                The source language.
            target_language (str):
                The target language.
            text (str):
                The string to translate.

        Returns:
            str:
                The translated string.

        """

        params = {
            "key": self.config()["apiKey"],
            "q": text,
            "source": source_language,
            "target": target_language,
        }

        request_url = self.config()["translateUrlV2"]

        response = requests.post(
            url=request_url,
            params=params,
            timeout=REQUEST_TIMEOUT,
        )

        if response.status_code != 200:
            self.logger.error("Failed to translate text -> %s", response.content)
            return None

        translated_text = response.json()["data"]["translations"][0]["translatedText"]

        return translated_text

    # end method definition

    def translate_v3(self, source_language: str, target_language: str, text: str) -> str:
        """Translate a string from one language to another using the Google Translate V3 API.

        Args:
            source_language (str):
                The source language.
            target_language (str):
                The destination language.
            text (str):
                The string to translate.

        Returns:
            str:
                The translated string.

        """

        data = {
            "source_language_code": source_language,
            "target_language_code": target_language,
            "contents": [text],
        }

        request_header = self._headers
        request_url = self.config()["translateUrlV3"]

        try:
            response = requests.post(
                url=request_url,
                headers=request_header,
                json=data,
                timeout=REQUEST_TIMEOUT,
            )

            if response.status_code != 200:
                self.logger.error("Failed to translate text -> %s", response.content)
                return None

        except Exception as error:
            self.logger.error("Failed translation request; error -> %s", str(error))

        translated_text = response.json()["data"]["translations"][0]["translatedText"]

        return translated_text

__init__(api_key, project_key='', domain='', logger=default_logger)

Initialize the Translate objects.

Parameters:

Name Type Description Default
api_key str

The Google Translate API key.

 required
project_key str

The Google project. Defaults to "".

 ''
domain str

The domain. Defaults to "".

 ''
logger Logger

The logging object to log all messages. Defaults to default_logger.

 default_logger
Source code in packages/pyxecm/src/pyxecm_customizer/translate.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def __init__(
    self,
    api_key: str,
    project_key: str = "",
    domain: str = "",
    logger: logging.Logger = default_logger,
) -> None:
    """Initialize the Translate objects.

    Args:
        api_key (str):
            The Google Translate API key.
        project_key (str, optional):
            The Google project. Defaults to "".
        domain (str, optional):
            The domain. Defaults to "".
        logger (logging.Logger, optional):
            The logging object to log all messages. Defaults to default_logger.

    """

    if logger != default_logger:
        self.logger = logger.getChild("translator")
        for logfilter in logger.filters:
            self.logger.addFilter(logfilter)

    translate_config = {}

    translate_config["apiKey"] = api_key
    translate_config["translateUrlV2"] = "https://translation.googleapis.com/language/translate/v2"
    translate_config["translateUrlV3"] = "https://translation.googleapis.com/v3/projects/{}:translateText".format(
        project_key,
    )
    translate_config["project"] = project_key
    translate_config["parent"] = "projects/{}/locations/global".format(project_key)
    translate_config["model"] = f"nmt{':{}'.format(domain) if domain else ''}"

    self._headers = {
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json; charset=utf-8",
    }

    self._config = translate_config

config()

Return the configuration parameters.

Returns:

Name Type Description
dict dict

The onfiguration parameters.
Source code in packages/pyxecm/src/pyxecm_customizer/translate.py 
73
74
75
76
77
78
79
80
81
82
def config(self) -> dict:
    """Return the configuration parameters.

    Returns:
        dict:
            The onfiguration parameters.

    """

    return self._config

translate(source_language, target_language, text)

Translate a string from one language to another using the Google Translate V2 API.

Parameters:

Name Type Description Default
source_language str

The source language.

 required
target_language str

The target language.

 required
text str

The string to translate.

 required

Returns:

Name Type Description
str str

The translated string.
Source code in packages/pyxecm/src/pyxecm_customizer/translate.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def translate(self, source_language: str, target_language: str, text: str) -> str:
    """Translate a string from one language to another using the Google Translate V2 API.

    Args:
        source_language (str):
            The source language.
        target_language (str):
            The target language.
        text (str):
            The string to translate.

    Returns:
        str:
            The translated string.

    """

    params = {
        "key": self.config()["apiKey"],
        "q": text,
        "source": source_language,
        "target": target_language,
    }

    request_url = self.config()["translateUrlV2"]

    response = requests.post(
        url=request_url,
        params=params,
        timeout=REQUEST_TIMEOUT,
    )

    if response.status_code != 200:
        self.logger.error("Failed to translate text -> %s", response.content)
        return None

    translated_text = response.json()["data"]["translations"][0]["translatedText"]

    return translated_text

translate_v3(source_language, target_language, text)

Translate a string from one language to another using the Google Translate V3 API.

Parameters:

Name Type Description Default
source_language str

The source language.

 required
target_language str

The destination language.

 required
text str

The string to translate.

 required

Returns:

Name Type Description
str str

The translated string.
Source code in packages/pyxecm/src/pyxecm_customizer/translate.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def translate_v3(self, source_language: str, target_language: str, text: str) -> str:
    """Translate a string from one language to another using the Google Translate V3 API.

    Args:
        source_language (str):
            The source language.
        target_language (str):
            The destination language.
        text (str):
            The string to translate.

    Returns:
        str:
            The translated string.

    """

    data = {
        "source_language_code": source_language,
        "target_language_code": target_language,
        "contents": [text],
    }

    request_header = self._headers
    request_url = self.config()["translateUrlV3"]

    try:
        response = requests.post(
            url=request_url,
            headers=request_header,
            json=data,
            timeout=REQUEST_TIMEOUT,
        )

        if response.status_code != 200:
            self.logger.error("Failed to translate text -> %s", response.content)
            return None

    except Exception as error:
        self.logger.error("Failed translation request; error -> %s", str(error))

    translated_text = response.json()["data"]["translations"][0]["translatedText"]

    return translated_text