Skip to content

SG-35561 export csv python changes #386

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.

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions shotgun_api3/shotgun.py
Original file line number Diff line number Diff line change
Expand Up @@ -1900,6 +1900,24 @@ def work_schedule_update(

return self._call_rpc("work_schedule_update", params)

def export_page(self, page_id, format):
"""
Export the specified page to the given format.
This method allows you to export a page to a specific format such as CSV.
>>> sg.export_page(12345, "csv")
"ID,Name,Status\n1,Shot 001,ip\n2,Shot 002,rev\n"
:param str format: The format to export the page to. Supported formats are ``"csv"``
:param int page_id: The ID of the page to export.
:returns: string containing data of the given page.
:rtype: string
"""

params = dict(
format=format, page_id=page_id
)
Comment on lines +1915 to +1917
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to add some data validations before sending it to the server? i.e. expected format values or page_id type.

Copy link
Author

@kuldeepgudekar kuldeepgudekar May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @carlos-villavicencio-adsk for your comments. I have these validations in api_handler.rb in another pull request like validations for other functions.


return self._call_rpc("export_page", params)

def follow(self, user, entity):
"""
Add the entity to the user's followed entities.
Expand Down
29 changes: 29 additions & 0 deletions tests/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1994,6 +1994,35 @@ def test_include_archived_projects(self):
# unarchive project
self.sg.update("Project", self.project["id"], {"archived": False})

class TestExportPage(base.LiveTestBase):

def test_export_page_unavailable(self):
"""Test export_page raises when report does not exist."""
if not self.sg.server_caps.version or self.sg.server_caps.version < (5, 1, 22):
return

page_entity = self.sg.create("Page", {"entity_type": "Shot"})
with self.assertRaises(Exception) as cm:
self.sg.export_page(page_entity["id"],'csv')
self.assertIn(f"Report for Page id={page_entity['id']} does not exist", str(cm.exception))

def test_export_page_format_missing(self):
"""Test export_page raises for invalid format."""
if not self.sg.server_caps.version or self.sg.server_caps.version < (5, 1, 22):
return

with self.assertRaises(Exception) as cm:
self.sg.export_page(11, None)
self.assertIn("\'format\' missing", str(cm.exception))

def test_export_page_missing_page_id(self):
"""Test export_page raises for missing page id."""
if not self.sg.server_caps.version or self.sg.server_caps.version < (5, 1, 22):
return

with self.assertRaises(Exception) as cm:
self.sg.export_page(None, 'csv')
self.assertIn("\'page_id\' missing", str(cm.exception))

class TestFollow(base.LiveTestBase):

Expand Down
Loading