Coverage for src/metador_core/container/utils.py: 100%

1"""Constants and helper functions. 

2 

3Provides syntactic path transformations to implement the Metador container layout. 

4""" 

5 

6from typing_extensions import Final 

7 

8METADOR_SPEC_VERSION: Final[str] = "1.0" 

9"""Version of container spec created by this package.""" 

10# NOTE: don't forget to change it when something about the container structure changes! 

11 

12METADOR_PREF: Final[str] = "metador_" 

13"""Reserved prefix for group and dataset names.""" 

14 

15METADOR_META_PREF: Final[str] = METADOR_PREF + "meta_" 

16"""Sub-prefix for group that stores group or dataset metadata.""" 

17 

18METADOR_TOC_PATH: Final[str] = f"/{METADOR_PREF}container" 

19"""Path of group with the Metador metadata index structure of the container.""" 

20 

21METADOR_VERSION_PATH: Final[str] = f"{METADOR_TOC_PATH}/version" 

22"""Path of dataset with the Metador container spec version of the container.""" 

23 

24METADOR_UUID_PATH: Final[str] = f"{METADOR_TOC_PATH}/uuid" 

25"""Path of dataset with the Metador container version of the container.""" 

26 

27METADOR_PACKAGES_PATH: Final[str] = f"{METADOR_TOC_PATH}/packages" 

28"""Path of group with package info of packages providing used schemas in the container.""" 

29 

30METADOR_SCHEMAS_PATH: Final[str] = f"{METADOR_TOC_PATH}/schemas" 

31"""Path of group with info about used schemas in the container.""" 

32 

33METADOR_LINKS_PATH: Final[str] = f"{METADOR_TOC_PATH}/links" 

34"""Path of group with links to schema instances in the container.""" 

35 

36 

37def is_internal_path(path: str, pref: str = METADOR_PREF) -> bool: 

38 """Return whether the path of this node is Metador-internal (metador_*). 

39 

40 Optional argument can set a different prefix that path segments are checked for. 

41 """ 

42 # first case is for relative paths, second for later path segments and absolute paths 

43 return path.startswith(pref) or path.find(f"/{pref}") >= 0 

44 

45 

46# filtering and transforming between node and metadata base path 

47 

48 

49def is_meta_base_path(path: str) -> bool: 

50 """Return whether the path is a metadata base dir (but not an inner path!).""" 

51 return path.split("/")[-1].startswith(METADOR_META_PREF) 

52 

53 

54def to_meta_base_path(node_path: str, is_dataset: bool) -> str: 

55 """Return path to base group containing metadata for given node.""" 

56 segs = node_path.split("/") 

57 if is_dataset: 

58 segs[-1] = METADOR_META_PREF + segs[-1] 

59 elif segs == ["", ""]: # name was "/" 

60 segs[-1] = METADOR_META_PREF 

61 else: 

62 segs.append(METADOR_META_PREF) 

63 return "/".join(segs) 

64 

65 

66def to_data_node_path(meta_dir_path: str) -> str: 

67 """Given a metadata group path, infer the correct node path. 

68 

69 Path can be relative or absolute. 

70 Will not check validity of the passed path, assumes it is fitting the scheme! 

71 """ 

72 segs = meta_dir_path.split("/") 

73 pl = len(METADOR_META_PREF) 

74 segs[-1] = segs[-1][pl:] 

75 if segs[-1] == "" and (len(segs) > 2 or segs[0] != ""): 

76 segs.pop() 

77 return "/".join(segs)