Skip to content

fix: add branchIds parameter to apply_pre_translation #212

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

Closed
wants to merge 3 commits into from
Closed

fix: add branchIds parameter to apply_pre_translation #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f433b61
fix(translations): add missing branchIds parameter to apply_pre_trans…
FaizaJibril Aug 25, 2025
a0cc110
test(translations): add comprehensive tests for apply_pre_translation
FaizaJibril Aug 25, 2025
d85ab65
style: fix linting issues in test file
FaizaJibril Aug 26, 2025
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
5 changes: 5 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 @@ -91,6 +91,7 @@ def apply_pre_translation(
fallbackLanguages: Optional[Iterable[FallbackLanguages]] = None,
labelIds: Optional[Iterable[int]] = None,
excludeLabelIds: Optional[Iterable[int]] = None,
branchIds: Optional[Iterable[int]] = None,
):
"""
Apply Pre-Translation.
Expand All @@ -107,6 +108,9 @@ def apply_pre_translation(
if excludeLabelIds is None:
excludeLabelIds = []

if branchIds is None:
branchIds = []

projectId = projectId or self.get_project_id()

return self.requester.request(
Expand All @@ -126,6 +130,7 @@ def apply_pre_translation(
"fallbackLanguages": fallbackLanguages,
"labelIds": labelIds,
"excludeLabelIds": excludeLabelIds,
"branchIds": branchIds,
},
)

Expand Down
127 changes: 127 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 @@ -71,6 +71,7 @@ def test_list_pre_translations(self, m_request, base_absolut_url):
"fallbackLanguages": [],
"labelIds": [],
"excludeLabelIds": [],
"branchIds": [],
},
),
(
Expand Down Expand Up @@ -103,6 +104,7 @@ def test_list_pre_translations(self, m_request, base_absolut_url):
"fallbackLanguages": ["lang"],
"labelIds": [1],
"excludeLabelIds": [1],
"branchIds": [],
},
),
),
Expand All @@ -119,6 +121,131 @@ def test_apply_pre_translation(self, m_request, in_params, request_data, base_ab
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_apply_pre_translation_with_branchids(self, m_request, base_absolut_url):
"""Test that branchIds parameter is properly handled."""
m_request.return_value = "response"

resource = self.get_resource(base_absolut_url)
response = resource.apply_pre_translation(
projectId=1,
languageIds=["en", "es"],
fileIds=[1, 2],
branchIds=[10, 20, 30]
)

assert response == "response"
m_request.assert_called_once_with(
method="post",
request_data={
"languageIds": ["en", "es"],
"fileIds": [1, 2],
"method": None,
"engineId": None,
"aiPromptId": None,
"autoApproveOption": None,
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
"excludeLabelIds": [],
"branchIds": [10, 20, 30],
},
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_apply_pre_translation_edge_cases(self, m_request, base_absolut_url):
"""Test edge cases and parameter handling."""
m_request.return_value = "response"

resource = self.get_resource(base_absolut_url)

# Test with empty lists
response = resource.apply_pre_translation(
projectId=1,
languageIds=[],
fileIds=[],
branchIds=[],
labelIds=[],
excludeLabelIds=[]
)

assert response == "response"
m_request.assert_called_once_with(
method="post",
request_data={
"languageIds": [],
"fileIds": [],
"method": None,
"engineId": None,
"aiPromptId": None,
"autoApproveOption": None,
"duplicateTranslations": None,
"skipApprovedTranslations": None,
"translateUntranslatedOnly": None,
"translateWithPerfectMatchOnly": None,
"fallbackLanguages": [],
"labelIds": [],
"excludeLabelIds": [],
"branchIds": [],
},
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_apply_pre_translation_with_all_optional_params(self, m_request, base_absolut_url):
"""Test with all optional parameters set."""
from crowdin_api.api_resources.translations.enums import (
PreTranslationApplyMethod,
PreTranslationAutoApproveOption,
)

m_request.return_value = "response"

resource = self.get_resource(base_absolut_url)
response = resource.apply_pre_translation(
projectId=1,
languageIds=["en"],
fileIds=[1],
method=PreTranslationApplyMethod.MT,
engineId=123,
aiPromptId=456,
autoApproveOption=PreTranslationAutoApproveOption.ALL,
duplicateTranslations=True,
skipApprovedTranslations=False,
translateUntranslatedOnly=True,
translateWithPerfectMatchOnly=False,
fallbackLanguages=[{"languageId": "fr", "userId": 789}],
labelIds=[1, 2, 3],
excludeLabelIds=[4, 5],
branchIds=[10, 20]
)

assert response == "response"
m_request.assert_called_once_with(
method="post",
request_data={
"languageIds": ["en"],
"fileIds": [1],
"method": PreTranslationApplyMethod.MT,
"engineId": 123,
"aiPromptId": 456,
"autoApproveOption": PreTranslationAutoApproveOption.ALL,
"duplicateTranslations": True,
"skipApprovedTranslations": False,
"translateUntranslatedOnly": True,
"translateWithPerfectMatchOnly": False,
"fallbackLanguages": [{"languageId": "fr", "userId": 789}],
"labelIds": [1, 2, 3],
"excludeLabelIds": [4, 5],
"branchIds": [10, 20],
},
path="projects/1/pre-translations",
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_pre_translation_report(self, m_request, base_absolut_url):
m_request.return_value = "response"
Expand Down