Coverage for birdplan/bird_config/sections/protocols/ospf/area/area_attributes.py: 94%

1# 

2# SPDX-License-Identifier: GPL-3.0-or-later 

3# 

4# Copyright (c) 2019-2024, AllWorldIT 

5# 

6# This program is free software: you can redistribute it and/or modify 

7# it under the terms of the GNU General Public License as published by 

8# the Free Software Foundation, either version 3 of the License, or 

9# (at your option) any later version. 

10# 

11# This program is distributed in the hope that it will be useful, 

12# but WITHOUT ANY WARRANTY; without even the implied warranty of 

13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

14# GNU General Public License for more details. 

15# 

16# You should have received a copy of the GNU General Public License 

17# along with this program. If not, see <http://www.gnu.org/licenses/>. 

18 

19"""BIRD OSPF area attributes.""" 

20 

21from typing import Optional 

22 

23from ......exceptions import BirdPlanError 

24 

25__all__ = ["OSPFAreaAttributes"] 

26 

27 

28class OSPFAreaAttributes: # pylint: disable=too-few-public-methods 

29 """ 

30 OSPF area attributes. 

31 

32 Attributes 

33 ---------- 

34 name : Optional[str] 

35 Area name. 

36 

37 """ 

38 

39 _name: Optional[str] 

40 

41 def __init__(self) -> None: 

42 """Initialize object.""" 

43 

44 self._name = None 

45 

46 @property 

47 def name(self) -> str: 

48 """Area name.""" 

49 if self._name is None: 

50 raise BirdPlanError("OSPF area name must be set") 

51 return self._name 

52 

53 @name.setter 

54 def name(self, name: str) -> None: 

55 """Area name.""" 

56 self._name = name