almanac.errors

exception AlmanacError

Bases: Exception

Base exception type for almanac library errors.

exception ArgumentNameCollisionError(*names: str)

Bases: almanac.errors.argument_errors.BaseArgumentError

An exception type for when argument names would collide.

property names

A tuple of the argument names that spawned this error.

exception BaseArgumentError

Bases: almanac.errors.almanac_error.AlmanacError

The base exception type for invalid arguments.

exception InvalidArgumentNameError

Bases: almanac.errors.argument_errors.BaseArgumentError

An exception type for attempting to register invalid argument names.

exception MissingArgumentsError(*missing_args: str)

Bases: almanac.errors.argument_errors.BaseArgumentError

An exception type for missing arguments.

property missing_args

The arguments that were missing.

exception NoSuchArgumentError(*names: str)

Bases: almanac.errors.argument_errors.BaseArgumentError, almanac.errors.generic_errors.AlmanacKeyError

An exception type for resolutions of non-existent arguments.

property names

A tuple of the argument names that triggered this error.

exception TooManyPositionalArgumentsError(*values: Any)

Bases: almanac.errors.argument_errors.BaseArgumentError

An exception type for when too many positional arguments are specified.

property values

A tuple of the excess positional argument values.

exception UnknownArgumentBindingError(signature: inspect.Signature, pos_args: Iterable[Any], kw_args: Dict[str, Any])

Bases: almanac.errors.argument_errors.BaseArgumentError

An exception type for unknown issues in argument-binding.

property kw_args

The kw_args that could not be bound to the signature.

property pos_args

The pos_args that could not be bound to the signature.

property signature

The signature that could not be bound to.

exception BaseCommandError

Bases: almanac.errors.almanac_error.AlmanacError

The base exception type for command-related errors.

exception CommandNameCollisionError(*names: str)

Bases: almanac.errors.command_errors.BaseCommandError

An exception type for when command names would collide.

property names

A tuple of the command names that spawned this error.

exception CommandRegistrationError

Bases: almanac.errors.command_errors.BaseCommandError

An exception type for invalid command registration.

exception NoSuchCommandError(*names: str)

Bases: almanac.errors.command_errors.BaseCommandError, almanac.errors.configuration_errors.BaseConfigurationError, almanac.errors.generic_errors.AlmanacKeyError

An exception type for resolutions of non-existent commands.

property names

A tuple of the command names that spawned this error.

exception BaseConfigurationError

Bases: almanac.errors.almanac_error.AlmanacError

The base exception type for configuration errors.

exception ConflictingExceptionCallbacksError

Bases: almanac.errors.configuration_errors.BaseConfigurationError

Exception type for trying to implicitly overwrite an exception hook callback.

exception ConflictingPromoterTypesError

Bases: almanac.errors.configuration_errors.BaseConfigurationError

An exception type for attempting to map multiple promoters to one type.

exception InvalidCallbackTypeError

Bases: almanac.errors.configuration_errors.BaseConfigurationError

An error type for invalid callback types.

exception MissingRequiredParameterError

Bases: almanac.errors.configuration_errors.BaseConfigurationError

An exception type for missing configuration parameters.

exception AlmanacKeyError

Bases: almanac.errors.almanac_error.AlmanacError, KeyError

A subclass of KeyError that does not surround exception messages with quotes.

exception FrozenAccessError

Bases: almanac.errors.almanac_error.AlmanacError

An exception type for invalid accesses on frozen objects.

exception PositionalValueError(msg: str, error_pos: int)

Bases: ValueError, almanac.errors.almanac_error.AlmanacError

An exception that holds a specific, error-causing input position.

property error_pos

The zero-based index of an error-causing position.

exception BasePageError

Bases: almanac.errors.almanac_error.AlmanacError

Base error for all page-based errors.

exception BlockedPageOverwriteError(path: PagePathLike)

Bases: almanac.errors.page_errors.BasePageError

An exception type for attempted (but blocked) page entry overwrites.

property path

The path that generated this error.

exception NoSuchPageError(path: PagePathLike)

Bases: almanac.errors.page_errors.BasePageError, almanac.errors.generic_errors.AlmanacKeyError

An exception type for attempting to access a non-existent page.

property path

The path that generated this error.

exception OutOfBoundsPageError(path: PagePathLike)

Bases: almanac.errors.page_errors.BasePageError

An exception type for attempting to reference pages beyond the root directory.

property path

The path that generated this error.

exception PathSyntaxError(msg: str, error_pos: int)

Bases: almanac.errors.page_errors.BasePageError, almanac.errors.generic_errors.PositionalValueError

An exception type for path syntax errors.

exception BaseParseError

Bases: almanac.errors.almanac_error.AlmanacError

The base class exception type for parser-related errors.

exception PartialParseError(msg: str, remaining: str, partial_result: pyparsing.ParseResults, col: int)

Bases: almanac.errors.parsing_errors.BaseParseError, almanac.errors.generic_errors.PositionalValueError

An exception type for when command parsing partially fails.

exception TotalParseError

Bases: almanac.errors.parsing_errors.BaseParseError

Exception type for when command parsing totally fails.

exception NoActiveApplicationError

Bases: almanac.errors.almanac_error.AlmanacError

An exception type for when context methods are called without an active app.