Inheritance diagram for coretex.entities.task_run.artifact.Artifact:

Public Member Functions
Path	localFilePath (self)

bool	isDirectory (self)

bool	isFile (self)

bool	download (self)

List[Self]	fetchAll (cls, int taskRunId, Optional[str] path=None, bool recursive=False)

Public Member Functions inherited from coretex.codable.codable.Codable
Dict[str, Any]	encode (self)

None	onDecode (self)

Self	decode (cls, Dict[str, Any] encodedObject)

Detailed Description

    Artifact class represents a single result of a run\n
    Result can be file of any kind

    Properties
    ----------
    artifactType : ArtifactType
        type of Artifact
    remoteFilePath : str
        path of Artifact on Coretex
    size : Optional[int]
        size of Artifact in bytes (not required)
    mimeType : str
        mimeType of Artifact
    timestamp : int
        current timestamp
    taskRunId : int
        id of run

Definition at line 39 of file artifact.py.

Member Function Documentation

◆ download()

bool coretex.entities.task_run.artifact.Artifact.download ( self )

    Downloads Artifact from Coretex.ai

    Returns
    -------
    bool -> False if response has failed, True otherwise

Definition at line 145 of file artifact.py.

     def download(self) -> bool:
         """
             Downloads Artifact from Coretex.ai
  
             Returns
             -------
             bool -> False if response has failed, True otherwise
         """
  
         params = {
             "model_queue_id": self.taskRunId,
             "path": self.remoteFilePath
         }
  
         return not networkManager.download("artifact/download-file", str(self.localFilePath), params).hasFailed()
  

◆ fetchAll()

List[Self] coretex.entities.task_run.artifact.Artifact.fetchAll	(		cls,
		int	taskRunId,
		Optional[str]	path = `None`,
		bool	recursive = `False`
	)

    Fetch all Artifacts from Coretex.ai for the specified run

    Parameters
    ----------
    taskRunId : int
        id of run
    path : Optional[str]
        local path where u want to store fetched Artifacts
    recursive : bool
        True if you want list to be sorted recursively, False otherwise

Definition at line 162 of file artifact.py.

     def fetchAll(cls, taskRunId: int, path: Optional[str] = None, recursive: bool = False) -> List[Self]:
         """
             Fetch all Artifacts from Coretex.ai for the specified run
  
             Parameters
             ----------
             taskRunId : int
                 id of run
             path : Optional[str]
                 local path where u want to store fetched Artifacts
             recursive : bool
                 True if you want list to be sorted recursively, False otherwise
         """
  
         params: Dict[str, Any] = {
             "model_queue_id": taskRunId,
         }
  
         if path is not None:
             params["path"] = path
  
         response = networkManager.get("artifact/list-contents", params)
         if response.hasFailed():
             return []
  
         artifacts = [cls.decode(element) for element in response.getJson(list)]
  
         for artifact in artifacts:
             artifact.taskRunId = taskRunId
  
             if recursive and artifact.isDirectory:
                 artifacts.extend(
                     cls.fetchAll(taskRunId, artifact.remoteFilePath)
                 )
  
         return artifacts

◆ isDirectory()

bool coretex.entities.task_run.artifact.Artifact.isDirectory ( self )

    Returns
    -------
    bool -> True if Artifact type is directory

Definition at line 81 of file artifact.py.

     def isDirectory(self) -> bool:
         """
             Returns
             -------
             bool -> True if Artifact type is directory
         """
  
         return self.artifactType == ArtifactType.directory
  

◆ isFile()

bool coretex.entities.task_run.artifact.Artifact.isFile ( self )

    Returns
    -------
    bool -> True if Artifact type is file

Definition at line 91 of file artifact.py.

     def isFile(self) -> bool:
         """
             Returns
             -------
             bool -> True if Artifact type is file
         """
  
         return self.artifactType == ArtifactType.file
  

◆ localFilePath()

Path coretex.entities.task_run.artifact.Artifact.localFilePath ( self )

    Represents the local path of the Artifact

    Returns
    -------
    Path -> local path to Artifact

Definition at line 69 of file artifact.py.

     def localFilePath(self) -> Path:
         """
             Represents the local path of the Artifact
  
             Returns
             -------
             Path -> local path to Artifact
         """
  
         return folder_manager.getArtifactsFolder(self.taskRunId) / self.remoteFilePath
  

The documentation for this class was generated from the following file:

coretex/entities/task_run/artifact.py