phenotypic.sdk_.validate_analysis_id#

phenotypic.sdk_.validate_analysis_id(analysis_id: str) str[source]#

Validate an analysis ID used as a deliverables artifact stem.

Parameters:

analysis_id (str) – Candidate stable analysis identity.

Returns:

The unchanged validated ID.

Raises:
  • TypeError – If analysis_id is not a string.

  • ValueError – If the ID is unsafe or collides with a canonical table.

Return type:

str