Skip to content

install

Install Builder 🏗️

Builder for the install section of a systemd service file.

InstallBuilder

Bases: _Builder

Builder for the install section of a systemd service file.

Source code in systemd_py/builders/install.py 
 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
class InstallBuilder(_Builder):
    """
    Builder for the `install` section of a systemd service file.
    """

    __slots__ = (
        '_wanted_by',
        '_required_by',
        '_alias',
        '_also',
        '_default_instance',
    )

    @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 [
            '_wanted_by', '_required_by', '_alias', '_also', '_default_instance'
        ]

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

        :return: The `install` section of a systemd service file
        :rtype: Install
        """

        self._check()
        return Install(
            wanted_by=self._wanted_by,
            required_by=self._required_by,
            alias=self._alias,
            also=self._also,
            default_instance=self._default_instance
        )

    def __init__(self):
        self._wanted_by: Optional[List[str]] = None
        self._required_by: Optional[List[str]] = None
        self._alias: Optional[List[str]] = None
        self._also: Optional[List[str]] = None
        self._default_instance: Optional[str] = None

    def with_wanted_by(self, wanted_by: Union[str, List[str]]) -> 'InstallBuilder':
        """
        Sets the `wanted_by` field of the `install` section of a systemd service file.

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

        :return: The `InstallBuilder` object
        :rtype: InstallBuilder
        """

        self._wanted_by = wanted_by
        return self

    def with_required_by(self, required_by: Union[str, List[str]]) -> 'InstallBuilder':
        """
        Sets the `required_by` field of the `install` section of a systemd service file.

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

        :return: The `InstallBuilder` object
        :rtype: InstallBuilder
        """

        self._required_by = required_by
        return self

    def with_alias(self, alias: Union[str, List[str]]) -> 'InstallBuilder':
        """
        Sets the `alias` field of the `install` section of a systemd service file.

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

        :return: The `InstallBuilder` object
        :rtype: InstallBuilder
        """

        self._alias = alias
        return self

    def with_also(self, also: Union[str, List[str]]) -> 'InstallBuilder':
        """
        Sets the `also` field of the `install` section of a systemd service file.

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

        :return: The `InstallBuilder` object
        :rtype: InstallBuilder
        """

        self._also = also
        return self

    def with_default_instance(self, default_instance: str) -> 'InstallBuilder':
        """
        Sets the `default_instance` field of the `install` section of a systemd service file.

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

        :return: The `InstallBuilder` object
        :rtype: InstallBuilder
        """

        self._default_instance = default_instance
        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 install section of a systemd service file.

Returns:

Type Description
Install

The install section of a systemd service file
Source code in systemd_py/builders/install.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def build(self) -> Install:
    """
    Builds the `install` section of a systemd service file.

    :return: The `install` section of a systemd service file
    :rtype: Install
    """

    self._check()
    return Install(
        wanted_by=self._wanted_by,
        required_by=self._required_by,
        alias=self._alias,
        also=self._also,
        default_instance=self._default_instance
    )

with_alias(alias)

Sets the alias field of the install section of a systemd service file.

Parameters:

Name Type Description Default
alias Union[str, List[str]]

The alias field of the install section of a systemd service file

 required

Returns:

Type Description
InstallBuilder

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

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

    :return: The `InstallBuilder` object
    :rtype: InstallBuilder
    """

    self._alias = alias
    return self

with_also(also)

Sets the also field of the install section of a systemd service file.

Parameters:

Name Type Description Default
also Union[str, List[str]]

The also field of the install section of a systemd service file

 required

Returns:

Type Description
InstallBuilder

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

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

    :return: The `InstallBuilder` object
    :rtype: InstallBuilder
    """

    self._also = also
    return self

with_default_instance(default_instance)

Sets the default_instance field of the install section of a systemd service file.

Parameters:

Name Type Description Default
default_instance str

The default_instance field of the install section of a systemd service file

 required

Returns:

Type Description
InstallBuilder

The InstallBuilder object
Source code in systemd_py/builders/install.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
def with_default_instance(self, default_instance: str) -> 'InstallBuilder':
    """
    Sets the `default_instance` field of the `install` section of a systemd service file.

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

    :return: The `InstallBuilder` object
    :rtype: InstallBuilder
    """

    self._default_instance = default_instance
    return self

with_required_by(required_by)

Sets the required_by field of the install section of a systemd service file.

Parameters:

Name Type Description Default
required_by Union[str, List[str]]

The required_by field of the install section of a systemd service file

 required

Returns:

Type Description
InstallBuilder

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

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

    :return: The `InstallBuilder` object
    :rtype: InstallBuilder
    """

    self._required_by = required_by
    return self

with_wanted_by(wanted_by)

Sets the wanted_by field of the install section of a systemd service file.

Parameters:

Name Type Description Default
wanted_by Union[str, List[str]]

The wanted_by field of the install section of a systemd service file

 required

Returns:

Type Description
InstallBuilder

The InstallBuilder object
Source code in systemd_py/builders/install.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
def with_wanted_by(self, wanted_by: Union[str, List[str]]) -> 'InstallBuilder':
    """
    Sets the `wanted_by` field of the `install` section of a systemd service file.

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

    :return: The `InstallBuilder` object
    :rtype: InstallBuilder
    """

    self._wanted_by = wanted_by
    return self