Coverage for datakiln/metadata/column.py: 93%

29 statements  

« prev     ^ index     » next       coverage.py v7.17.3, created at 2026-11-16 23:23 +0000

1""" 

2Column metadata. 

3""" 

4from textwrap import dedent 

5 

6 

7class ColumnMeta(): 

8 """Metadata for column.""" 

9 

10 def __init__(self, name, dtype, description=None, required=False, 

11 rename=None, transform=False): 

12 # pylint: disable=too-many-arguments, too-many-positional-arguments 

13 """ 

14 :param name: Name of the column. 

15 :type name: str 

16 

17 :param dtype: Type of the column for each dialect. 

18 :type dtype: dict 

19 

20 :param description: Description of the column. 

21 :type description: str 

22 

23 :param required: If True, column can't be NULL. 

24 :type required: bool 

25 

26 :param rename: Name to be used in the database. 

27 :type rename: str 

28 

29 :param rename: Specifies if the column is derived/created in the 

30 transform step. 

31 (This means the column is not present and will not be 

32 retrieved from the source). 

33 :type rename: bool 

34 

35 :return: Column metadata. 

36 :rtype: ColumnMeta 

37 """ 

38 self.name = name 

39 self.dtype = dtype 

40 self.rename = rename or name 

41 self.description = description 

42 self.required = required 

43 self.transform = transform 

44 

45 def __str__(self): 

46 return self.rename 

47 

48 def __iter__(self): 

49 for item in self.__dict__.items(): 

50 if item[0].startswith("_"): 

51 continue 

52 yield item 

53 

54 def typed(self, dialect): 

55 """Name of column followed by dialect-specific type. 

56 

57 :param dialect: Dialect of the database. 

58 :type dialect: str 

59 

60 :return: Typed column name. 

61 :rtype: str 

62 """ 

63 typed = f"{self.rename} {self.dtype[dialect]}" 

64 

65 if self.required: 

66 typed += " NOT NULL" 

67 

68 return typed 

69 

70 def resolve_na(self, session, schema, name, na_values, **kwargs): 

71 """Enforce column data type. 

72 

73 :param session: Database Session. 

74 :type session: datakiln.metadata.database.Session 

75 

76 :param schema: Table schema. 

77 :type schema: str 

78 

79 :param name: Table name. 

80 :type name: str 

81 

82 :param na_values: Values to consider as NULL. 

83 :type columns: set[str] 

84 

85 :return: None 

86 """ 

87 stmt = dedent(""" 

88 UPDATE _{schema}.{table} 

89 SET {name} = NULL 

90 WHERE {name} IN ( 

91 '{na_values}' 

92 )""").format( 

93 schema=schema, 

94 table=name, 

95 name=self.rename, 

96 na_values="'\n , '".join(na_values) 

97 ) 

98 session.execute(stmt, **kwargs) 

99 

100 def comment(self, session, schema, name, **kwargs): 

101 """Add column description as a column comment. 

102 

103 :param session: Database Session. 

104 :type session: datakiln.metadata.database.Session 

105 

106 :param schema: Table schema. 

107 :type schema: str 

108 

109 :param name: Table name. 

110 :type name: str 

111 

112 :return: None 

113 """ 

114 if self.description is None: 

115 return 

116 

117 stmt = dedent(f""" 

118 COMMENT ON COLUMN {schema}.{name}.{self.rename} IS '{self.description}' 

119 """) 

120 session.execute(stmt, **kwargs)