Skip to content

Commit fd2511d

Browse files
refactor(system): add new overridesOnly parameter to… (#27)
system.tag.getConfiguration Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
1 parent 155e1b1 commit fd2511d

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

src/system/tag.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,7 @@ def exportTags(
210210
def getConfiguration(
211211
basePath, # type: Union[str, unicode]
212212
recursive=False, # type: bool
213+
overridesOnly=False, # type: bool
213214
):
214215
# type: (...) -> List[Dict[Union[str, unicode], Any]]
215216
"""Retrieves Tags from the Gateway as Python dictionaries.
@@ -225,6 +226,9 @@ def getConfiguration(
225226
will be retrieved. Note that this will only check one level
226227
under the base path. True recursion would require multiple
227228
uses of this function at different paths. Optional.
229+
overridesOnly: If True, only overridden properties from UDT
230+
members will be returned. If the tag is not a UDT member,
231+
this parameter is ignored. Optional.
228232
229233
Returns:
230234
A List of Tag dictionaries. Nested Tags are placed in a list

stubs/stubs/system/tag.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def exportTags(
3232
exportType: Union[str, unicode] = ...,
3333
) -> Union[str, unicode, None]: ...
3434
def getConfiguration(
35-
basePath: Union[str, unicode], recursive: bool = ...
35+
basePath: Union[str, unicode], recursive: bool = ..., overridesOnly: bool = ...
3636
) -> List[Dict[Union[str, unicode], Any]]: ...
3737
def importTags(
3838
filePath: Union[str, unicode],

0 commit comments

Comments
 (0)