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.

Sign up for GitHub

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

Add --json to output adtl report as json #74

Merged
merged 1 commit into from
Jun 22, 2023
Merged

Add --json to output adtl report as json #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions adtl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ def __init__(self, spec: Union[str, Path, StrDict], include_defs: List[str] = []
self.schemas: StrDict = {}
self.date_fields = []
self.report = {
"errors": defaultdict(Counter),
"validation_errors": defaultdict(Counter),
"total_valid": defaultdict(int),
"total": defaultdict(int),
}
Expand Down Expand Up @@ -726,7 +726,7 @@ def parse_rows(self, rows: Iterable[StrDict], skip_validation=False):
except fastjsonschema.exceptions.JsonSchemaValueException as e:
row["adtl_valid"] = False
row["adtl_error"] = e.message
self.report["errors"][table].update([e.message])
self.report["validation_errors"][table].update([e.message])
return self

def clear(self):
Expand All @@ -751,7 +751,6 @@ def write_csv(
"Writes to output as CSV a particular table"

def writerows(fp, table):
print(f"Writing {table}")
writer = csv.DictWriter(
fp,
fieldnames=(
Expand Down Expand Up @@ -782,9 +781,11 @@ def show_report(self):
f"|{self.report['total_valid'][table]/self.report['total'][table]:%} |"
)
print()
for table in self.report["errors"]:
for table in self.report["validation_errors"]:
print(f"## {table}\n")
for message, count in self.report["errors"][table].most_common():
for message, count in self.report["validation_errors"][
table
].most_common():
print(f"* {count}: {message}")
print()

Expand All @@ -793,7 +794,6 @@ def save(self, output: Optional[str] = None):

for table in self.tables:
self.write_csv(table, f"{output}-{table}.csv")
self.show_report()


def main():
Expand All @@ -812,6 +812,9 @@ def main():
cmd.add_argument(
"--encoding", help="Encoding input file is in", default="utf-8-sig"
)
cmd.add_argument(
"--json", help="Output metadata in JSON format", action="store_true"
)
cmd.add_argument(
"--include-def",
action="append",
Expand All @@ -820,10 +823,17 @@ def main():
args = cmd.parse_args()
include_defs = args.include_def or []
spec = Parser(args.spec, include_defs=include_defs)
if output := spec.parse(args.file, encoding=args.encoding).save(
args.output or spec.name
):
print(output)

# run adtl
adtl_output = spec.parse(args.file, encoding=args.encoding)
adtl_output.save(args.output or spec.name)
if args.json:
adtl_output.report.update(
dict(encoding=args.encoding, include_defs=include_defs)
)
print(json.dumps(adtl_output.report, sort_keys=True, indent=2))
else:
adtl_output.show_report()


if __name__ == "__main__":
Expand Down