module documentation

Functionality to manage file system operations for scan directories.

Class ScanData Data about a scan to be saved to a JSON file in the directory.
Class ScanDirectory A class for handling interactions with scan directories.
Class ScanDirectoryManager A class for managing interactions with scan directories.
Class ScanInfo Summary information about a scan folder.
Exception NotEnoughFreeSpaceError An exception raised if there is not enough free space on disk to scan.
Function get_files_in_zip List the relative paths of all files and folders in the zip folder specified.
Constant IMAGE_REGEX Undocumented
Constant IMG_DIR_NAME Undocumented
Constant SCAN_DATA_FILENAME Undocumented
Constant SCAN_ZERO_PAD_DIGITS Undocumented
Constant STITCH_REGEX Undocumented
def get_files_in_zip(zip_path): (source)

List the relative paths of all files and folders in the zip folder specified.

IMAGE_REGEX = (source)

Undocumented

Value
re.compile(r'-?[0-9]+_-?[0-9]+\.jpe?g$')
IMG_DIR_NAME: str = (source)

Undocumented

Value
'images'
SCAN_DATA_FILENAME: str = (source)

Undocumented

Value
'scan_data.json'
SCAN_ZERO_PAD_DIGITS: int = (source)

Undocumented

Value
4
STITCH_REGEX = (source)

Undocumented

Value
re.compile(r'stitched\.jpe?g$')