Module `schemadiff.formatting`

Expand source code

import json
import os
from typing import List

from schemadiff.changes import CriticalityLevel, Change


def format_diff(changes: List[Change]) -> str:
    """Format a list of changes into a printable string"""
    changes = '\n'.join(
        format_change_by_criticality(change)
        for change in changes
    )
    return changes or '🎉 Both schemas are equal!'


def format_change_by_criticality(change: Change) -> str:
    icon_by_criticality = {
        CriticalityLevel.Breaking: os.getenv('SD_BREAKING_CHANGE_ICON', '❌'),
        CriticalityLevel.Dangerous: os.getenv('SD_DANGEROUS_CHANGE_ICON', '⚠️'),
        CriticalityLevel.NonBreaking: os.getenv('SD_SAFE_CHANGE_ICON', '✔️'),
    }
    icon = icon_by_criticality[change.criticality.level]
    if change.restricted is not None:
        return f"⛔ {change.restricted}"
    return f"{icon} {change.message}"


def print_diff(changes: List[Change]) -> None:
    """Pretty print a list of changes"""
    print(format_diff(changes))


def changes_to_dict(changes: List[Change]) -> List[dict]:
    return [
        change.to_dict()
        for change in changes
    ]


def json_dump_changes(changes: List[Change]) -> str:
    return json.dumps(changes_to_dict(changes), indent=4)


def print_json(changes: List[Change]) -> None:
    print(json_dump_changes(changes))

Functions

def changes_to_dict(changes: List[Change]) ‑> List[dict]

Expand source code

def changes_to_dict(changes: List[Change]) -> List[dict]:
    return [
        change.to_dict()
        for change in changes
    ]

def format_change_by_criticality(change: Change) ‑> str

Expand source code

def format_change_by_criticality(change: Change) -> str:
    icon_by_criticality = {
        CriticalityLevel.Breaking: os.getenv('SD_BREAKING_CHANGE_ICON', '❌'),
        CriticalityLevel.Dangerous: os.getenv('SD_DANGEROUS_CHANGE_ICON', '⚠️'),
        CriticalityLevel.NonBreaking: os.getenv('SD_SAFE_CHANGE_ICON', '✔️'),
    }
    icon = icon_by_criticality[change.criticality.level]
    if change.restricted is not None:
        return f"⛔ {change.restricted}"
    return f"{icon} {change.message}"

def format_diff(changes: List[Change]) ‑> str

Format a list of changes into a printable string

Expand source code

def format_diff(changes: List[Change]) -> str:
    """Format a list of changes into a printable string"""
    changes = '\n'.join(
        format_change_by_criticality(change)
        for change in changes
    )
    return changes or '🎉 Both schemas are equal!'

def json_dump_changes(changes: List[Change]) ‑> str

Expand source code

def json_dump_changes(changes: List[Change]) -> str:
    return json.dumps(changes_to_dict(changes), indent=4)

def print_diff(changes: List[Change]) ‑> NoneType

Pretty print a list of changes

Expand source code

def print_diff(changes: List[Change]) -> None:
    """Pretty print a list of changes"""
    print(format_diff(changes))

def print_json(changes: List[Change]) ‑> NoneType

Expand source code

def print_json(changes: List[Change]) -> None:
    print(json_dump_changes(changes))