Skip to content

feat: mark exportMode and fileIds as deprecated in add_distribution() #244

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
Mar 3, 2026
Merged

feat: mark exportMode and fileIds as deprecated in add_distribution() #244

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
b439ef6
Initial plan
Copilot Mar 3, 2026
d8f173d
feat: mark exportMode and fileIds params as deprecated in add_distrib…
Copilot Mar 3, 2026
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
15 changes: 14 additions & 1 deletion crowdin_api/api_resources/distributions/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import warnings
from typing import Iterable, Optional

from crowdin_api.api_resources.abstract.resources import BaseResource
Expand Down Expand Up @@ -46,7 +47,7 @@ def add_distribution(
projectId: Optional[int] = None,
fileIds: Optional[Iterable[int]] = None,
bundleIds: Optional[Iterable[int]] = None,
exportMode: Optional[ExportMode] = ExportMode.DEFAULT,
exportMode: Optional[ExportMode] = None,
):
"""
Add Distribution.
Expand All @@ -57,6 +58,18 @@ def add_distribution(

projectId = projectId or self.get_project_id()

if exportMode is not None:
warnings.warn(
"`exportMode` is deprecated, omit this parameter to use the API default behavior",
DeprecationWarning,
)

if fileIds is not None:
warnings.warn(
"`fileIds` is deprecated, use `bundleIds` instead",
DeprecationWarning,
)

return self.requester.request(
method="post",
path=self.get_distributions_path(projectId=projectId),
Expand Down
21 changes: 19 additions & 2 deletions crowdin_api/api_resources/distributions/tests/test_distributions_resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def test_list_distributions(self, m_request, base_absolut_url):
"name": "test",
"fileIds": [1, 2, 3],
"bundleIds": None,
"exportMode": ExportMode.DEFAULT
"exportMode": None
},
),
(
Expand All @@ -79,13 +79,30 @@ def test_list_distributions(self, m_request, base_absolut_url):
def test_add_distribution(self, m_request, incoming_data, request_data, base_absolut_url):
m_request.return_value = "response"
resource = self.get_resource(base_absolut_url)
assert resource.add_distribution(projectId=1, **incoming_data) == "response"
with pytest.warns(DeprecationWarning):
assert resource.add_distribution(projectId=1, **incoming_data) == "response"
m_request.assert_called_once_with(
method="post",
path=resource.get_distributions_path(projectId=1),
request_data=request_data,
)

@mock.patch("crowdin_api.requester.APIRequester.request")
def test_add_distribution_no_deprecated_params(self, m_request, base_absolut_url):
m_request.return_value = "response"
resource = self.get_resource(base_absolut_url)
assert resource.add_distribution(projectId=1, name="test", bundleIds=[1]) == "response"
m_request.assert_called_once_with(
method="post",
path=resource.get_distributions_path(projectId=1),
request_data={
"exportMode": None,
"name": "test",
"fileIds": None,
"bundleIds": [1],
},
)

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