Skip to content

Server

erpc.server

eRPC server, metrics, and CORS configuration dataclasses.

Maps the eRPC server configuration surface to Python dataclasses, matching the Go ServerConfig, MetricsConfig, and CORSConfig structs from erpc/common/config.go.

Examples:

>>> from erpc.server import ServerConfig, MetricsConfig, CORSConfig
>>> server = ServerConfig(http_host="0.0.0.0", http_port=8080)
>>> server.to_dict()
{'httpHostV4': '0.0.0.0', 'httpPort': 8080, 'maxTimeout': '60s'}

CORSConfig dataclass

Cross-Origin Resource Sharing configuration for the eRPC server.

When all fields are at their defaults (empty lists, False, 0), CORS is effectively disabled and to_dict() returns an empty dict so no cors key appears in the generated YAML.

Attributes:

Name Type Description
allowed_origins list[str]

Origins permitted to make cross-origin requests.
allowed_methods list[str]

HTTP methods allowed in cross-origin requests.
allowed_headers list[str]

HTTP headers allowed in cross-origin requests.
allow_credentials bool

Whether credentials (cookies, auth) are allowed.
max_age int

How long (seconds) browsers should cache preflight responses.

Examples:

>>> cors = CORSConfig(allowed_origins=["*"])
>>> cors.to_dict()
{'allowedOrigins': ['*']}
Source code in erpc/server.py 
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
78
79
@dataclass
class CORSConfig:
    """Cross-Origin Resource Sharing configuration for the eRPC server.

    When all fields are at their defaults (empty lists, ``False``, ``0``),
    CORS is effectively disabled and ``to_dict()`` returns an empty dict
    so no ``cors`` key appears in the generated YAML.

    Attributes:
        allowed_origins: Origins permitted to make cross-origin requests.
        allowed_methods: HTTP methods allowed in cross-origin requests.
        allowed_headers: HTTP headers allowed in cross-origin requests.
        allow_credentials: Whether credentials (cookies, auth) are allowed.
        max_age: How long (seconds) browsers should cache preflight responses.

    Examples:
        >>> cors = CORSConfig(allowed_origins=["*"])
        >>> cors.to_dict()
        {'allowedOrigins': ['*']}

    """

    allowed_origins: list[str] = field(default_factory=list)
    allowed_methods: list[str] = field(default_factory=list)
    allowed_headers: list[str] = field(default_factory=list)
    allow_credentials: bool = False
    max_age: int = 0

    def to_dict(self) -> dict[str, Any]:
        """Serialize to an eRPC-compatible dictionary.

        Returns:
            Dictionary with camelCase keys. Returns empty dict when all
            values are at their defaults (CORS disabled).

        """
        if not any(
            [
                self.allowed_origins,
                self.allowed_methods,
                self.allowed_headers,
                self.allow_credentials,
                self.max_age,
            ]
        ):
            return {}

        d: dict[str, Any] = {}
        if self.allowed_origins:
            d["allowedOrigins"] = self.allowed_origins
        if self.allowed_methods:
            d["allowedMethods"] = self.allowed_methods
        if self.allowed_headers:
            d["allowedHeaders"] = self.allowed_headers
        if self.allow_credentials:
            d["allowCredentials"] = self.allow_credentials
        if self.max_age:
            d["maxAge"] = self.max_age
        return d

to_dict 

to_dict() -> dict[str, Any]

Serialize to an eRPC-compatible dictionary.

Returns:

Type Description
dict[str, Any]

Dictionary with camelCase keys. Returns empty dict when all
dict[str, Any]

values are at their defaults (CORS disabled).
Source code in erpc/server.py 
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
78
79
def to_dict(self) -> dict[str, Any]:
    """Serialize to an eRPC-compatible dictionary.

    Returns:
        Dictionary with camelCase keys. Returns empty dict when all
        values are at their defaults (CORS disabled).

    """
    if not any(
        [
            self.allowed_origins,
            self.allowed_methods,
            self.allowed_headers,
            self.allow_credentials,
            self.max_age,
        ]
    ):
        return {}

    d: dict[str, Any] = {}
    if self.allowed_origins:
        d["allowedOrigins"] = self.allowed_origins
    if self.allowed_methods:
        d["allowedMethods"] = self.allowed_methods
    if self.allowed_headers:
        d["allowedHeaders"] = self.allowed_headers
    if self.allow_credentials:
        d["allowCredentials"] = self.allow_credentials
    if self.max_age:
        d["maxAge"] = self.max_age
    return d

ServerConfig dataclass

eRPC HTTP server configuration.

Maps to the server section of the eRPC YAML config.

Attributes:

Name Type Description
http_host str

Bind address for the HTTP server.
http_port int

Listen port for the HTTP server.
max_timeout str

Maximum request timeout (e.g. "60s").
enable_gzip bool

Enable gzip compression for responses.
listen_v6 bool

Enable IPv6 listening.
cors CORSConfig

Cross-origin resource sharing configuration.

Examples:

>>> server = ServerConfig(http_host="0.0.0.0", http_port=8080)
>>> server.to_dict()["httpHostV4"]
'0.0.0.0'
Source code in erpc/server.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@dataclass
class ServerConfig:
    """eRPC HTTP server configuration.

    Maps to the ``server`` section of the eRPC YAML config.

    Attributes:
        http_host: Bind address for the HTTP server.
        http_port: Listen port for the HTTP server.
        max_timeout: Maximum request timeout (e.g. ``"60s"``).
        enable_gzip: Enable gzip compression for responses.
        listen_v6: Enable IPv6 listening.
        cors: Cross-origin resource sharing configuration.

    Examples:
        >>> server = ServerConfig(http_host="0.0.0.0", http_port=8080)
        >>> server.to_dict()["httpHostV4"]
        '0.0.0.0'

    """

    http_host: str = "127.0.0.1"
    http_port: int = 4000
    max_timeout: str = "60s"
    enable_gzip: bool = False
    listen_v6: bool = False
    cors: CORSConfig = field(default_factory=CORSConfig)

    def to_dict(self) -> dict[str, Any]:
        """Serialize to an eRPC-compatible dictionary.

        Returns:
            Dictionary with camelCase keys. Boolean fields that are
            ``False`` by default are omitted to keep the config minimal.

        """
        d: dict[str, Any] = {
            "httpHostV4": self.http_host,
            "httpPort": self.http_port,
            "maxTimeout": self.max_timeout,
        }
        if self.enable_gzip:
            d["enableGzip"] = self.enable_gzip
        if self.listen_v6:
            d["listenV6"] = self.listen_v6
        cors_dict = self.cors.to_dict()
        if cors_dict:
            d["cors"] = cors_dict
        return d

to_dict 

to_dict() -> dict[str, Any]

Serialize to an eRPC-compatible dictionary.

Returns:

Type Description
dict[str, Any]

Dictionary with camelCase keys. Boolean fields that are
dict[str, Any]

False by default are omitted to keep the config minimal.
Source code in erpc/server.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def to_dict(self) -> dict[str, Any]:
    """Serialize to an eRPC-compatible dictionary.

    Returns:
        Dictionary with camelCase keys. Boolean fields that are
        ``False`` by default are omitted to keep the config minimal.

    """
    d: dict[str, Any] = {
        "httpHostV4": self.http_host,
        "httpPort": self.http_port,
        "maxTimeout": self.max_timeout,
    }
    if self.enable_gzip:
        d["enableGzip"] = self.enable_gzip
    if self.listen_v6:
        d["listenV6"] = self.listen_v6
    cors_dict = self.cors.to_dict()
    if cors_dict:
        d["cors"] = cors_dict
    return d

MetricsConfig dataclass

eRPC metrics / Prometheus endpoint configuration.

Maps to the metrics section of the eRPC YAML config.

Attributes:

Name Type Description
enabled bool

Whether the metrics endpoint is active.
host str

Bind address for the metrics HTTP server.
port int

Listen port for the metrics HTTP server.

Examples:

>>> metrics = MetricsConfig(enabled=True, host="0.0.0.0", port=9090)
>>> metrics.to_dict()
{'enabled': True, 'host': '0.0.0.0', 'port': 9090}
Source code in erpc/server.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
@dataclass
class MetricsConfig:
    """eRPC metrics / Prometheus endpoint configuration.

    Maps to the ``metrics`` section of the eRPC YAML config.

    Attributes:
        enabled: Whether the metrics endpoint is active.
        host: Bind address for the metrics HTTP server.
        port: Listen port for the metrics HTTP server.

    Examples:
        >>> metrics = MetricsConfig(enabled=True, host="0.0.0.0", port=9090)
        >>> metrics.to_dict()
        {'enabled': True, 'host': '0.0.0.0', 'port': 9090}

    """

    enabled: bool = True
    host: str = "127.0.0.1"
    port: int = 4001

    def to_dict(self) -> dict[str, Any]:
        """Serialize to an eRPC-compatible dictionary.

        Returns:
            Dictionary with metrics configuration. When disabled, only
            ``{"enabled": False}`` is returned.

        """
        if not self.enabled:
            return {"enabled": False}
        return {
            "enabled": self.enabled,
            "host": self.host,
            "port": self.port,
        }

to_dict 

to_dict() -> dict[str, Any]

Serialize to an eRPC-compatible dictionary.

Returns:

Type Description
dict[str, Any]

Dictionary with metrics configuration. When disabled, only
dict[str, Any]

{"enabled": False} is returned.
Source code in erpc/server.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def to_dict(self) -> dict[str, Any]:
    """Serialize to an eRPC-compatible dictionary.

    Returns:
        Dictionary with metrics configuration. When disabled, only
        ``{"enabled": False}`` is returned.

    """
    if not self.enabled:
        return {"enabled": False}
    return {
        "enabled": self.enabled,
        "host": self.host,
        "port": self.port,
    }