coretex.coretex.sample.local_sample.LocalSample Class Reference

Inheritance diagram for coretex.coretex.sample.local_sample.LocalSample:

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 local sample object\n
    The purpose of this class is to provide a way to work with
    data samples that are stored locally

    Properties
    ----------
    name
        name of sample retrieved from path
    path : Path
        path to local sample

Definition at line 29 of file local_sample.py.

Member Function Documentation

download()

bool coretex.coretex.sample.local_sample.LocalSample.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 from coretex.coretex.sample.sample.Sample.

Definition at line 70 of file local_sample.py.

    def download(self, ignoreCache: bool = False) -> bool:
        logging.getLogger("coretexpylib").warning(">> [Coretex] Local sample cannot be downloaded")
        return True
 

path()

str coretex.coretex.sample.local_sample.LocalSample.path

(

self

)

    Returns
    -------
    str -> path for local sample

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

Reimplemented in coretex.coretex.sample.any_local_sample.AnyLocalSample.

Definition at line 51 of file local_sample.py.

    def path(self) -> str:
        """
            Returns
            -------
            str -> path for local sample
        """
 
        return str(self._path.parent / self._path.stem)
 

zipPath()

str coretex.coretex.sample.local_sample.LocalSample.zipPath

(

self

)

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

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

Reimplemented in coretex.coretex.sample.any_local_sample.AnyLocalSample.

Definition at line 61 of file local_sample.py.

    def zipPath(self) -> str:
        """
            Returns
            -------
            str -> zip path for local sample
        """
 
        return str(self._path)
 

---

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

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