Source code for cobbler.items.menu
"""
Copyright 2021 Yuriy Chelpanov
Yuriy Chelpanov <yuriy.chelpanov@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
"""
import uuid
from typing import List, Optional
from cobbler.cexceptions import CX
from cobbler.decorator import LazyProperty
from cobbler.items import item
[docs]
class Menu(item.Item):
"""
A Cobbler menu object.
"""
TYPE_NAME = "menu"
COLLECTION_TYPE = "menu"
def __init__(self, api, *args, **kwargs):
"""
Constructor
"""
super().__init__(api)
# Prevent attempts to clear the to_dict cache before the object is initialized.
self._has_initialized = False
self._display_name = ""
if len(kwargs) > 0:
self.from_dict(kwargs)
if not self._has_initialized:
self._has_initialized = True
#
# override some base class methods first (item.Item)
#
[docs]
def make_clone(self):
"""
Clone this file object. Please manually adjust all value yourself to make the cloned object unique.
:return: The cloned instance of this object.
"""
_dict = self.to_dict()
_dict.pop("uid", None)
cloned = Menu(self.api)
cloned.from_dict(_dict)
return cloned
#
# specific methods for item.Menu
#
@LazyProperty
def display_name(self) -> str:
"""
Returns the display name.
:getter: Returns the display name.
:setter: Sets the display name.
"""
return self._display_name
@display_name.setter
def display_name(self, display_name: str):
"""
Setter for the display_name of the item.
:param display_name: The new display_name. If ``None`` the comment will be set to an emtpy string.
"""
self._display_name = display_name