Deprecation of SPy functions prior to v194.0

Category	SPy
Update Type	Deprecation
Deprecation Date	18 Dec 2024

What

Several functions, properties, and parameters within the SPy library have been deprecated prior to version 194.0. See below for the detailed list and suggested replacements.

When

Deprecated between 08 Dec 2019 and 18 Dec 2024
Potential removal after 18 Dec 2025

Who is Affected

The following functions in SPy have been marked as deprecated.

CODE

spy.jobs.get_notebook_url
spy.utils.parse_str_time_to_ms
spy.utils.get_analysis_worksheet_from_url

Furthermore, the below properties have also been deprecated.

CODE

spy._login.client
spy.assets.Asset.asset_definition
spy.assets.Asset.parent_definition
spy.workbooks.Worksheet.document
spy.workbooks.Worksheet.scorecard_date_display
spy.workbooks.Worksheet.scorecard_date_format

And the below parameters have also been deprecated.

CODE

spy.docs.copy(advanced)
spy.pull(capsules_as)
spy.workbooks.jobs.push(scope_globals_to_workbook)
spy.workbooks.push(scope_globals_to_workbook)

How to Address

Expand the relevant section for the suggested replacement.

spy.jobs.get_notebook_url

Replace with spy.utils.get_notebook_url().

spy.utils.parse_str_time_to_ms

Replace with spy.utils.parse_str_time().

spy.utils.get_analysis_worksheet_from_url

Replace with spy.utils.pull_worksheet_via_url().

spy._login.client

Replace with spy.client.

spy.assets.Asset.asset_definition & parent_definition

Replace with self.definition and self.parent.definition respectively.

spy.workbooks.Worksheet.document

Replace with spy.utils.parse_str_time(str_time).

spy.workbooks.Worksheet.scorecard_date_display & scorecard_date_format

Replace with either AnalysisWorksheet.journal or TopicDocument.report.

spy.docs.copy(advanced)

The parameter no longer has any effect.

spy.pull(capsules_as)

Replace capsules_as='signal' with shape='samples'.
Replace capsules_as='capsules' with shape='capsules'.

spy.workbooks.push(scope_globals_to_workbook) & spy.workbooks.jobs.push(scope_globals_to_workbook)

Replace scope_globals_to_workbook=True with global_inventory='copy local'.
Replace scope_globals_to_workbook=False with global_inventory='copy global'.