Skip to content

feat(api): Add Pre-Translate Accuracy Report #187

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

Merged
andrii-bodnar merged 2 commits into from
Jan 6, 2025
Merged

feat(api): Add Pre-Translate Accuracy Report #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62a8282
feat(api): Add Pre-Translate Efficiency Report
Martin005 Nov 29, 2024
061dd29
Rename report efficiency -> accuracy
Martin005 Jan 6, 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
1 change: 1 addition & 0 deletions crowdin_api/api_resources/reports/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ class ScopeType(Enum):


class ReportName(Enum):
PRE_TRANSLATE_ACCURACY = "pre-translate-accuracy"
COSTS_ESTIMATION = "costs-estimation"
TRANSLATION_COSTS = "translation-costs"
TOP_MEMBERS = "top-members"
Expand Down
70 changes: 70 additions & 0 deletions crowdin_api/api_resources/reports/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,76 @@ def generate_contribution_raw_data_report(
},
)

def generate_pre_translate_accuracy_general_report(
self,
projectId: Optional[int] = None,
unit: Optional[Unit] = None,
format: Optional[Format] = None,
postEditingCategories: Optional[Iterable[str]] = None,
languageId: Optional[str] = None,
dateFrom: Optional[datetime] = None,
dateTo: Optional[datetime] = None,
):
"""
Generate Report.

Link to documentation:
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise:
https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
"""

projectId = projectId or self.get_project_id()

return self.generate_report(
projectId=projectId,
request_data={
"name": "pre-translate-accuracy",
"schema": {
"unit": unit,
"format": format,
"postEditingCategories": postEditingCategories,
"languageId": languageId,
"dateFrom": dateFrom,
"dateTo": dateTo,
},
},
)

def generate_pre_translate_accuracy_by_task_report(
self,
projectId: Optional[int] = None,
unit: Optional[Unit] = None,
format: Optional[Format] = None,
postEditingCategories: Optional[Iterable[str]] = None,
taskId: Optional[int] = None,
):
"""
Generate Report.

Link to documentation:
https://developer.crowdin.com/api/v2/#operation/api.projects.reports.post

Link to documentation for enterprise:
https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.post
"""

projectId = projectId or self.get_project_id()

return self.generate_report(
projectId=projectId,
request_data={
"name": "pre-translate-accuracy",
"schema": {
"unit": unit,
"format": format,
"postEditingCategories": postEditingCategories,
"taskId": taskId,
},
},
)

def generate_costs_estimation_post_editing_general_report(
self,
base_rates: BaseRates,
Expand Down
116 changes: 116 additions & 0 deletions crowdin_api/api_resources/reports/tests/test_reports_resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,6 +633,122 @@ def test_generate_contribution_raw_data_report(
request_data={"name": "contribution-raw-data", "schema": schema},
)

@pytest.mark.parametrize(
"in_params, schema",
[
(
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": ["0-20", "20-50"],
"languageId": "uk",
"dateFrom": datetime(year=1988, month=1, day=4),
"dateTo": datetime(year=2015, month=10, day=13),
},
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": ["0-20", "20-50"],
"languageId": "uk",
"dateFrom": datetime(year=1988, month=1, day=4),
"dateTo": datetime(year=2015, month=10, day=13),
},
),
(
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"languageId": "uk",
"dateFrom": datetime(year=1988, month=1, day=4),
"dateTo": datetime(year=2015, month=10, day=13),
},
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": None,
"languageId": "uk",
"dateFrom": datetime(year=1988, month=1, day=4),
"dateTo": datetime(year=2015, month=10, day=13),
},
)
],
)
@mock.patch("crowdin_api.api_resources.reports.resource.ReportsResource.generate_report")
def test_generate_pre_translate_accuracy_general_report(
self, m_generate_report, in_params, schema, base_absolut_url
):
m_generate_report.return_value = "response"

resource = self.get_resource(base_absolut_url)
assert (
resource.generate_pre_translate_accuracy_general_report(
projectId=1,
**in_params
) == "response"
)
m_generate_report.assert_called_once_with(
projectId=1,
request_data={
"name": "pre-translate-accuracy",
"schema": schema
}
)

@pytest.mark.parametrize(
"in_params, schema",
[
(
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": ["0-20", "20-50"],
"taskId": 1
},
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": ["0-20", "20-50"],
"taskId": 1
}
),
(
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"taskId": 1
},
{
"unit": Unit.WORDS,
"format": Format.XLSX,
"postEditingCategories": None,
"taskId": 1
}
)
]
)
@mock.patch(
"crowdin_api.api_resources.reports.resource.ReportsResource.generate_report"
)
def test_generate_pre_translate_accuracy_by_task_report(
self, m_generate_report, in_params, schema, base_absolut_url
):
m_generate_report.return_value = "response"

resource = self.get_resource(base_absolut_url)
assert (
resource.generate_pre_translate_accuracy_by_task_report(
projectId=1,
**in_params
) == "response"
)
m_generate_report.assert_called_once_with(
projectId=1,
request_data={
"name": "pre-translate-accuracy",
"schema": schema
}
)

@pytest.mark.parametrize(
"in_params, schema",
[
Expand Down
Loading