server-client-python icon indicating copy to clipboard operation
server-client-python copied to clipboard

Workbook Download no_extract No Longer Supported

Open dem-hashmakj opened this issue 11 months ago • 2 comments

Describe the bug The no_extract parameter is no longer supported in the newest versions (.33 and .34).

Versions Details of your environment, including:

  • Tableau Server version: Product Version: 2024.2.2 and API Version: 3.23
  • Python version: 3.12
  • TSC library version:
    • tableauserverclient-0.34
    • tableauserverclient-0.33

To Reproduce Pretty much run the workbook download with the no_extract flag. downloadedFile = server.workbooks.download(workbook_id, filepath=filepath, no_extract=True)

Results Raises an exception:

TypeError("Workbooks.download() got an unexpected keyword argument 'no_extract'")

Present in: https://github.com/tableau/server-client-python/blob/f42948a1bee9e7f122764ecc2c9cf1c9d6877ea1/tableauserverclient/server/endpoint/workbooks_endpoint.py

No longer present in: https://github.com/tableau/server-client-python/blob/6c4374b2061e2f9544920b53cc79d5cd04ae5780/tableauserverclient/server/endpoint/workbooks_endpoint.py

Docs do not mention the removal (nor the addition of include_extract). https://github.com/tableau/server-client-python/blob/gh-pages/docs/api-ref.md#workbooksdownload

dem-hashmakj avatar Dec 03 '24 18:12 dem-hashmakj

The no_extract argument had been deprecated for several years. Use include_extract instead. I will update the docs to reflect the change.

jorwoods avatar Dec 03 '24 18:12 jorwoods

Appreciate it. Was just reviewing the documentation, had been using the defaults (no optional params), and needed to test without a large extract and happened to find this.

dem-hashmakj avatar Dec 03 '24 18:12 dem-hashmakj