zokyo.utils package

Submodules

• zokyo.utils.CustomExceptions module
• zokyo.utils.data_format_conversions module
• zokyo.utils.dataframes module
• zokyo.utils.logging module
• zokyo.utils.misc module
• zokyo.utils.s3 module
• zokyo.utils.semantic_seg module
• zokyo.utils.testing module

Module contents

exception zokyo.utils.CoefficientNotinRangeError(coefficient, coeff_type='Default', range_min=0, range_max=1)

Bases: Exception

Class to throw exception when a coefficient is not in the specified range

exception zokyo.utils.ConfigurationError(exception_string)

Bases: Exception

Class to throw exception when a configuration is not right

exception zokyo.utils.CrucialValueNotFoundError(operation, value_type='sample')

Bases: Exception

Class to throw exception when an expected value is not found

exception zokyo.utils.InvalidImageArrayError(image_type='PIL')

Bases: Exception

Class to throw exception when an image is not valid

exception zokyo.utils.OperationNotFoundOrImplemented(module, class_name)

Bases: Exception

Class to throw exception when an operation is not found

class zokyo.utils.Path(*args, **kwargs)

Bases: pathlib.PurePath

PurePath subclass that can make system calls.

Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.

absolute()

Return an absolute version of this path. This function works even if the path doesn’t point to anything.

No normalization is done, i.e. all ‘.’ and ‘..’ will be kept along. Use resolve() to get the canonical path to a file.

chmod(mode)

Change the permissions of the path, like os.chmod().

classmethod cwd()

Return a new path pointing to the current working directory (as returned by os.getcwd()).

exists()

Whether this path exists.

expanduser()

Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)

glob(pattern)

Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.

group()

Return the group name of the file gid.

classmethod home()

Return a new path pointing to the user’s home directory (as returned by os.path.expanduser(‘~’)).

is_block_device()

Whether this path is a block device.

is_char_device()

Whether this path is a character device.

is_dir()

Whether this path is a directory.

is_fifo()

Whether this path is a FIFO.

is_file()

Whether this path is a regular file (also True for symlinks pointing to regular files).

is_mount()

Check if this path is a POSIX mount point

is_socket()

Whether this path is a socket.

is_symlink()

Whether this path is a symbolic link.

iterdir()

Iterate over the files in this directory. Does not yield any result for the special paths ‘.’ and ‘..’.

lchmod(mode)

Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.

link_to(target)

Create a hard link pointing to a path named target.

lstat()

Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.

mkdir(mode=511, parents=False, exist_ok=False)

Create a new directory at this given path.

open(mode='r', buffering=- 1, encoding=None, errors=None, newline=None)

Open the file pointed by this path and return a file object, as the built-in open() function does.

owner()

Return the login name of the file owner.

read_bytes()

Open the file in bytes mode, read it, and close the file.

read_text(encoding=None, errors=None)

Open the file in text mode, read it, and close the file.

rename(target)

Rename this path to the given path, and return a new Path instance pointing to the given path.

replace(target)

Rename this path to the given path, clobbering the existing destination if it exists, and return a new Path instance pointing to the given path.

resolve(strict=False)

Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).

rglob(pattern)

Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.

rmdir()

Remove this directory. The directory must be empty.

samefile(other_path)

Return whether other_path is the same or not as this file (as returned by os.path.samefile()).

stat()

Return the result of the stat() system call on this path, like os.stat() does.

symlink_to(target, target_is_directory=False)

Make this path a symlink pointing to the given path. Note the order of arguments (self, target) is the reverse of os.symlink’s.

touch(mode=438, exist_ok=True)

Create this file with the given access mode, if it doesn’t exist.

unlink(missing_ok=False)

Remove this file or link. If the path is a directory, use rmdir() instead.

write_bytes(data)

Open the file in bytes mode, write to it, and close the file.

write_text(data, encoding=None, errors=None)

Open the file in text mode, write to it, and close the file.

zokyo.utils.download_s3_dir(s3_bucket, dir_path, strip_from_path=None)

Downloads a directory from s3

zokyo.utils.generate_semantic_map(img_path, ann_path, out_dir=None, opacity=0.4, gt=True, color_map=None, fill_poly=False, verbose=True)

Generate semantic segmentation map for the given image and its annotations and save it to given output directory if given. If gt is true then ground truth mask is also returned. If color map list is not given then Spectral color map from matplotlib is used. (Currently accepts coco toyo annotations)

zokyo.utils.json_field_parser(data)

Parses a string field to JSON when reading the CSV from disk

zokyo.utils.pytest_err_msg(err)

Get the error message from an exception that pytest catches

Compatibility function for newer versions of pytest, where str(err) no longer returns the expected __repr__ of an exception.