SG-35561 export csv python changes #386

kuldeepgudekar · 2025-05-28T12:52:43Z

Includes change for the new API enpoint export_page and test case around it. The report download test case is unavailable due to the following reasons:

The Report entity is not public, meaning we do not have access to this entity via the Python API. It is merely a table for storing data.
Since we cannot access the Report entity, we are unable to create the report entry for the page being tested in the test case.
Additionally, mocking the remote call is not feasible because the export_page function internally checks if a report is available.

kuldeepgudekar · 2025-05-28T13:09:13Z

Test cases dependes on changes made in
https://git.autodesk.com/shotgun/shotgun/pull/17891

carlos-villavicencio-adsk

Let's add some documentation in the /docs directory. This will end up in the docs site.

shotgun_api3/shotgun.py

carlos-villavicencio-adsk · 2025-09-16T14:20:02Z

Hello @kuldeepgudekar , please merge the master branch into your PR. That's because we recently pushed some updates.

kuldeepgudekar · 2025-09-16T16:14:21Z

tests/test_api.py

+        self.assertIn("'page_id' missing", str(cm.exception))
+
+    @unittest.mock.patch("shotgun_api3.shotgun.Http.request")
+    def test_export_page_without_layout_name(self, mock_request):


We have not exposed the ExportPage entity so that we can't create it from self.sg, we can only query it. We can create it from FPTR ui calls.

carlos-villavicencio-adsk

LGTM.

Before moving forward, I have two requests:

Please add some documentation to the docs directory. This will be automatically be rendered at the help site here: https://developers.shotgridsoftware.com/python-api/
If you plan to release this ASAP, you can include some of the release pre-requisites like the ones on this PR. Otherwise, you can open a new PR, but please note that this should be done before releasing a new version.

kuldeepgudekar · 2025-09-17T09:41:20Z

LGTM.

Before moving forward, I have two requests:

Please add some documentation to the docs directory. This will be automatically be rendered at the help site here: https://developers.shotgridsoftware.com/python-api/

If you plan to release this ASAP, you can include some of the release pre-requisites like the ones on this PR. Otherwise, you can open a new PR, but please note that this should be done before releasing a new version.

Thanks @carlos-villavicencio-adsk , I have updated it with required changes.

carlos-villavicencio-adsk

LGTM. Let's wait more approvals from the team

# Conflicts: # HISTORY.rst # shotgun_api3/shotgun.py

carlos-villavicencio-adsk · 2025-11-28T23:47:02Z

HISTORY.rst

+- Add ``export_page`` method to Shotgun class.
+- Update in documentation.


Let's add a clearer and more customer-friendly message for the release notes, please.

mchesnay

Added a couple of comments for docstrings.

mchesnay · 2025-12-01T15:57:16Z

shotgun_api3/shotgun.py

+        """
+        Export the specified page to the given format.
+        This method allows you to export a page to CSV.
+        Respective layout or page should be marked as API Exportable in the Shotgun.


Suggested change

Respective layout or page should be marked as API Exportable in the Shotgun.

Respective layout or page should be marked as API Exportable in the Flow Production Tracking UI.

mchesnay · 2025-12-01T15:57:42Z

shotgun_api3/shotgun.py

+            "ID,Name,Status\\n1,Shot 001,ip\\n2,Shot 002,rev\\n"
+        :param int page_id: The ID of the page to export.
+        :param str format: The format to export the page to. Supported format is ``"csv"``.
+        :param str layout_name: optional layout name. This should be the name of the layout seen in the Shotgun UI.


Suggested change

:param str layout_name: optional layout name. This should be the name of the layout seen in the Shotgun UI.

:param str layout_name: Optional layout name. This should be the name of the layout seen in the Flow Production Tracking UI.

kuldeepgudekar added 2 commits May 28, 2025 17:48

changes to export page from the api

74d324e

uncommented other test cases

12eea4e

doc string added in export_page function

22ff349

kuldeepgudekar requested review from barbara-darkshot, carlos-villavicencio-adsk and julien-lang and removed request for barbara-darkshot and julien-lang May 28, 2025 15:30

carlos-villavicencio-adsk reviewed May 28, 2025

View reviewed changes

shotgun_api3/shotgun.py Outdated Show resolved Hide resolved

carlos-villavicencio-adsk changed the title ~~Ticket/sg 35561 export csv python changes~~ SG-35561 export csv python changes Jun 11, 2025

kuldeepgudekar added 7 commits June 23, 2025 13:32

args positioning changed

98d8496

updated according to new export page params

5495d17

update the doc string

c70e644

removed extra line added

571ca65

test cases updated

cbbce27

test case fixed

9ba11af

test case updated

4de063f

kuldeepgudekar added 4 commits September 16, 2025 20:07

update in test cases

91abac3

update for human_user authmode

11a6817

Merge branch 'master' into ticket/SG-35561_export_csv_python_api

a334228

update in mock test cases

c66c5f1

kuldeepgudekar requested a review from carlos-villavicencio-adsk September 16, 2025 16:11

kuldeepgudekar commented Sep 16, 2025

View reviewed changes

carlos-villavicencio-adsk reviewed Sep 16, 2025

View reviewed changes

update in docs, and version number updated

954b0de

carlos-villavicencio-adsk reviewed Sep 17, 2025

View reviewed changes

julien-lang previously approved these changes Sep 17, 2025

View reviewed changes

carlos-villavicencio-adsk previously approved these changes Sep 17, 2025

View reviewed changes

eduardoChaucaGallegos previously approved these changes Sep 18, 2025

View reviewed changes

update in doc string

dbccd47

kuldeepgudekar dismissed stale reviews from eduardoChaucaGallegos, carlos-villavicencio-adsk, and julien-lang via dbccd47 September 22, 2025 08:01

kuldeepgudekar added 3 commits November 28, 2025 20:43

update the documentation link

15b4373

Merge branch 'master' into ticket/SG-35561_export_csv_python_api

6baf23b

# Conflicts: # HISTORY.rst # shotgun_api3/shotgun.py

removing merge conflicts with update in documentation

629a063

kuldeepgudekar requested review from carlos-villavicencio-adsk and julien-lang November 28, 2025 15:29

update the test cases

8728dd3

carlos-villavicencio-adsk reviewed Nov 28, 2025

View reviewed changes

release notes updated

4be7df8

kuldeepgudekar requested a review from carlos-villavicencio-adsk November 29, 2025 15:10

mchesnay approved these changes Dec 1, 2025

View reviewed changes

small doc changes added

e85fcac

kuldeepgudekar requested a review from mchesnay December 1, 2025 16:25

mchesnay approved these changes Dec 1, 2025

View reviewed changes

carlos-villavicencio-adsk approved these changes Dec 1, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SG-35561 export csv python changes #386

SG-35561 export csv python changes #386

kuldeepgudekar commented May 28, 2025 •

edited

Loading

Uh oh!

kuldeepgudekar commented May 28, 2025

Uh oh!

carlos-villavicencio-adsk left a comment

Uh oh!

Uh oh!

carlos-villavicencio-adsk commented Sep 16, 2025

Uh oh!

kuldeepgudekar Sep 16, 2025 •

edited

Loading

Uh oh!

carlos-villavicencio-adsk left a comment

Uh oh!

kuldeepgudekar commented Sep 17, 2025

Uh oh!

carlos-villavicencio-adsk left a comment

Uh oh!

carlos-villavicencio-adsk Nov 28, 2025

Uh oh!

mchesnay left a comment

Uh oh!

mchesnay Dec 1, 2025

Uh oh!

mchesnay Dec 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		- Add ``export_page`` method to Shotgun class.
		- Update in documentation.

	Respective layout or page should be marked as API Exportable in the Shotgun.
	Respective layout or page should be marked as API Exportable in the Flow Production Tracking UI.

	:param str layout_name: optional layout name. This should be the name of the layout seen in the Shotgun UI.
	:param str layout_name: Optional layout name. This should be the name of the layout seen in the Flow Production Tracking UI.

SG-35561 export csv python changes #386

Are you sure you want to change the base?

SG-35561 export csv python changes #386

Conversation

kuldeepgudekar commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kuldeepgudekar commented May 28, 2025

Uh oh!

carlos-villavicencio-adsk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

carlos-villavicencio-adsk commented Sep 16, 2025

Uh oh!

kuldeepgudekar Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlos-villavicencio-adsk left a comment

Choose a reason for hiding this comment

Uh oh!

kuldeepgudekar commented Sep 17, 2025

Uh oh!

carlos-villavicencio-adsk left a comment

Choose a reason for hiding this comment

Uh oh!

carlos-villavicencio-adsk Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

mchesnay left a comment

Choose a reason for hiding this comment

Uh oh!

mchesnay Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

mchesnay Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kuldeepgudekar commented May 28, 2025 •

edited

Loading

kuldeepgudekar Sep 16, 2025 •

edited

Loading