Skip to content

socket

Socket Builder 🏗️

Builder for the socket section of a systemd service file.

SocketBuilder

Bases: _Builder

Builder for the socket section of a systemd service file.

Source code in systemd_py/builders/socket.py 
 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
 78
 79
 80
 81
 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
131
132
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
class SocketBuilder(_Builder):
    """
    Builder for the `socket` section of a systemd service file.
    """

    __slots__ = (
        "_listen_stream",
        "_listen_datagram",
        "_listen_sequential_packet",
        "_listen_fifo",
        "_accept",
        "_socket_user",
        "_socket_group",
        "_socket_mode",
        "_service",
    )

    @property
    def allowed_none_fields(self) -> List[str]:
        """
        Returns a list of fields that are allowed to be None


        :return: List of fields that are allowed to be None
        :rtype: List[str]
        """

        return [
            "_listen_stream", "_listen_datagram", "_listen_sequential_packet",
            "_listen_fifo", "_accept", "_socket_user", "_socket_group",
            "_socket_mode", "_service",
        ]

    def build(self) -> Socket:
        """
        Builds the `socket` section of a systemd service file.

        :return: The `socket` section of a systemd service file
        :rtype: Socket
        """

        self._check()
        return Socket(
            listen_stream=self._listen_stream,
            listen_datagram=self._listen_datagram,
            listen_sequential_packet=self._listen_sequential_packet,
            listen_fifo=self._listen_fifo,
            accept=self._accept,
            socket_user=self._socket_user,
            socket_group=self._socket_group,
            socket_mode=self._socket_mode,
            service=self._service,
        )

    def __init__(self):
        self._listen_stream: Optional[List[str]] = None
        self._listen_datagram: Optional[List[str]] = None
        self._listen_sequential_packet: Optional[List[str]] = None
        self._listen_fifo: Optional[List[str]] = None
        self._accept: Optional[bool] = None
        self._socket_user: Optional[str] = None
        self._socket_group: Optional[str] = None
        self._socket_mode: Optional[str] = None
        self._service: Optional[str] = None

    def with_listen_stream(self, listen_stream: List[str]) -> 'SocketBuilder':
        """
        Sets the `listen_stream` field of the `socket` section of a systemd service file.

        :param listen_stream: The `listen_stream` field of the `socket` section of a systemd service file
        :type listen_stream: List[str]

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._listen_stream = listen_stream
        return self

    def with_listen_datagram(self, listen_datagram: List[str]) -> 'SocketBuilder':
        """
        Sets the `listen_datagram` field of the `socket` section of a systemd service file.

        :param listen_datagram: The `listen_datagram` field of the `socket` section of a systemd service file
        :type listen_datagram: List[str]

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._listen_datagram = listen_datagram
        return self

    def with_listen_sequential_packet(self, listen_sequential_packet: List[str]) -> 'SocketBuilder':
        """
        Sets the `listen_sequential_packet` field of the `socket` section of a systemd service file.

        :param listen_sequential_packet: The `listen_sequential_packet` field of the `socket` section of a systemd service file
        :type listen_sequential_packet: List[str]

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._listen_sequential_packet = listen_sequential_packet
        return self

    def with_listen_fifo(self, listen_fifo: List[str]) -> 'SocketBuilder':
        """
        Sets the `listen_fifo` field of the `socket` section of a systemd service file.

        :param listen_fifo: The `listen_fifo` field of the `socket` section of a systemd service file
        :type listen_fifo: List[str]

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._listen_fifo = listen_fifo
        return self

    def with_accept(self, accept: bool) -> 'SocketBuilder':
        """
        Sets the `accept` field of the `socket` section of a systemd service file.

        :param accept: The `accept` field of the `socket` section of a systemd service file
        :type accept: bool

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._accept = accept
        return self

    def with_socket_user(self, socket_user: str) -> 'SocketBuilder':
        """
        Sets the `socket_user` field of the `socket` section of a systemd service file.

        :param socket_user: The `socket_user` field of the `socket` section of a systemd service file
        :type socket_user: str

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._socket_user = socket_user
        return self

    def with_socket_group(self, socket_group: str) -> 'SocketBuilder':
        """
        Sets the `socket_group` field of the `socket` section of a systemd service file.

        :param socket_group: The `socket_group` field of the `socket` section of a systemd service file
        :type socket_group: str

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._socket_group = socket_group
        return self

    def with_socket_mode(self, socket_mode: str) -> 'SocketBuilder':
        """
        Sets the `socket_mode` field of the `socket` section of a systemd service file.

        :param socket_mode: The `socket_mode` field of the `socket` section of a systemd service file
        :type socket_mode: str

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._socket_mode = socket_mode
        return self

    def with_service(self, service: str) -> 'SocketBuilder':
        """
        Sets the `service` field of the `socket` section of a systemd service file.

        :param service: The `service` field of the `socket` section of a systemd service file
        :type service: str

        :return: The SocketBuilder object
        :rtype: SocketBuilder
        """

        self._service = service
        return self

allowed_none_fields: List[str] property

Returns a list of fields that are allowed to be None

Returns:

Type Description
List[str]

List of fields that are allowed to be None

build()

Builds the socket section of a systemd service file.

Returns:

Type Description
Socket

The socket section of a systemd service file
Source code in systemd_py/builders/socket.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def build(self) -> Socket:
    """
    Builds the `socket` section of a systemd service file.

    :return: The `socket` section of a systemd service file
    :rtype: Socket
    """

    self._check()
    return Socket(
        listen_stream=self._listen_stream,
        listen_datagram=self._listen_datagram,
        listen_sequential_packet=self._listen_sequential_packet,
        listen_fifo=self._listen_fifo,
        accept=self._accept,
        socket_user=self._socket_user,
        socket_group=self._socket_group,
        socket_mode=self._socket_mode,
        service=self._service,
    )

with_accept(accept)

Sets the accept field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
accept bool

The accept field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
def with_accept(self, accept: bool) -> 'SocketBuilder':
    """
    Sets the `accept` field of the `socket` section of a systemd service file.

    :param accept: The `accept` field of the `socket` section of a systemd service file
    :type accept: bool

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._accept = accept
    return self

with_listen_datagram(listen_datagram)

Sets the listen_datagram field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
listen_datagram List[str]

The listen_datagram field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def with_listen_datagram(self, listen_datagram: List[str]) -> 'SocketBuilder':
    """
    Sets the `listen_datagram` field of the `socket` section of a systemd service file.

    :param listen_datagram: The `listen_datagram` field of the `socket` section of a systemd service file
    :type listen_datagram: List[str]

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._listen_datagram = listen_datagram
    return self

with_listen_fifo(listen_fifo)

Sets the listen_fifo field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
listen_fifo List[str]

The listen_fifo field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
def with_listen_fifo(self, listen_fifo: List[str]) -> 'SocketBuilder':
    """
    Sets the `listen_fifo` field of the `socket` section of a systemd service file.

    :param listen_fifo: The `listen_fifo` field of the `socket` section of a systemd service file
    :type listen_fifo: List[str]

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._listen_fifo = listen_fifo
    return self

with_listen_sequential_packet(listen_sequential_packet)

Sets the listen_sequential_packet field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
listen_sequential_packet List[str]

The listen_sequential_packet field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
def with_listen_sequential_packet(self, listen_sequential_packet: List[str]) -> 'SocketBuilder':
    """
    Sets the `listen_sequential_packet` field of the `socket` section of a systemd service file.

    :param listen_sequential_packet: The `listen_sequential_packet` field of the `socket` section of a systemd service file
    :type listen_sequential_packet: List[str]

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._listen_sequential_packet = listen_sequential_packet
    return self

with_listen_stream(listen_stream)

Sets the listen_stream field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
listen_stream List[str]

The listen_stream field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
def with_listen_stream(self, listen_stream: List[str]) -> 'SocketBuilder':
    """
    Sets the `listen_stream` field of the `socket` section of a systemd service file.

    :param listen_stream: The `listen_stream` field of the `socket` section of a systemd service file
    :type listen_stream: List[str]

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._listen_stream = listen_stream
    return self

with_service(service)

Sets the service field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
service str

The service field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
def with_service(self, service: str) -> 'SocketBuilder':
    """
    Sets the `service` field of the `socket` section of a systemd service file.

    :param service: The `service` field of the `socket` section of a systemd service file
    :type service: str

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._service = service
    return self

with_socket_group(socket_group)

Sets the socket_group field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
socket_group str

The socket_group field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
def with_socket_group(self, socket_group: str) -> 'SocketBuilder':
    """
    Sets the `socket_group` field of the `socket` section of a systemd service file.

    :param socket_group: The `socket_group` field of the `socket` section of a systemd service file
    :type socket_group: str

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._socket_group = socket_group
    return self

with_socket_mode(socket_mode)

Sets the socket_mode field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
socket_mode str

The socket_mode field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
def with_socket_mode(self, socket_mode: str) -> 'SocketBuilder':
    """
    Sets the `socket_mode` field of the `socket` section of a systemd service file.

    :param socket_mode: The `socket_mode` field of the `socket` section of a systemd service file
    :type socket_mode: str

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._socket_mode = socket_mode
    return self

with_socket_user(socket_user)

Sets the socket_user field of the socket section of a systemd service file.

Parameters:

Name Type Description Default
socket_user str

The socket_user field of the socket section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/socket.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
def with_socket_user(self, socket_user: str) -> 'SocketBuilder':
    """
    Sets the `socket_user` field of the `socket` section of a systemd service file.

    :param socket_user: The `socket_user` field of the `socket` section of a systemd service file
    :type socket_user: str

    :return: The SocketBuilder object
    :rtype: SocketBuilder
    """

    self._socket_user = socket_user
    return self