taipy.core.reason
package
# Package for managing reasons why some Taipy operations are not allowed.
Reasons for the Taipy actions why they can't be performed.
Because Taipy applications are natively multiuser, asynchronous, and dynamic,
some functions should not be invoked in some specific contexts. You can protect
such calls by calling other methods that return a ReasonCollection
. It acts
like a Boolean value: True if the operation can be performed and False otherwise. If
the action cannot be performed, the ReasonCollection
holds all the individual
reasons as a list of Reason
objects.
This package exposes the ReasonCollection
class and all
the reason implementations that can be used to explain why some Taipy operations
are not available or allowed.
Classes¶
DataNodeEditInProgress
: ADataNode
is being edited, which prevents specific actions from being performed.DataNodeIsNotWritten
: ADataNode
has never been written, which prevents specific actions from being performed.EntityDoesNotExist
: The entity id provided does not exist in the repository.EntityIsNotAScenario
: The entity is not a scenario, which prevents specific actions from being performed.EntityIsNotSubmittableEntity
: An entity is not a submittable entity, which prevents specific actions from being performed.InvalidUploadFile
: The uploaded file has invalid data, therefore is not a valid data file for the data node.JobIsNotFinished
: As the job is not finished yet, it prevents specific actions from being performed.NoFileToDownload
: There is no file to download, therefore the download action cannot be performed.NotAFile
: The data node path is not a file, therefore the download action cannot be performed.NotGlobalScope
: A data node config does not have a GLOBAL scope, which prevents specific actions from being performed.Reason
: A reason explains why a specific action cannot be performed.ReasonCollection
: Class used to store all the reasons to explain why some Taipy operations are not allowed.ScenarioDoesNotBelongToACycle
: The scenario does not belong to any cycle, which prevents specific actions from being performed.ScenarioIsThePrimaryScenario
: The scenario is the primary scenario of a cycle, which prevents specific actions from being performed.SubmissionIsNotFinished
: The submission is not finished yet.SubmissionStatusIsUndefined
: The submission status is undefined.UploadFileCanNotBeRead
: The uploaded file can not be read, therefore is not a valid data file for the data node.WrongConfigType
: A config id is not a valid expected config, which prevents specific actions from being performed.