Skip to content

unit

Unit Builder 🏗️

Builder for the uni section of a systemd service file.

UnitBuilder

Bases: _Builder

Builder for the unit section of a systemd service file.

Source code in systemd_py/builders/unit.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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class UnitBuilder(_Builder):
    """
    Builder for the `unit` section of a systemd service file.
    """

    __slots__ = (
        "_description",
        "_documentation",
        "_requires",
        "_wants",
        "_binds_to",
        "_before",
        "_after",
        "_conflicts",
        "_condition",
        "_assert_",
    )

    @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 [
            "_documentation", "_requires", "_wants", "_binds_to", "_before",
            "_after", "_conflicts", "_condition", "_assert_",
        ]

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._check()
        return Unit(
            description=self._description,
            documentation=self._documentation,
            requires=self._requires,
            wants=self._wants,
            binds_to=self._binds_to,
            before=self._before,
            after=self._after,
            conflicts=self._conflicts,
            condition=self._condition,
            assert_=self._assert_,
        )

    def __init__(self):
        self._description: str = ...
        self._documentation: Optional[str] = ...
        self._requires: Optional[List[str]] = ...
        self._wants: Optional[List[str]] = ...
        self._binds_to: Optional[List[str]] = ...
        self._before: Optional[List[str]] = ...
        self._after: Optional[List[str]] = ...
        self._conflicts: Optional[List[str]] = ...
        self._condition: Optional[str] = ...
        self._assert_: Optional[str] = ...

    def with_description(self, description: str) -> 'UnitBuilder':
        """
        Sets the `description` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit

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

        self._description = description
        return self

    def with_documentation(self, documentation: str) -> 'UnitBuilder':
        """
        Sets the `documentation` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._documentation = documentation
        return self

    def with_requires(self, requires: List[str]) -> 'UnitBuilder':
        """
        Sets the `requires` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._requires = requires
        return self

    def with_wants(self, wants: List[str]) -> 'UnitBuilder':
        """
        Sets the `wants` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._wants = wants
        return self

    def with_binds_to(self, binds_to: List[str]) -> 'UnitBuilder':
        """
        Sets the `binds_to` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._binds_to = binds_to
        return self

    def with_before(self, before: List[str]) -> 'UnitBuilder':
        """
        Sets the `before` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._before = before
        return self

    def with_after(self, after: List[str]) -> 'UnitBuilder':
        """
        Sets the `after` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._after = after
        return self

    def with_conflicts(self, conflicts: List[str]) -> 'UnitBuilder':
        """
        Sets the `conflicts` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._conflicts = conflicts
        return self

    def with_condition(self, condition: str) -> 'UnitBuilder':
        """
        Sets the `condition` field of the `unit` section of a systemd service file.

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

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._condition = condition
        return self

    def with_assert(self, assert_: str) -> 'UnitBuilder':
        """
        Sets the `assert` field of the `unit` section of a systemd service file.

        :param assert_: The `assert` field of the `unit` section of a systemd service file
        :type assert_: str

        :return: The `unit` section of a systemd service file
        :rtype: Unit
        """

        self._assert_ = assert_
        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 unit section of a systemd service file.

Returns:

Type Description
Unit

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._check()
    return Unit(
        description=self._description,
        documentation=self._documentation,
        requires=self._requires,
        wants=self._wants,
        binds_to=self._binds_to,
        before=self._before,
        after=self._after,
        conflicts=self._conflicts,
        condition=self._condition,
        assert_=self._assert_,
    )

with_after(after)

Sets the after field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
after List[str]

The after field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
def with_after(self, after: List[str]) -> 'UnitBuilder':
    """
    Sets the `after` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._after = after
    return self

with_assert(assert_)

Sets the assert field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
assert_ str

The assert field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
def with_assert(self, assert_: str) -> 'UnitBuilder':
    """
    Sets the `assert` field of the `unit` section of a systemd service file.

    :param assert_: The `assert` field of the `unit` section of a systemd service file
    :type assert_: str

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._assert_ = assert_
    return self

with_before(before)

Sets the before field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
before List[str]

The before field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
def with_before(self, before: List[str]) -> 'UnitBuilder':
    """
    Sets the `before` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._before = before
    return self

with_binds_to(binds_to)

Sets the binds_to field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
binds_to List[str]

The binds_to field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
def with_binds_to(self, binds_to: List[str]) -> 'UnitBuilder':
    """
    Sets the `binds_to` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._binds_to = binds_to
    return self

with_condition(condition)

Sets the condition field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
condition str

The condition field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
def with_condition(self, condition: str) -> 'UnitBuilder':
    """
    Sets the `condition` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._condition = condition
    return self

with_conflicts(conflicts)

Sets the conflicts field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
conflicts List[str]

The conflicts field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
def with_conflicts(self, conflicts: List[str]) -> 'UnitBuilder':
    """
    Sets the `conflicts` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._conflicts = conflicts
    return self

with_description(description)

Sets the description field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
description str

The description field of the unit section of a systemd service file

 required

Returns:

Type Description
SocketBuilder

The SocketBuilder object
Source code in systemd_py/builders/unit.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def with_description(self, description: str) -> 'UnitBuilder':
    """
    Sets the `description` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit

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

    self._description = description
    return self

with_documentation(documentation)

Sets the documentation field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
documentation str

The documentation field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def with_documentation(self, documentation: str) -> 'UnitBuilder':
    """
    Sets the `documentation` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._documentation = documentation
    return self

with_requires(requires)

Sets the requires field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
requires List[str]

The requires field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
def with_requires(self, requires: List[str]) -> 'UnitBuilder':
    """
    Sets the `requires` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._requires = requires
    return self

with_wants(wants)

Sets the wants field of the unit section of a systemd service file.

Parameters:

Name Type Description Default
wants List[str]

The wants field of the unit section of a systemd service file

 required

Returns:

Type Description
Unit

The unit section of a systemd service file
Source code in systemd_py/builders/unit.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
def with_wants(self, wants: List[str]) -> 'UnitBuilder':
    """
    Sets the `wants` field of the `unit` section of a systemd service file.

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

    :return: The `unit` section of a systemd service file
    :rtype: Unit
    """

    self._wants = wants
    return self