Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filter nested properties based on metadata #94

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 22 additions & 8 deletions singer/transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ def unix_seconds_to_datetime(value):
return strftime(datetime.datetime.fromtimestamp(int(value), datetime.timezone.utc))


def breadcrumb_path(breadcrumb):
"""
Transform breadcrumb into familiar object dot-notation
"""
name = ".".join(breadcrumb)
name = name.replace('properties.', '')
name = name.replace('.items', '[]')
return name


class SchemaMismatch(Exception):
def __init__(self, errors):
if not errors:
Expand Down Expand Up @@ -101,21 +111,25 @@ def __enter__(self):
def __exit__(self, *args):
self.log_warning()

def filter_data_by_metadata(self, data, metadata):
def filter_data_by_metadata(self, data, metadata, parent=()):
if isinstance(data, dict) and metadata:
for field_name in list(data.keys()):
selected = singer.metadata.get(metadata, ('properties', field_name), 'selected')
inclusion = singer.metadata.get(metadata, ('properties', field_name), 'inclusion')
breadcrumb = parent + ('properties', field_name)
selected = singer.metadata.get(metadata, breadcrumb, 'selected')
inclusion = singer.metadata.get(metadata, breadcrumb, 'inclusion')
if inclusion == 'automatic':
continue

if selected is False:
if (selected is False) or (inclusion == 'unsupported'):
data.pop(field_name, None)
self.filtered.add(field_name)
self.filtered.add(breadcrumb_path(breadcrumb))
else:
data[field_name] = self.filter_data_by_metadata(
data[field_name], metadata, breadcrumb)

if inclusion == 'unsupported':
data.pop(field_name, None)
self.filtered.add(field_name)
if isinstance(data, list) and metadata:
breadcrumb = parent + ('items',)
data = [self.filter_data_by_metadata(d, metadata, parent + ('items', )) for d in data]

return data

Expand Down