`typeddfs.df_errors`

Exceptions used by typeddfs.

Module Contents

exception typeddfs.df_errors.ClashError(*args, keys: Optional[AbstractSet[str]] = None)

Duplicate columns or other keys were added.

keys: The clashing name(s)

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.DfTypeConstructionError

An inconsistency prevents creating the DataFrame type.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.FilenameSuffixError(*args, key: Optional[str] = None, filename: Optional[str] = None)

A filename extension was not recognized.

key: The unrecognized suffix

filename: The bad filename

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.FormatDiscouragedError(*args, key: Optional[str] = None)

A requested format is not recommended.

key: The problematic format name

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.FormatInsecureError(*args, key: Optional[str] = None)

A requested format is less secure than required or requested.

key: The problematic format name

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashAlgorithmMissingError(*args, key: Optional[str] = None)

The hash algorithm was not found in hashlib.

key: The missing hash algorithm

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashContradictsExistingError(*args, key: Optional[str] = None, original: Optional[str] = None, new: Optional[str] = None)

A hash for the filename already exists in the directory hash list, but they differ.

key: The filename (excluding parents)

original: Hex hash found listed for the file

new: Hex hash that was to be written

filename: The filename of the listed file

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashDidNotValidateError(*args, actual: Optional[str] = None, expected: Optional[str] = None)

The hashes did not validate (expected != actual).

actual: The actual hex-encoded hash

expected: The expected hex-encoded hash

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashEntryExistsError(*args, key: Optional[str] = None)

The file is already listed in the hash dir, and it cannot be overwritten.

key: The existing hash dir path

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashError

Something went wrong with hash file writing or reading.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashExistsError(*args, key: Optional[str] = None, original: Optional[str] = None, new: Optional[str] = None)

A hash for the filename already exists in the directory hash list.

key: The filename (excluding parents)

original: Hex hash found listed for the file

new: Hex hash that was to be written

filename: The filename of the listed file

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashFileExistsError(*args, key: Optional[str] = None)

The hash file already exists and cannot be overwritten.

key: The existing hash file path or filename

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashFileInvalidError(*args, key: Union[None, pathlib.PurePath, str] = None)

The hash file could not be parsed.

key: The path to the hash file

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashFileMissingError(*args, key: Optional[str] = None)

The hash file does not exist.

key: The path or filename of the file corresponding to the expected hash file(s)

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashFilenameMissingError(*args, key: Optional[str] = None)

The filename was not found listed in the hash file.

key: The filename

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashVerificationError

Something went wrong when validating a hash.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.HashWriteError

Something went wrong when writing a hash file.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.InvalidDfError

A general typing failure of typeddfs.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.LengthMismatchError(*args, key: Optional[str] = None, lengths: AbstractSet[int])

The lengths of at least two lists do not match.

key: The key used for lookup

lengths: The lengths

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.MissingColumnError(*args, key: Optional[str] = None)

A required column is missing.

key: The name of the missing column

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.MultipleHashFilenamesError(*args, key: Optional[str] = None)

There are multiple filenames listed in the hash file where only 1 was expected.

key: The filename with duplicate entries

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.NoValueError(*args, key: Optional[str] = None)

No value because the collection is empty.

key: The key used for lookup

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.NonStrColumnError

A column name is not a string.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.NotSingleColumnError

A DataFrame needs to contain exactly 1 column.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.PathNotRelativeError(*args, key: Optional[str] = None)

The filename is not relative to the hash dir.

key: The filename

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.RowColumnMismatchError(*args, rows: Optional[Sequence[str]] = None, columns: Optional[Sequence[str]] = None)

The row and column names differ.

rows: The row names, in order

columns: The column names, in order

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.UnexpectedColumnError(*args, key: Optional[str] = None)

An extra/unrecognized column is present.

key: The name of the unexpected column

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.UnexpectedIndexNameError(*args, key: Optional[str] = None)

An extra/unrecognized index level is present.

key: The name of the unexpected index level

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.UnsupportedOperationError

Something could not be performed, in general.

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.ValueNotUniqueError(*args, key: Optional[str] = None, values: Optional[AbstractSet[str]] = None)

There is more than 1 unique value.

key: The key used for lookup

values: The set of values

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.VerificationFailedError(*args, key: Optional[str] = None)

A custom typing verification failed.

key: The key name of the verification that failed

Initialize self. See help(type(self)) for accurate signature.

exception typeddfs.df_errors.WritePermissionsError(*args, key: Optional[str] = None)

Couldn’t write to a file.

Initialize self. See help(type(self)) for accurate signature.

typeddfs.df_errors

Module Contents

`typeddfs.df_errors`