coretex.coretex.sample.custom_sample.local_custom_sample.LocalCustomSample Class Reference

Inheritance diagram for coretex.coretex.sample.custom_sample.local_custom_sample.LocalCustomSample:

Public Member Functions
CustomSampleData	load (self)
Public Member Functions inherited from coretex.coretex.sample.local_sample.LocalSample
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 the local custom Sample class
    which is used for working with Other Task locally

Definition at line 24 of file local_custom_sample.py.

Member Function Documentation

load()

CustomSampleData coretex.coretex.sample.custom_sample.local_custom_sample.LocalCustomSample.load

(

self

)

    Returns
    -------
    CustomSampleData -> file and folder contents of the custom sample

Reimplemented from coretex.coretex.sample.local_sample.LocalSample.

Definition at line 31 of file local_custom_sample.py.

    def load(self) -> CustomSampleData:
        """
            Returns
            -------
            CustomSampleData -> file and folder contents of the custom sample
        """
        return CustomSampleData(Path(self.path))

---

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

• src/coretex/coretex/sample/custom_sample/local_custom_sample.py