/
file.py
427 lines (385 loc) · 16.1 KB
/
file.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
import datetime
import json
import logging
import os.path
import pathlib
from dataclasses import dataclass, field
from enum import auto
from functools import partial
from io import BufferedReader
from typing import Any, Iterable, Iterator, List, Optional, Tuple, Union
from urllib import parse
import ijson
import requests
from pydantic import validator
from pydantic.fields import Field
from datahub.configuration.common import ConfigEnum, ConfigModel, ConfigurationError
from datahub.configuration.validate_field_deprecation import pydantic_field_deprecated
from datahub.configuration.validate_field_rename import pydantic_renamed_field
from datahub.emitter.mcp import MetadataChangeProposalWrapper
from datahub.ingestion.api.common import PipelineContext
from datahub.ingestion.api.decorators import (
SupportStatus,
config_class,
platform_name,
support_status,
)
from datahub.ingestion.api.source import (
CapabilityReport,
MetadataWorkUnitProcessor,
SourceReport,
TestableSource,
TestConnectionReport,
)
from datahub.ingestion.api.source_helpers import auto_workunit_reporter
from datahub.ingestion.api.workunit import MetadataWorkUnit
from datahub.metadata.com.linkedin.pegasus2avro.mxe import (
MetadataChangeEvent,
MetadataChangeProposal,
)
from datahub.metadata.schema_classes import UsageAggregationClass
logger = logging.getLogger(__name__)
class FileReadMode(ConfigEnum):
STREAM = auto()
BATCH = auto()
AUTO = auto()
class FileSourceConfig(ConfigModel):
_filename = pydantic_field_deprecated(
"filename",
message="filename is deprecated. Use path instead.",
)
path: str = Field(
description="File path to folder or file to ingest, or URL to a remote file. If pointed to a folder, all files with extension {file_extension} (default json) within that folder will be processed."
)
file_extension: str = Field(
".json",
description="When providing a folder to use to read files, set this field to control file extensions that you want the source to process. * is a special value that means process every file regardless of extension",
)
read_mode: FileReadMode = FileReadMode.AUTO
aspect: Optional[str] = Field(
default=None,
description="Set to an aspect to only read this aspect for ingestion.",
)
count_all_before_starting: bool = Field(
default=True,
description="When enabled, counts total number of records in the file before starting. Used for accurate estimation of completion time. Turn it off if startup time is too high.",
)
_minsize_for_streaming_mode_in_bytes: int = (
100 * 1000 * 1000 # Must be at least 100MB before we use streaming mode
)
_filename_populates_path_if_present = pydantic_renamed_field(
"filename", "path", print_warning=False
)
@validator("file_extension", always=True)
def add_leading_dot_to_extension(cls, v: str) -> str:
if v:
if v.startswith("."):
return v
else:
return "." + v
return v
@dataclass
class FileSourceReport(SourceReport):
total_num_files: int = 0
num_files_completed: int = 0
files_completed: list = field(default_factory=list)
percentage_completion: str = "0%"
estimated_time_to_completion_in_minutes: int = -1
total_bytes_on_disk: Optional[int] = None
total_bytes_read_completed_files: int = 0
current_file_name: Optional[str] = None
current_file_size: Optional[int] = None
current_file_num_elements: Optional[int] = None
current_file_bytes_read: Optional[int] = None
current_file_elements_read: Optional[int] = None
total_parse_time_in_seconds: float = 0
total_count_time_in_seconds: float = 0
total_deserialize_time_in_seconds: float = 0
def add_deserialize_time(self, delta: datetime.timedelta) -> None:
self.total_deserialize_time_in_seconds += round(delta.total_seconds(), 2)
def add_parse_time(self, delta: datetime.timedelta) -> None:
self.total_parse_time_in_seconds += round(delta.total_seconds(), 2)
def add_count_time(self, delta: datetime.timedelta) -> None:
self.total_count_time_in_seconds += round(delta.total_seconds(), 2)
def append_total_bytes_on_disk(self, delta: int) -> None:
if self.total_bytes_on_disk is not None:
self.total_bytes_on_disk += delta
else:
self.total_bytes_on_disk = delta
def reset_current_file_stats(self) -> None:
self.current_file_name = None
self.current_file_bytes_read = None
self.current_file_num_elements = None
self.current_file_elements_read = None
def compute_stats(self) -> None:
super().compute_stats()
self.num_files_completed = len(self.files_completed)
total_bytes_read = self.total_bytes_read_completed_files
if self.current_file_bytes_read:
total_bytes_read += self.current_file_bytes_read
elif (
self.current_file_elements_read
and self.current_file_num_elements
and self.current_file_size
):
current_files_bytes_read = int(
(self.current_file_elements_read / self.current_file_num_elements)
* self.current_file_size
)
total_bytes_read += current_files_bytes_read
percentage_completion = (
100.0 * (total_bytes_read / self.total_bytes_on_disk)
if self.total_bytes_on_disk
else -1
)
if percentage_completion > 0:
self.estimated_time_to_completion_in_minutes = int(
(
self.running_time.total_seconds()
* (100 - percentage_completion)
/ percentage_completion
)
/ 60
)
self.percentage_completion = f"{percentage_completion:.2f}%"
@platform_name("File")
@config_class(FileSourceConfig)
@support_status(SupportStatus.CERTIFIED)
class GenericFileSource(TestableSource):
"""
This plugin pulls metadata from a previously generated file. The [file sink](../../../../metadata-ingestion/sink_docs/file.md) can produce such files, and a number of samples are included in the [examples/mce_files](../../../../metadata-ingestion/examples/mce_files) directory.
"""
def __init__(self, ctx: PipelineContext, config: FileSourceConfig):
self.ctx = ctx
self.config = config
self.report = FileSourceReport()
self.fp: Optional[BufferedReader] = None
@classmethod
def create(cls, config_dict, ctx):
config = FileSourceConfig.parse_obj(config_dict)
return cls(ctx, config)
def get_filenames(self) -> Iterable[str]:
path_parsed = parse.urlparse(str(self.config.path))
if path_parsed.scheme in ("file", ""):
path = pathlib.Path(self.config.path)
if path.is_file():
self.report.total_num_files = 1
return [str(path)]
elif path.is_dir():
files_and_stats = [
(str(x), os.path.getsize(x))
for x in path.glob(f"*{self.config.file_extension}")
if x.is_file()
]
self.report.total_num_files = len(files_and_stats)
self.report.total_bytes_on_disk = sum([y for (x, y) in files_and_stats])
return [x for (x, y) in files_and_stats]
else:
raise Exception(f"Failed to process {path}")
else:
self.report.total_num_files = 1
return [str(self.config.path)]
def get_workunit_processors(self) -> List[Optional[MetadataWorkUnitProcessor]]:
# No super() call, as we don't want helpers that create / remove workunits
return [partial(auto_workunit_reporter, self.report)]
def get_workunits_internal(
self,
) -> Iterable[MetadataWorkUnit]:
for f in self.get_filenames():
for i, obj in self.iterate_generic_file(f):
id = f"file://{f}:{i}"
if isinstance(
obj, (MetadataChangeProposalWrapper, MetadataChangeProposal)
):
if (
self.config.aspect is not None
and obj.aspectName is not None
and obj.aspectName != self.config.aspect
):
continue
if isinstance(obj, MetadataChangeProposalWrapper):
yield MetadataWorkUnit(id, mcp=obj)
else:
yield MetadataWorkUnit(id, mcp_raw=obj)
else:
yield MetadataWorkUnit(id, mce=obj)
def get_report(self):
return self.report
def close(self):
if self.fp:
self.fp.close()
super().close()
def _iterate_file(self, path: str) -> Iterable[Tuple[int, Any]]:
self.report.current_file_name = path
path_parsed = parse.urlparse(path)
if path_parsed.scheme not in ("http", "https"): # A local file
self.report.current_file_size = os.path.getsize(path)
if self.config.read_mode == FileReadMode.AUTO:
file_read_mode = (
FileReadMode.BATCH
if self.report.current_file_size
< self.config._minsize_for_streaming_mode_in_bytes
else FileReadMode.STREAM
)
logger.info(f"Reading file {path} in {file_read_mode} mode")
else:
file_read_mode = self.config.read_mode
if file_read_mode == FileReadMode.BATCH:
with open(path, "r") as f:
parse_start_time = datetime.datetime.now()
obj_list = json.load(f)
parse_end_time = datetime.datetime.now()
self.report.add_parse_time(parse_end_time - parse_start_time)
if not isinstance(obj_list, list):
obj_list = [obj_list]
count_start_time = datetime.datetime.now()
self.report.current_file_num_elements = len(obj_list)
self.report.add_count_time(datetime.datetime.now() - count_start_time)
self.report.current_file_elements_read = 0
for i, obj in enumerate(obj_list):
yield i, obj
self.report.current_file_elements_read += 1
else:
self.fp = open(path, "rb")
if self.config.count_all_before_starting:
count_start_time = datetime.datetime.now()
parse_stream = ijson.parse(self.fp, use_float=True)
total_elements = 0
for row in ijson.items(parse_stream, "item", use_float=True):
total_elements += 1
count_end_time = datetime.datetime.now()
self.report.add_count_time(count_end_time - count_start_time)
self.report.current_file_num_elements = total_elements
self.report.current_file_elements_read = 0
self.fp.seek(0)
parse_start_time = datetime.datetime.now()
parse_stream = ijson.parse(self.fp, use_float=True)
rows_yielded = 0
for row in ijson.items(parse_stream, "item", use_float=True):
parse_end_time = datetime.datetime.now()
self.report.add_parse_time(parse_end_time - parse_start_time)
rows_yielded += 1
self.report.current_file_elements_read += 1
yield rows_yielded, row
parse_start_time = datetime.datetime.now()
else:
try:
response = requests.get(path)
parse_start_time = datetime.datetime.now()
data = response.json()
except Exception as e:
raise ConfigurationError(f"Cannot read remote file {path}, error:{e}")
if not isinstance(data, list):
data = [data]
parse_end_time = datetime.datetime.now()
self.report.add_parse_time(parse_end_time - parse_start_time)
self.report.current_file_size = len(response.content)
self.report.current_file_elements_read = 0
for i, obj in enumerate(data):
yield i, obj
self.report.current_file_elements_read += 1
self.report.files_completed.append(path)
self.report.num_files_completed += 1
self.report.total_bytes_read_completed_files += self.report.current_file_size
self.report.reset_current_file_stats()
def iterate_mce_file(self, path: str) -> Iterator[MetadataChangeEvent]:
for i, obj in self._iterate_file(path):
mce: MetadataChangeEvent = MetadataChangeEvent.from_obj(obj)
yield mce
def iterate_generic_file(
self,
path: str,
) -> Iterator[
Tuple[
int,
Union[
MetadataChangeEvent,
MetadataChangeProposalWrapper,
MetadataChangeProposal,
],
]
]:
for i, obj in self._iterate_file(path):
try:
deserialize_start_time = datetime.datetime.now()
item = _from_obj_for_file(obj)
if item is not None:
deserialize_duration = (
datetime.datetime.now() - deserialize_start_time
)
self.report.add_deserialize_time(deserialize_duration)
yield i, item
except Exception as e:
self.report.report_failure(f"path-{i}", str(e))
@staticmethod
def test_connection(config_dict: dict) -> TestConnectionReport:
config = FileSourceConfig.parse_obj(config_dict)
exists = os.path.exists(config.path)
if not exists:
return TestConnectionReport(
basic_connectivity=CapabilityReport(
capable=False,
failure_reason=f"{config.path} doesn't appear to be a valid file or directory.",
)
)
is_dir = os.path.isdir(config.path)
failure_message = None
readable = os.access(config.path, os.R_OK)
if not readable:
failure_message = f"Cannot read {config.path}"
if is_dir:
executable = os.access(config.path, os.X_OK)
if not executable:
failure_message = f"Do not have execute permissions in {config.path}"
if failure_message:
return TestConnectionReport(
basic_connectivity=CapabilityReport(
capable=False, failure_reason=failure_message
)
)
else:
return TestConnectionReport(
basic_connectivity=CapabilityReport(capable=True)
)
def _from_obj_for_file(
obj: dict,
) -> Union[
MetadataChangeEvent,
MetadataChangeProposal,
MetadataChangeProposalWrapper,
None,
]:
item: Union[
MetadataChangeEvent,
MetadataChangeProposalWrapper,
MetadataChangeProposal,
UsageAggregationClass,
]
if "proposedSnapshot" in obj:
item = MetadataChangeEvent.from_obj(obj)
elif "aspect" in obj:
item = MetadataChangeProposalWrapper.from_obj(obj)
else:
item = UsageAggregationClass.from_obj(obj)
if not item.validate():
raise ValueError(f"failed to parse: {obj}")
if isinstance(item, UsageAggregationClass):
logger.warning(f"Dropping deprecated UsageAggregationClass: {item}")
return None
else:
return item
def read_metadata_file(
file: pathlib.Path,
) -> Iterable[
Union[
MetadataChangeEvent,
MetadataChangeProposal,
MetadataChangeProposalWrapper,
]
]:
# This simplified version of the FileSource can be used for testing purposes.
with file.open("r") as f:
for obj in json.load(f):
item = _from_obj_for_file(obj)
if item:
yield item