Skip to content

feat(translations): add scope and re-translation options to Apply Pre-Translation #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
innomaxx wants to merge 1 commit into
base: main
Choose a base branch
from
+96 −0
Open

feat(translations): add scope and re-translation options to Apply Pre-Translation #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions crowdin_api/api_resources/translations/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ class PreTranslationAutoApproveOption(Enum):
NONE = "none"


class PreTranslationScope(Enum):
UNTRANSLATED = "untranslated"
TRANSLATED = "translated"
ALL = "all"


class PreTranslationReplaceTranslationsOption(Enum):
NONE = "none"
AUTO_TRANSLATED = "autoTranslated"
ALL = "all"


class CharTransformation(Enum):
ASIAN = "asian"
EUROPEAN = "european"
Expand Down
13 changes: 13 additions & 0 deletions crowdin_api/api_resources/translations/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
CharTransformation,
PreTranslationApplyMethod,
PreTranslationAutoApproveOption,
PreTranslationReplaceTranslationsOption,
PreTranslationScope,
)


Expand Down Expand Up @@ -87,6 +89,10 @@ def apply_pre_translation(
duplicateTranslations: Optional[bool] = None,
skipApprovedTranslations: Optional[bool] = None,
translateUntranslatedOnly: Optional[bool] = None,
scope: Optional[PreTranslationScope] = None,
translationModifiedBefore: Optional[str] = None,
replaceTranslationsOption: Optional[PreTranslationReplaceTranslationsOption] = None,
resetApprovalStatus: Optional[bool] = None,
translateWithPerfectMatchOnly: Optional[bool] = None,
fallbackLanguages: Optional[Iterable[FallbackLanguages]] = None,
labelIds: Optional[Iterable[int]] = None,
Expand All @@ -96,6 +102,9 @@ def apply_pre_translation(
"""
Apply Pre-Translation.

`translateUntranslatedOnly` is deprecated in favor of `scope` and cannot be
combined with it in the same request.

Comment on lines +105 to +107
Link to documentation:
https://developer.crowdin.com/api/v2/#operation/api.projects.pre-translations.post
"""
Expand Down Expand Up @@ -126,6 +135,10 @@ def apply_pre_translation(
"duplicateTranslations": duplicateTranslations,
"skipApprovedTranslations": skipApprovedTranslations,
"translateUntranslatedOnly": translateUntranslatedOnly,
"scope": scope,
"translationModifiedBefore": translationModifiedBefore,
"replaceTranslationsOption": replaceTranslationsOption,
"resetApprovalStatus": resetApprovalStatus,
"translateWithPerfectMatchOnly": translateWithPerfectMatchOnly,
"fallbackLanguages": fallbackLanguages,
"labelIds": labelIds,
Expand Down
71 changes: 71 additions & 0 deletions crowdin_api/api_resources/translations/tests/test_translations_resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
PreTranslationApplyMethod,
PreTranslationAutoApproveOption,
PreTranslationEditOperation,
PreTranslationReplaceTranslationsOption,
PreTranslationScope,
)
from crowdin_api.api_resources.translations.resource import TranslationsResource
from crowdin_api.requester import APIRequester
Expand Down Expand Up @@ -67,6 +69,10 @@ def test_list_pre_translations(self, m_request, base_absolut_url):
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"scope": None,
"translationModifiedBefore": None,
"replaceTranslationsOption": None,
"resetApprovalStatus": None,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
Expand All @@ -85,6 +91,10 @@ def test_list_pre_translations(self, m_request, base_absolut_url):
"duplicateTranslations": False,
"skipApprovedTranslations": False,
"translateUntranslatedOnly": False,
"scope": PreTranslationScope.TRANSLATED,
"translationModifiedBefore": "2026-01-01T00:00:00+00:00",
"replaceTranslationsOption": PreTranslationReplaceTranslationsOption.AUTO_TRANSLATED,
"resetApprovalStatus": True,
"translateWithPerfectMatchOnly": False,
"fallbackLanguages": ["lang"],
"labelIds": [1],
Expand All @@ -100,6 +110,10 @@ def test_list_pre_translations(self, m_request, base_absolut_url):
"duplicateTranslations": False,
"skipApprovedTranslations": False,
"translateUntranslatedOnly": False,
"scope": PreTranslationScope.TRANSLATED,
"translationModifiedBefore": "2026-01-01T00:00:00+00:00",
"replaceTranslationsOption": PreTranslationReplaceTranslationsOption.AUTO_TRANSLATED,
"resetApprovalStatus": True,
"translateWithPerfectMatchOnly": False,
"fallbackLanguages": ["lang"],
"labelIds": [1],
Expand Down Expand Up @@ -147,6 +161,10 @@ def test_apply_pre_translation_with_branchids(self, m_request, base_absolut_url)
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"scope": None,
"translationModifiedBefore": None,
"replaceTranslationsOption": None,
"resetApprovalStatus": None,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
Expand Down Expand Up @@ -186,6 +204,10 @@ def test_apply_pre_translation_edge_cases(self, m_request, base_absolut_url):
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"scope": None,
"translationModifiedBefore": None,
"replaceTranslationsOption": None,
"resetApprovalStatus": None,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
Expand Down Expand Up @@ -237,6 +259,10 @@ def test_apply_pre_translation_with_all_optional_params(self, m_request, base_ab
"duplicateTranslations": True,
"skipApprovedTranslations": False,
"translateUntranslatedOnly": True,
"scope": None,
"translationModifiedBefore": None,
"replaceTranslationsOption": None,
"resetApprovalStatus": None,
"translateWithPerfectMatchOnly": False,
"fallbackLanguages": [{"languageId": "fr", "userId": 789}],
"labelIds": [1, 2, 3],
Expand All @@ -246,6 +272,51 @@ def test_apply_pre_translation_with_all_optional_params(self, m_request, base_ab
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_apply_pre_translation_with_scope_and_retranslation_options(
self, m_request, base_absolut_url
):
"""Test that scope, translationModifiedBefore, replaceTranslationsOption
and resetApprovalStatus are properly handled."""
m_request.return_value = "response"

resource = self.get_resource(base_absolut_url)
response = resource.apply_pre_translation(
projectId=1,
languageIds=["en"],
fileIds=[1],
scope=PreTranslationScope.ALL,
translationModifiedBefore="2026-01-01T00:00:00+00:00",
replaceTranslationsOption=PreTranslationReplaceTranslationsOption.ALL,
resetApprovalStatus=True,
)

assert response == "response"
m_request.assert_called_once_with(
method="post",
request_data={
"languageIds": ["en"],
"fileIds": [1],
"method": None,
"engineId": None,
"aiPromptId": None,
"autoApproveOption": None,
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"scope": PreTranslationScope.ALL,
"translationModifiedBefore": "2026-01-01T00:00:00+00:00",
"replaceTranslationsOption": PreTranslationReplaceTranslationsOption.ALL,
"resetApprovalStatus": True,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
"excludeLabelIds": [],
"branchIds": [],
},
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
Comment on lines +319 to 320
def test_pre_translation_report(self, m_request, base_absolut_url):
m_request.return_value = "response"
Expand Down
Loading