Custom Exceptions

The render_error() function can be used to render multi-line error messages with stem.util.term colours.

The darc project provides following custom exceptions:

• LinkNoReturn

• UnsupportedLink

• UnsupportedPlatform

• UnsupportedProxy

• WorkerBreak

Note

All exceptions are inherited from _BaseException.

The darc project provides following custom warnings:

• TorBootstrapFailed

• I2PBootstrapFailed

• ZeroNetBootstrapFailed

• FreenetBootstrapFailed

• APIRequestFailed

• SiteNotFoundWarning

• LockWarning

• TorRenewFailed

• RedisCommandFailed

• HookExecutionFailed

Note

All warnings are inherited from _BaseWarning.

exception darc.error.APIRequestFailed

Bases: darc.error._BaseWarning

API submit failed.

exception darc.error.DatabaseOperaionFailed

Bases: darc.error._BaseWarning

Database operation execution failed.

exception darc.error.FreenetBootstrapFailed

Bases: darc.error._BaseWarning

Freenet bootstrap process failed.

exception darc.error.HookExecutionFailed

Bases: darc.error._BaseWarning

Failed to execute hook function.

exception darc.error.I2PBootstrapFailed

Bases: darc.error._BaseWarning

I2P bootstrap process failed.

exception darc.error.LinkNoReturn(link=None, *, drop=True)

Bases: darc.error._BaseException

The link has no return value from the hooks.

Parameters

• link (darc.link.Link) – Original link object.

• drop (bool) –

Keyword Arguments

drop – If drops the link from task queues.

Return type

None

__init__(link=None, *, drop=True)

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

Parameters

drop (bool) –

Return type

None

exception darc.error.LockWarning

Bases: darc.error._BaseWarning

Failed to acquire Redis lock.

exception darc.error.RedisCommandFailed

Bases: darc.error._BaseWarning

Redis command execution failed.

exception darc.error.SiteNotFoundWarning

Bases: darc.error._BaseWarning, ImportWarning

Site customisation not found.

exception darc.error.TorBootstrapFailed

Bases: darc.error._BaseWarning

Tor bootstrap process failed.

exception darc.error.TorRenewFailed

Bases: darc.error._BaseWarning

Tor renew request failed.

exception darc.error.UnsupportedLink

Bases: darc.error._BaseException

The link is not supported.

exception darc.error.UnsupportedPlatform

Bases: darc.error._BaseException

The platform is not supported.

exception darc.error.UnsupportedProxy

Bases: darc.error._BaseException

The proxy is not supported.

exception darc.error.WorkerBreak

Bases: darc.error._BaseException

Break from the worker loop.

exception darc.error.ZeroNetBootstrapFailed

Bases: darc.error._BaseWarning

ZeroNet bootstrap process failed.

exception darc.error._BaseException

Bases: Exception

Base exception class for darc module.

exception darc.error._BaseWarning

Bases: Warning

Base warning for darc module.

darc.error.render_error(message, colour)

Render error message.

The function wraps the stem.util.term.format() function to provide multi-line formatting support.

Parameters

• message (AnyStr) – Multi-line message to be rendered with colour.

• colour (stem.util.term.Color) – Front colour of text, c.f. stem.util.term.Color.

Returns

The rendered error message.

Return type

str