Method load

dosma/cli.py:173–210

Command line interface loading scan data. ``self.scan_type`` must be set before calling this function. Args path (str): Path to pickle file or directory where data is stored. num_workers (int, optional): Number of workers to use to load data. Return

(self, path: str, num_workers: int = 0)

        return attr

    def load(self, path: str, num_workers: int = 0):
        """Command line interface loading scan data.

        ``self.scan_type`` must be set before calling this function.

        Args
            path (str): Path to pickle file or directory where data is stored.
            num_workers (int, optional): Number of workers to use to load data.

        Returns:
            ScanSequence: Scan of type ``self.scan_type``.

        Raises:
            ValueError: If path to load data from cannot be determined.

        Examples:
            >>> cli_scan.load("/path/to/pickle/file")  # load data from pickle file
            >>> cli_scan.load("/path/to/directory")  # load data from directory
        """
        scan_type = self.scan_type

        file_path = None
        if os.path.isfile(path):
            file_path = path
        elif os.path.isdir(path) and scan_type.NAME:
            fname = f"{scan_type.NAME}.data"
            _paths = (
                os.path.join(path, fname),
                os.path.join(self._save_dir(path, create_dir=False), fname),
            )
            for _path in _paths:
                if os.path.isfile(_path):
                    file_path = _path
                    break
        if file_path is None:
            raise ValueError(f"Cannot load {scan_type.__name__} data from path '{path}'")

        return scan_type.load(file_path, num_workers)

    def _save_dir(self, dir_path: str, create_dir: bool = True):
        """Returns directory path specific to this scan.