python-designateclient — Errors

Errors — python-designateclient — branch stable/2026.2

Branch stable/2026.2 @ 9231eef90192 — repository https://opendev.org/openstack/python-designateclient — analysed on 2026-11-01

A CLI has no HTTP errors of its own. A failure reaches the user as a line on stderr and an exit code. Behaviours marked [observed] come from _rewrite/defects-repro_stable-2026.2.json, whose scenarios run the real shell against a stub with answers chosen by the scenario. They show how the client reads such a response, not that a service sends it.

1. Exit codes

**No command class returns a value from take_action.** The 12 classes deriving from command.Command all return nothing, which was checked with ast on designateclient/v2/cli/, and those commands exit 0 in {} mode [observed]. The OSC defect "a Command returning a value becomes an exit code" does not exist here.

2. Exception classes

All are in designateclient/exceptions.py.

Translation

DesignateAdapter.request (designateclient/v2/client.py:57) forces raise_exc=False, then:

1. it parses the body as JSON; if that fails, the payload becomes {code, message: <body text>} (designateclient/v2/client.py:98), so an HTML page is shown as it is [observed: 503-html, 404-html];
2. it raises the class of the status with **payload (designateclient/v2/client.py:107).

Which text is shown (designateclient/exceptions.py:49), in order:

1. message;
2. else the message of each item of errors.errors, joined by . [observed: 400-validation gives bad ttl. bad email];
3. else type [observed: 400-type-only];
4. else the class name [observed: 404-other-shape gives NotFound].

Read in Designate, the fault body holds code, type, message or errors, and request_id (designate:designate/api/middleware.py:276). request_id is stored on the exception and not displayed.

3. Client-side errors

Bad option values are refused by argparse with exit 2. --ttl on zone list and recordset list is a plain string, not an integer (designateclient/v2/cli/zones.py:61, designateclient/v2/cli/recordsets.py:56).

4. Defects

Each one was reproduced on the stub or read in the code, as stated. Scenario names refer to _rewrite/defects-repro_stable-2026.2.json. None is caught by the unit tests. Whether a real Designate triggers the case is stated only where its code was read; it was never run.

Behaviours that are by design, though surprising: set commands with no option still send a request [observed: zone-set-nothing, recordset-set-nothing, quota-set-nothing]; zone create drops options that do not apply to the type (01 § 2).

5. Asynchronous errors

The client has none of its own, as it exits after the first answer. A zone or recordset that later goes to ERROR is only visible through status in zone show, zone list or recordset show. A failed import or export shows in the status and message of zone import show or zone export show. See 05 and reverse-spec-designate.

6. Timeouts and transport errors

• The plugin sets no timeout (designateclient/osc/plugin.py:39); only the session's applies, from --timeout (openstacksdk:openstack/config/loader.py:936, osc-lib:osc_lib/clientmanager.py:125) [inferred: not followed to the session]. Client(timeout=...) exists for the Python API (designateclient/v2/client.py:60), and designateclient/tests/v2/test_timeout.py:31 tests it.
• Connection failures are keystoneauth exceptions, not translated by the adapter: their text is shown with exit 1 [inferred, not reproduced].

7. Logs

The plugin logs at INFO only, with messages such as Zone %s was deleted, visible with -v (designateclient/v2/cli/zones.py:273). The warnings seen come from OSC, for a wrong API version, and from keystoneauth, for a failed discovery.

Source: reverse-spec-python-designateclient/02-errors_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.