datacontract-cli 0.9.7__py3-none-any.whl → 0.9.9__py3-none-any.whl

datacontract/breaking/breaking.py

@@ -1,5 +1,5 @@
 from datacontract.breaking.breaking_rules import BreakingRules
-from datacontract.model.breaking_change import BreakingChanges, BreakingChange, Location, Severity
+from datacontract.model.breaking_change import BreakingChange, Location, Severity
 from datacontract.model.data_contract_specification import Field, Model, Quality
 
 
@@ -22,10 +22,9 @@ def quality_breaking_changes(
                     description=description,
                     check_name=rule_name,
                     severity=severity,
-                    location=Location(
-                        path=new_path,
-                        composition=["quality"]
-                    )))
+                    location=Location(path=new_path, composition=["quality"]),
+                )
+            )
     elif old_quality and not new_quality:
         rule_name = "quality_removed"
         severity = _get_rule(rule_name)
@@ -37,10 +36,9 @@ def quality_breaking_changes(
                     description=description,
                     check_name=rule_name,
                     severity=severity,
-                    location=Location(
-                        path=new_path,
-                        composition=["quality"]
-                    )))
+                    location=Location(path=new_path, composition=["quality"]),
+                )
+            )
 
     elif old_quality and new_quality:
         if old_quality.type != new_quality.type:
@@ -54,10 +52,9 @@ def quality_breaking_changes(
                         description=description,
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=["quality", "type"]
-                        )))
+                        location=Location(path=new_path, composition=["quality", "type"]),
+                    )
+                )
 
         if old_quality.specification != new_quality.specification:
             rule_name = "quality_specification_updated"
@@ -69,10 +66,9 @@ def quality_breaking_changes(
                         description=description,
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=["quality", "specification"]
-                        )))
+                        location=Location(path=new_path, composition=["quality", "specification"]),
+                    )
+                )
 
     return results
 
@@ -96,10 +92,9 @@ def models_breaking_changes(
                         description="added the model",
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [model_name]
-                        )))
+                        location=Location(path=new_path, composition=composition + [model_name]),
+                    )
+                )
 
     for model_name, old_model in old_models.items():
         if model_name not in new_models.keys():
@@ -111,10 +106,9 @@ def models_breaking_changes(
                         description="removed the model",
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [model_name]
-                        )))
+                        location=Location(path=new_path, composition=composition + [model_name]),
+                    )
+                )
             continue
 
         results.extend(
@@ -124,17 +118,14 @@ def models_breaking_changes(
                 new_path=new_path,
                 composition=composition + [model_name],
                 include_severities=include_severities,
-            ))
+            )
+        )
 
     return results
 
 
 def model_breaking_changes(
-    old_model: Model,
-    new_model: Model,
-    new_path: str,
-    composition: list[str],
-    include_severities: [Severity]
+    old_model: Model, new_model: Model, new_path: str, composition: list[str], include_severities: [Severity]
 ) -> list[BreakingChange]:
     results = list[BreakingChange]()
 
@@ -170,10 +161,9 @@ def model_breaking_changes(
                         description=description,
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [model_definition_field]
-                        )))
+                        location=Location(path=new_path, composition=composition + [model_definition_field]),
+                    )
+                )
 
     results.extend(
         fields_breaking_changes(
@@ -182,7 +172,8 @@ def model_breaking_changes(
             new_path=new_path,
             composition=composition + ["fields"],
             include_severities=include_severities,
-        ))
+        )
+    )
 
     return results
 
@@ -192,7 +183,7 @@ def fields_breaking_changes(
     new_fields: dict[str, Field],
     new_path: str,
     composition: list[str],
-    include_severities: [Severity]
+    include_severities: [Severity],
 ) -> list[BreakingChange]:
     results = list[BreakingChange]()
 
@@ -206,10 +197,9 @@ def fields_breaking_changes(
                         description="added the field",
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [field_name]
-                        )))
+                        location=Location(path=new_path, composition=composition + [field_name]),
+                    )
+                )
 
     for field_name, old_field in old_fields.items():
         if field_name not in new_fields.keys():
@@ -218,13 +208,12 @@ def fields_breaking_changes(
             if severity in include_severities:
                 results.append(
                     BreakingChange(
-                        description='removed the field',
+                        description="removed the field",
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [field_name]
-                        )))
+                        location=Location(path=new_path, composition=composition + [field_name]),
+                    )
+                )
             continue
 
         results.extend(
@@ -234,7 +223,8 @@ def fields_breaking_changes(
                 composition=composition + [field_name],
                 new_path=new_path,
                 include_severities=include_severities,
-            ))
+            )
+        )
     return results
 
 
@@ -271,7 +261,7 @@ def field_breaking_changes(
         description = None
 
         # logic for enum, tags and other arrays
-        if type(old_value) is list and type(new_value) is list:
+        if isinstance(old_value, list) and isinstance(new_value, list):
             if not old_value and new_value:
                 rule_name = f"field_{_camel_to_snake(field_definition_field)}_added"
                 description = f"added with value: `{new_value}`"
@@ -285,7 +275,7 @@ def field_breaking_changes(
         # logic for normal fields
         elif old_value is None and new_value is not None:
             rule_name = f"field_{_camel_to_snake(field_definition_field)}_added"
-            description = f"added with value: `{str(new_value).lower() if type(new_value) is bool else new_value}`"
+            description = f"added with value: `{str(new_value).lower() if isinstance(new_value, bool) else new_value}`"
 
         elif old_value is not None and new_value is None:
             rule_name = f"field_{_camel_to_snake(field_definition_field)}_removed"
@@ -293,8 +283,10 @@ def field_breaking_changes(
 
         elif old_value != new_value:
             rule_name = f"field_{_camel_to_snake(field_definition_field)}_updated"
-            description = (f"changed from `{str(old_value).lower() if type(old_value) is bool else old_value}` "
-                           f"to `{str(new_value).lower() if type(new_value) is bool else new_value}`")
+            description = (
+                f"changed from `{str(old_value).lower() if isinstance(old_value, bool) else old_value}` "
+                f"to `{str(new_value).lower() if isinstance(new_value, bool) else new_value}`"
+            )
 
         if rule_name is not None:
             severity = _get_rule(rule_name)
@@ -305,10 +297,9 @@ def field_breaking_changes(
                         description=description,
                         check_name=rule_name,
                         severity=severity,
-                        location=Location(
-                            path=new_path,
-                            composition=composition + [field_schema_name]
-                        )))
+                        location=Location(path=new_path, composition=composition + [field_schema_name]),
+                    )
+                )
 
     return results
 
@@ -317,9 +308,9 @@ def _get_rule(rule_name) -> Severity:
     try:
         return getattr(BreakingRules, rule_name)
     except AttributeError:
-        print(f'WARNING: Breaking Rule not found for {rule_name}!')
+        print(f"WARNING: Breaking Rule not found for {rule_name}!")
         return Severity.ERROR
 
 
 def _camel_to_snake(s):
-    return ''.join(['_' + c.lower() if c.isupper() else c for c in s]).lstrip('_')
+    return "".join(["_" + c.lower() if c.isupper() else c for c in s]).lstrip("_")

datacontract/cli.py

@@ -5,7 +5,7 @@ from typing import Iterable, Optional
 import typer
 from click import Context
 from rich import box
-from rich import print
+from rich.console import Console
 from rich.table import Table
 from typer.core import TyperGroup
 from typing_extensions import Annotated
@@ -14,6 +14,8 @@ from datacontract.data_contract import DataContract
 from datacontract.init.download_datacontract_file import \
     download_datacontract_file, FileExistsException
 
+console = Console()
+
 
 class OrderedCommands(TyperGroup):
     def list_commands(self, ctx: Context) -> Iterable[str]:
@@ -29,15 +31,16 @@ app = typer.Typer(
 
 def version_callback(value: bool):
     if value:
-        print(metadata.version("datacontract-cli"))
+        console.print(metadata.version("datacontract-cli"))
         raise typer.Exit()
 
 
 @app.callback()
 def common(
     ctx: typer.Context,
-    version: bool = typer.Option(None, "--version", help="Prints the current version.", callback=version_callback,
-                                 is_eager=True),
+    version: bool = typer.Option(
+        None, "--version", help="Prints the current version.", callback=version_callback, is_eager=True
+    ),
 ):
     """
     The datacontract CLI is an open source command-line tool for working with Data Contracts (https://datacontract.com).
@@ -51,10 +54,12 @@ def common(
 
 @app.command()
 def init(
-    location: Annotated[str, typer.Argument(
-        help="The location (url or path) of the data contract yaml to create.")] = "datacontract.yaml",
-    template: Annotated[str, typer.Option(
-        help="URL of a template or data contract")] = "https://datacontract.com/datacontract.init.yaml",
+    location: Annotated[
+        str, typer.Argument(help="The location (url or path) of the data contract yaml to create.")
+    ] = "datacontract.yaml",
+    template: Annotated[
+        str, typer.Option(help="URL of a template or data contract")
+    ] = "https://datacontract.com/datacontract.init.yaml",
     overwrite: Annotated[bool, typer.Option(help="Replace the existing datacontract.yaml")] = False,
 ):
     """
@@ -63,19 +68,20 @@ def init(
     try:
         download_datacontract_file(location, template, overwrite)
     except FileExistsException:
-        print("File already exists, use --overwrite to overwrite")
+        console.print("File already exists, use --overwrite to overwrite")
         raise typer.Exit(code=1)
     else:
-        print("📄 data contract written to " + location)
+        console.print("📄 data contract written to " + location)
 
 
 @app.command()
 def lint(
     location: Annotated[
-        str, typer.Argument(help="The location (url or path) of the data contract yaml.")] = "datacontract.yaml",
+        str, typer.Argument(help="The location (url or path) of the data contract yaml.")
+    ] = "datacontract.yaml",
     schema: Annotated[
-        str, typer.Option(
-            help="The location (url or path) of the Data Contract Specification JSON Schema")] = "https://datacontract.com/datacontract.schema.json",
+        str, typer.Option(help="The location (url or path) of the Data Contract Specification JSON Schema")
+    ] = "https://datacontract.com/datacontract.schema.json",
 ):
     """
     Validate that the datacontract.yaml is correctly formatted.
@@ -87,37 +93,46 @@ def lint(
 @app.command()
 def test(
     location: Annotated[
-        str, typer.Argument(help="The location (url or path) of the data contract yaml.")] = "datacontract.yaml",
+        str, typer.Argument(help="The location (url or path) of the data contract yaml.")
+    ] = "datacontract.yaml",
     schema: Annotated[
-        str, typer.Option(
-            help="The location (url or path) of the Data Contract Specification JSON Schema")] = "https://datacontract.com/datacontract.schema.json",
-    server: Annotated[str, typer.Option(
-        help="The server configuration to run the schema and quality tests. "
-             "Use the key of the server object in the data contract yaml file "
-             "to refer to a server, e.g., `production`, or `all` for all "
-             "servers (default).")] = "all",
-    examples: Annotated[bool, typer.Option(
-        help="Run the schema and quality tests on the example data within the data contract.")] = None,
-    publish: Annotated[str, typer.Option(
-        help="The url to publish the results after the test")] = None,
-    publish_to_opentelemetry: Annotated[bool, typer.Option(
-        help="Publish the results to opentelemetry. Use environment variables to configure the OTLP endpoint, headers, etc.")] = False,
-    logs: Annotated[bool, typer.Option(
-        help="Print logs")] = False,
+        str, typer.Option(help="The location (url or path) of the Data Contract Specification JSON Schema")
+    ] = "https://datacontract.com/datacontract.schema.json",
+    server: Annotated[
+        str,
+        typer.Option(
+            help="The server configuration to run the schema and quality tests. "
+            "Use the key of the server object in the data contract yaml file "
+            "to refer to a server, e.g., `production`, or `all` for all "
+            "servers (default)."
+        ),
+    ] = "all",
+    examples: Annotated[
+        bool, typer.Option(help="Run the schema and quality tests on the example data within the data contract.")
+    ] = None,
+    publish: Annotated[str, typer.Option(help="The url to publish the results after the test")] = None,
+    publish_to_opentelemetry: Annotated[
+        bool,
+        typer.Option(
+            help="Publish the results to opentelemetry. Use environment variables to configure the OTLP endpoint, headers, etc."
+        ),
+    ] = False,
+    logs: Annotated[bool, typer.Option(help="Print logs")] = False,
 ):
     """
     Run schema and quality tests on configured servers.
     """
-    print(f"Testing {location}")
+    console.print(f"Testing {location}")
     if server == "all":
         server = None
-    run = DataContract(data_contract_file=location,
-                       schema_location=schema,
-                       publish_url=publish,
-                       publish_to_opentelemetry=publish_to_opentelemetry,
-                       server=server,
-                       examples=examples,
-                       ).test()
+    run = DataContract(
+        data_contract_file=location,
+        schema_location=schema,
+        publish_url=publish,
+        publish_to_opentelemetry=publish_to_opentelemetry,
+        server=server,
+        examples=examples,
+    ).test()
     if logs:
         _print_logs(run)
     _handle_result(run)
@@ -125,6 +140,7 @@ def test(
 
 class ExportFormat(str, Enum):
     jsonschema = "jsonschema"
+    pydantic_model = "pydantic-model"
     sodacl = "sodacl"
     dbt = "dbt"
     dbt_sources = "dbt-sources"
@@ -133,26 +149,43 @@ class ExportFormat(str, Enum):
     rdf = "rdf"
     avro = "avro"
     protobuf = "protobuf"
+    great_expectations = "great-expectations"
     terraform = "terraform"
     avro_idl = "avro-idl"
     sql = "sql"
     sql_query = "sql-query"
+    html = "html"
 
 
 @app.command()
 def export(
     format: Annotated[ExportFormat, typer.Option(help="The export format.")],
     server: Annotated[str, typer.Option(help="The server name to export.")] = None,
-    model: Annotated[str, typer.Option(help="Use the key of the model in the data contract yaml file "
-                                            "to refer to a model, e.g., `orders`, or `all` for all "
-                                            "models (default).")] = "all",
-    rdf_base: Annotated[Optional[str], typer.Option(help="[rdf] The base URI used to generate the RDF graph.", rich_help_panel="RDF Options")] = None,
-    sql_server_type: Annotated[Optional[str], typer.Option(help="[sql] The server type to determine the sql dialect. By default, it uses 'auto' to automatically detect the sql dialect via the specified servers in the data contract.", rich_help_panel="SQL Options")] = "auto",
+    model: Annotated[
+        str,
+        typer.Option(
+            help="Use the key of the model in the data contract yaml file "
+            "to refer to a model, e.g., `orders`, or `all` for all "
+            "models (default)."
+        ),
+    ] = "all",
+    rdf_base: Annotated[
+        Optional[str],
+        typer.Option(help="[rdf] The base URI used to generate the RDF graph.", rich_help_panel="RDF Options"),
+    ] = None,
+    sql_server_type: Annotated[
+        Optional[str],
+        typer.Option(
+            help="[sql] The server type to determine the sql dialect. By default, it uses 'auto' to automatically detect the sql dialect via the specified servers in the data contract.",
+            rich_help_panel="SQL Options",
+        ),
+    ] = "auto",
     location: Annotated[
-        str, typer.Argument(help="The location (url or path) of the data contract yaml.")] = "datacontract.yaml",
+        str, typer.Argument(help="The location (url or path) of the data contract yaml.")
+    ] = "datacontract.yaml",
 ):
     """
-    Convert data contract to a specific format. Prints to stdout.
+    Convert data contract to a specific format. console.prints to stdout.
     """
     # TODO exception handling
     result = DataContract(data_contract_file=location, server=server).export(
@@ -161,7 +194,8 @@ def export(
         rdf_base=rdf_base,
         sql_server_type=sql_server_type,
     )
-    print(result)
+    # Don't interpret console markup in output.
+    console.print(result, markup=False)
 
 
 class ImportFormat(str, Enum):
@@ -178,7 +212,7 @@ def import_(
     Create a data contract from the given source file. Prints to stdout.
     """
     result = DataContract().import_from_source(format, source)
-    print(result.to_yaml())
+    console.print(result.to_yaml())
 
 
 @app.command()
@@ -191,16 +225,11 @@ def breaking(
     """
 
     # TODO exception handling
-    result = DataContract(
-        data_contract_file=location_old,
-        inline_definitions=True
-    ).breaking(
-        DataContract(
-            data_contract_file=location_new,
-            inline_definitions=True
-        ))
+    result = DataContract(data_contract_file=location_old, inline_definitions=True).breaking(
+        DataContract(data_contract_file=location_new, inline_definitions=True)
+    )
 
-    print(result.breaking_str())
+    console.print(result.breaking_str())
 
     if not result.passed_checks():
         raise typer.Exit(code=1)
@@ -216,16 +245,11 @@ def changelog(
     """
 
     # TODO exception handling
-    result = DataContract(
-        data_contract_file=location_old,
-        inline_definitions=True
-    ).changelog(
-        DataContract(
-            data_contract_file=location_new,
-            inline_definitions=True
-        ))
+    result = DataContract(data_contract_file=location_old, inline_definitions=True).changelog(
+        DataContract(data_contract_file=location_new, inline_definitions=True)
+    )
 
-    print(result.changelog_str())
+    console.print(result.changelog_str())
 
 
 @app.command()
@@ -238,29 +262,25 @@ def diff(
     """
 
     # TODO change to diff output, not the changelog entries
-    result = DataContract(
-        data_contract_file=location_old,
-        inline_definitions=True
-    ).changelog(
-        DataContract(
-            data_contract_file=location_new,
-            inline_definitions=True
-        ))
+    result = DataContract(data_contract_file=location_old, inline_definitions=True).changelog(
+        DataContract(data_contract_file=location_new, inline_definitions=True)
+    )
 
-    print(result.changelog_str())
+    console.print(result.changelog_str())
 
 
 def _handle_result(run):
     _print_table(run)
     if run.result == "passed":
-        print(
-            f"🟢 data contract is valid. Run {len(run.checks)} checks. Took {(run.timestampEnd - run.timestampStart).total_seconds()} seconds.")
+        console.print(
+            f"🟢 data contract is valid. Run {len(run.checks)} checks. Took {(run.timestampEnd - run.timestampStart).total_seconds()} seconds."
+        )
     else:
-        print("🔴 data contract is invalid, found the following errors:")
+        console.print("🔴 data contract is invalid, found the following errors:")
         i = 1
         for check in run.checks:
             if check.result != "passed":
-                print(str(++i) + ") " + check.reason)
+                console.print(str(++i) + ") " + check.reason)
         raise typer.Exit(code=1)
 
 
@@ -272,7 +292,7 @@ def _print_table(run):
     table.add_column("Details", max_width=50)
     for check in run.checks:
         table.add_row(with_markup(check.result), check.name, to_field(run, check), check.reason)
-    print(table)
+    console.print(table)
 
 
 def to_field(run, check):
@@ -286,9 +306,9 @@ def to_field(run, check):
 
 
 def _print_logs(run):
-    print("\nLogs:")
+    console.print("\nLogs:")
     for log in run.logs:
-        print(log.timestamp.strftime("%y-%m-%d %H:%M:%S"), log.level.ljust(5), log.message)
+        console.print(log.timestamp.strftime("%y-%m-%d %H:%M:%S"), log.level.ljust(5), log.message)
 
 
 def with_markup(result):