aboutsummaryrefslogtreecommitdiff
path: root/ouroboros/__init__.py
blob: cbca95d5d69bc213e80c26530a8667b273be7368 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#
# SPDX-FileCopyrightText: 2016 - 2026 Dimitri Staessens
# SPDX-License-Identifier: LGPL-2.1-only
#

"""
Public Python API for Ouroboros.

The package surface re-exports the pure-Python helpers only: errors and
QoS. The rest of the API is imported from its submodule: flows from
:mod:`ouroboros.dev`, the event loop from :mod:`ouroboros.event`, the
control plane from :mod:`ouroboros.irm` (or :mod:`ouroboros.cli`).
"""

from __future__ import annotations

from importlib.metadata import PackageNotFoundError, version

from ouroboros.errors import (
    BindError,
    FlowAuthError,
    FlowCryptError,
    FlowDeallocWarning,
    FlowDownError,
    FlowError,
    FlowEventError,
    FlowPeerError,
    FlowPermissionError,
    FlowReplayError,
    InvalidNameError,
    IpcpBootstrapError,
    IpcpConnectError,
    IpcpCreateError,
    IpcpEnrollError,
    IpcpStateError,
    IpcpTypeError,
    IpcpdError,
    IrmError,
    IrmdError,
    NameExistsError,
    NameNotFoundError,
    OuroborosError,
)
from ouroboros.qos import (
    QOS_MSG,
    QOS_RAW,
    QOS_RAW_SAFE,
    QOS_RT,
    QOS_RT_SAFE,
    QOS_STREAM,
    QoSService,
    QoSSpec,
)

try:
    __version__ = version("PyOuroboros")
except PackageNotFoundError:
    __version__ = "0.0.0+unknown"

__all__ = [
    "__version__",
    # qos
    "QoSService", "QoSSpec",
    "QOS_MSG", "QOS_RAW", "QOS_RAW_SAFE",
    "QOS_RT", "QOS_RT_SAFE", "QOS_STREAM",
    # errors
    "OuroborosError",
    "IrmError", "IrmdError", "IpcpdError",
    "IpcpCreateError", "IpcpBootstrapError", "IpcpEnrollError",
    "IpcpConnectError", "IpcpTypeError", "IpcpStateError",
    "BindError",
    "NameNotFoundError", "NameExistsError", "InvalidNameError",
    "FlowError", "FlowDownError", "FlowPeerError",
    "FlowPermissionError", "FlowEventError",
    "FlowCryptError", "FlowAuthError", "FlowReplayError",
    "FlowDeallocWarning",
]