coretex.coretex.sample.sample.Sample Class Reference

Inheritance diagram for coretex.coretex.sample.sample.Sample:

Public Member Functions
bool	download (self, bool ignoreCache=False)
None	unzip (self, bool ignoreCache=False)
Path	joinPath (self, Union[Path, str] other)

Detailed Description

    Represents the generic class Sample
    Includes methods that can be used by any instance of Sample
    and abstract methods that must be implemented by any subclass

Definition at line 30 of file sample.py.

Member Function Documentation

download()

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

    Downloads the Sample if it is an instance or a subclass of NetworkSample
    Ignored for instances and subclasses of LocalSample

    Returns
    -------
    bool -> True if Sample has been downloaded successfully,
    False if something went wrong, in LocalSample case True is always returned

Reimplemented in coretex.coretex.sample.network_sample.NetworkSample, and coretex.coretex.sample.local_sample.LocalSample.

Definition at line 51 of file sample.py.

    def download(self, ignoreCache: bool = False) -> bool:
        """
            Downloads the Sample if it is an instance or a subclass of NetworkSample
            Ignored for instances and subclasses of LocalSample
 
            Returns
            -------
            bool -> True if Sample has been downloaded successfully,
            False if something went wrong, in LocalSample case True is always returned
        """
        pass
 

joinPath()

Path coretex.coretex.sample.sample.Sample.joinPath	(		self,
		Union[Path, str]	other
	)

    Joins sample path and provided path

    Parameters
    ----------
    other : Union[Path, str]
path for join

    Returns
    -------
    Path -> path created from sample path and provided path

    Example
    -------
    >>> print(sampleObj.joinPath("dummy.zip"))
    Path("path/to/sample/dummy.zip")

Definition at line 100 of file sample.py.

    def joinPath(self, other: Union[Path, str]) -> Path:
        """
            Joins sample path and provided path
 
            Parameters
            ----------
            other : Union[Path, str]
                path for join
 
            Returns
            -------
            Path -> path created from sample path and provided path
 
            Example
            -------
            >>> print(sampleObj.joinPath("dummy.zip"))
            Path("path/to/sample/dummy.zip")
        """
 
        if isinstance(other, str):
            other = Path(other)
 
        return Path(self.path) / other

unzip()

None coretex.coretex.sample.sample.Sample.unzip	(		self,
		bool	ignoreCache = False
	)

    Unzip sample zip file

    Parameters
    ----------
    ignoreCache : bool
if set to false performs unzip action even if
sample is previously unzipped

Definition at line 70 of file sample.py.

    def unzip(self, ignoreCache: bool = False) -> None:
        """
            Unzip sample zip file
 
            Parameters
            ----------
            ignoreCache : bool
                if set to false performs unzip action even if
                sample is previously unzipped
        """
 
        if os.path.exists(self.path) and not ignoreCache:
            return
 
        try:
            self.__unzipSample()
        except BadZipFile:
            # Delete invalid zip file
            os.unlink(self.zipPath)
 
            # Re-download
            self.download()
 
            # Try to unzip - if it fails again it should crash
            self.__unzipSample()
 

---

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

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