coretex.coretex.sample.network_sample.NetworkSample Class Reference

Inheritance diagram for coretex.coretex.sample.network_sample.NetworkSample:

Public Member Functions
str	path (self)
str	zipPath (self)
bool	download (self, bool ignoreCache=False)
Public Member Functions inherited from coretex.coretex.sample.sample.Sample
None	unzip (self, bool ignoreCache=False)
Path	joinPath (self, Union[Path, str] other)

Detailed Description

    Represents a base class for all Sample classes which are
    comunicating with Coretex.ai

Definition at line 35 of file network_sample.py.

Member Function Documentation

download()

bool coretex.coretex.sample.network_sample.NetworkSample.download	(		self,
		bool	ignoreCache = False
	)

    Downloads sample from Coretex.ai

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

Reimplemented from coretex.coretex.sample.sample.Sample.

Definition at line 120 of file network_sample.py.

    def download(self, ignoreCache: bool = False) -> bool:
        """
            Downloads sample from Coretex.ai
 
            Returns
            -------
            bool -> False if response is failed, True otherwise
        """
 
        if os.path.exists(self.zipPath) and not ignoreCache:
            return True
 
        response = networkManager.genericDownload(
            endpoint = f"{self.__class__._endpoint()}/export?id={self.id}",
            destination = self.zipPath
        )
 
        return not response.hasFailed()
 

path()

str coretex.coretex.sample.network_sample.NetworkSample.path

(

self

)

    Returns
    -------
    str -> path for network sample

Reimplemented from coretex.coretex.sample.sample.Sample.

Definition at line 46 of file network_sample.py.

    def path(self) -> str:
        """
            Returns
            -------
            str -> path for network sample
        """
 
        return os.path.join(FolderManager.instance().samplesFolder, str(self.id))
 

zipPath()

str coretex.coretex.sample.network_sample.NetworkSample.zipPath

(

self

)

    Returns
    -------
    str -> zip path for network sample

Reimplemented from coretex.coretex.sample.sample.Sample.

Definition at line 56 of file network_sample.py.

    def zipPath(self) -> str:
        """
            Returns
            -------
            str -> zip path for network sample
        """
 
        return f"{self.path}.zip"
 

---

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

• src/coretex/coretex/sample/network_sample.py