coretex.entities.sample.local_sample.LocalSample Class Reference

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

Public Member Functions
Path	path (self)
Path	zipPath (self)
None	download (self, bool decrypt=True, bool ignoreCache=False)
Public Member Functions inherited from coretex.entities.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()

None coretex.entities.sample.local_sample.LocalSample.download	(		self,
		bool	decrypt = True,
		bool	ignoreCache = False
	)

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

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

Definition at line 70 of file local_sample.py.

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

path()

Path coretex.entities.sample.local_sample.LocalSample.path

(

self

)

    Returns
    -------
    Path -> path for local sample

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

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

Definition at line 51 of file local_sample.py.

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

zipPath()

Path coretex.entities.sample.local_sample.LocalSample.zipPath

(

self

)

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

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

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

Definition at line 61 of file local_sample.py.

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

---

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

• coretex/entities/sample/local_sample.py