Coverage for pyTooling / GenericPath / __init__.py: 97%

1# ==================================================================================================================== # 

2# _____ _ _ ____ _ ____ _ _ # 

3# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| ___ _ __ ___ _ __(_) ___| _ \ __ _| |_| |__ # 

4# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | _ / _ \ '_ \ / _ \ '__| |/ __| |_) / _` | __| '_ \ # 

5# | |_) | |_| || | (_) | (_) | | | | | | (_| || |_| | __/ | | | __/ | | | (__| __/ (_| | |_| | | | # 

6# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|\___|_| |_|\___|_| |_|\___|_| \__,_|\__|_| |_| # 

7# |_| |___/ |___/ # 

8# ==================================================================================================================== # 

9# Authors: # 

10# Patrick Lehmann # 

11# # 

12# License: # 

13# ==================================================================================================================== # 

14# Copyright 2017-2026 Patrick Lehmann - Bötzingen, Germany # 

15# # 

16# Licensed under the Apache License, Version 2.0 (the "License"); # 

17# you may not use this file except in compliance with the License. # 

18# You may obtain a copy of the License at # 

19# # 

20# http://www.apache.org/licenses/LICENSE-2.0 # 

21# # 

22# Unless required by applicable law or agreed to in writing, software # 

23# distributed under the License is distributed on an "AS IS" BASIS, # 

24# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

25# See the License for the specific language governing permissions and # 

26# limitations under the License. # 

27# # 

28# SPDX-License-Identifier: Apache-2.0 # 

29# ==================================================================================================================== # 

30# 

31"""A generic path to derive domain specific path libraries.""" 

32from typing import List, Optional as Nullable, Type 

33 

34try: 

35 from pyTooling.Decorators import export 

36 from pyTooling.MetaClasses import ExtendedType 

37except (ImportError, ModuleNotFoundError): # pragma: no cover 

38 print("[pyTooling.GenericPath] Could not import from 'pyTooling.*'!") 

39 

40 try: 

41 from Decorators import export 

42 from MetaClasses import ExtendedType 

43 except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover 

44 print("[pyTooling.GenericPath] Could not import directly!") 

45 raise ex 

46 

47 

48@export 

49class Base(metaclass=ExtendedType, mixin=True): 

50 """Base-mixin-class for all :mod:`pyTooling.GenericPath` path elements.""" 

51 

52 DELIMITER = "/" #: Path element delimiter sign. 

53 

54 _parent: Nullable["Base"] #: Reference to the parent object. 

55 

56 def __init__(self, parent: Nullable["Base"] = None) -> None: 

57 """ 

58 Initialize the base-mixin-class with a parent reference. 

59 

60 :param parent: Optional parent reference. 

61 """ 

62 self._parent = parent 

63 

64 

65@export 

66class RootMixIn(Base, mixin=True): 

67 """Mixin-class for root elements in a path system.""" 

68 

69 def __init__(self) -> None: 

70 """ 

71 Initialize the mixin-class for a root element. 

72 """ 

73 super().__init__(None) 

74 

75 

76@export 

77class ElementMixIn(Base, mixin=True): 

78 """Mixin-class for elements in a path system.""" 

79 

80 _elementName: str #: Name of the path element. 

81 

82 def __init__(self, parent: Base, elementName: str) -> None: 

83 """ 

84 Initialize the mixin-class for a path element. 

85 

86 :param parent: Reference to a parent path element. 

87 :param elementName: Name of the path element. 

88 """ 

89 super().__init__(parent) 

90 

91 self._elementName = elementName 

92 

93 def __str__(self) -> str: 

94 return self._elementName 

95 

96 

97@export 

98class PathMixIn(metaclass=ExtendedType, mixin=True): 

99 """Mixin-class for a path.""" 

100 

101 ELEMENT_DELIMITER = "/" #: Path element delimiter sign. 

102 ROOT_DELIMITER = "/" #: Root element delimiter sign. 

103 

104 _isAbsolute: bool #: True, if the path is absolute. 

105 _elements: List[ElementMixIn] #: List of path elements. 

106 

107 def __init__(self, elements: List[ElementMixIn], isAbsolute: bool) -> None: 

108 """ 

109 Initialize the mixin-class for a path. 

110 

111 :param elements: Reference to a parent path element. 

112 :param isAbsolute: Assign to true, if a path is absolute, otherwise false. 

113 """ 

114 self._isAbsolute = isAbsolute 

115 self._elements = elements 

116 

117 def __len__(self) -> int: 

118 """ 

119 Returns the number of path elements. 

120 

121 :returns: Number of path elements. 

122 """ 

123 return len(self._elements) 

124 

125 def __str__(self) -> str: 

126 result = self.ROOT_DELIMITER if self._isAbsolute else "" 

127 

128 if len(self._elements) > 0: 128 ↛ 134line 128 didn't jump to line 134 because the condition on line 128 was always true

129 result = result + str(self._elements[0]) 

130 

131 for element in self._elements[1:]: 

132 result = result + self.ELEMENT_DELIMITER + str(element) 

133 

134 return result 

135 

136 @classmethod 

137 def Parse( 

138 cls, 

139 path: str, 

140 root: RootMixIn, 

141 pathCls: Type["PathMixIn"], 

142 elementCls: Type[ElementMixIn] 

143 ) -> "PathMixIn": 

144 """ 

145 Parses a string representation of a path and returns a path instance. 

146 

147 :param path: Path to be parsed. 

148 :param root: 

149 :param pathCls: Type used to create the path. 

150 :param elementCls: Type used to create the path elements. 

151 :return: 

152 """ 

153 if path.startswith(cls.ROOT_DELIMITER): 

154 isAbsolute = True 

155 path = path[len(cls.ELEMENT_DELIMITER):] 

156 else: 

157 isAbsolute = False 

158 

159 parent = root 

160 elements = [] 

161 for part in path.split(cls.ELEMENT_DELIMITER): 

162 element = elementCls(parent, part) 

163 parent = element 

164 elements.append(element) 

165 

166 return pathCls(elements, isAbsolute) 

167 

168 

169@export 

170class SystemMixIn(metaclass=ExtendedType, mixin=True): 

171 """Mixin-class for a path system."""