Module `schemadiff.changes.interface`

Expand source code

from schemadiff.changes import Change, Criticality


class InterfaceFieldAdded(Change):

    criticality = Criticality.dangerous(
        "Adding an interface to an object type may break existing clients "
        "that were not programming defensively against a new possible type."
    )

    def __init__(self, interface, field_name, field):
        self.interface = interface
        self.field_name = field_name
        self.field = field

    @property
    def message(self):
        return f"Field `{self.field_name}` of type `{self.field.type}` was added to interface `{self.interface}`"

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"


class InterfaceFieldRemoved(Change):

    criticality = Criticality.dangerous(
        "Removing an interface field can break existing "
        "queries that use this in a fragment spread."
    )

    def __init__(self, interface, field_name):
        self.interface = interface
        self.field_name = field_name

    @property
    def message(self):
        return f"Field `{self.field_name}` was removed from interface `{self.interface}`"

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"


class AbstractInterfanceChange(Change):
    def __init__(self, interface, field_name, old_field, new_field):
        self.interface = interface
        self.field_name = field_name
        self.old_field = old_field
        self.new_field = new_field

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"


class InterfaceFieldTypeChanged(AbstractInterfanceChange):

    @property
    def message(self):
        return (
            f"Field `{self.interface.name}.{self.field_name}` type "
            f"changed from `{self.old_field.type}` to `{self.new_field.type}`"
        )


class NewInterfaceImplemented(Change):

    criticality = Criticality.dangerous(
        "Adding an interface to an object type may break existing clients "
        "that were not programming defensively against a new possible type."
    )

    def __init__(self, interface, type_):
        self.interface = interface
        self.type_ = type_

    @property
    def message(self):
        return f"`{self.type_.name}` implements new interface `{self.interface.name}`"

    @property
    def path(self):
        return f"{self.type_}"


class DroppedInterfaceImplementation(Change):

    criticality = Criticality.breaking(
        "Removing an interface from an object type can break existing queries "
        "that use this in a fragment spread."
    )

    def __init__(self, interface, type_):
        self.interface = interface
        self.type_ = type_

    @property
    def message(self):
        return f"`{self.type_.name}` no longer implements interface `{self.interface.name}`"

    @property
    def path(self):
        return f"{self.type_}"


class InterfaceFieldDescriptionChanged(AbstractInterfanceChange):
    criticality = Criticality.safe()

    @property
    def message(self):
        return (
            f"`{self.interface.name}.{self.field_name}` description changed "
            f"from `{self.old_field.description}` to `{self.new_field.description}`"
        )


class InterfaceFieldDeprecationReasonChanged(AbstractInterfanceChange):
    criticality = Criticality.breaking('Breaking change')  # TODO: Improve this logic to check if it was deprecated before

    @property
    def message(self):
        return (
            f"`{self.interface.name}.{self.field_name}` deprecation reason changed "
            f"from `{self.old_field.deprecation_reason}` to `{self.new_field.deprecation_reason}`"
        )

Classes

class AbstractInterfanceChange (interface, field_name, old_field, new_field)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class AbstractInterfanceChange(Change):
    def __init__(self, interface, field_name, old_field, new_field):
        self.interface = interface
        self.field_name = field_name
        self.old_field = old_field
        self.new_field = new_field

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"

Ancestors

Change
abc.ABC

Inherited members

Change:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class DroppedInterfaceImplementation (interface, type_)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class DroppedInterfaceImplementation(Change):

    criticality = Criticality.breaking(
        "Removing an interface from an object type can break existing queries "
        "that use this in a fragment spread."
    )

    def __init__(self, interface, type_):
        self.interface = interface
        self.type_ = type_

    @property
    def message(self):
        return f"`{self.type_.name}` no longer implements interface `{self.interface.name}`"

    @property
    def path(self):
        return f"{self.type_}"

Ancestors

Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

Change:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class InterfaceFieldAdded (interface, field_name, field)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class InterfaceFieldAdded(Change):

    criticality = Criticality.dangerous(
        "Adding an interface to an object type may break existing clients "
        "that were not programming defensively against a new possible type."
    )

    def __init__(self, interface, field_name, field):
        self.interface = interface
        self.field_name = field_name
        self.field = field

    @property
    def message(self):
        return f"Field `{self.field_name}` of type `{self.field.type}` was added to interface `{self.interface}`"

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"

Ancestors

Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

Change:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class InterfaceFieldDeprecationReasonChanged (interface, field_name, old_field, new_field)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class InterfaceFieldDeprecationReasonChanged(AbstractInterfanceChange):
    criticality = Criticality.breaking('Breaking change')  # TODO: Improve this logic to check if it was deprecated before

    @property
    def message(self):
        return (
            f"`{self.interface.name}.{self.field_name}` deprecation reason changed "
            f"from `{self.old_field.deprecation_reason}` to `{self.new_field.deprecation_reason}`"
        )

Ancestors

AbstractInterfanceChange
Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

AbstractInterfanceChange:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class InterfaceFieldDescriptionChanged (interface, field_name, old_field, new_field)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class InterfaceFieldDescriptionChanged(AbstractInterfanceChange):
    criticality = Criticality.safe()

    @property
    def message(self):
        return (
            f"`{self.interface.name}.{self.field_name}` description changed "
            f"from `{self.old_field.description}` to `{self.new_field.description}`"
        )

Ancestors

AbstractInterfanceChange
Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

AbstractInterfanceChange:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class InterfaceFieldRemoved (interface, field_name)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class InterfaceFieldRemoved(Change):

    criticality = Criticality.dangerous(
        "Removing an interface field can break existing "
        "queries that use this in a fragment spread."
    )

    def __init__(self, interface, field_name):
        self.interface = interface
        self.field_name = field_name

    @property
    def message(self):
        return f"Field `{self.field_name}` was removed from interface `{self.interface}`"

    @property
    def path(self):
        return f"{self.interface.name}.{self.field_name}"

Ancestors

Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

Change:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class InterfaceFieldTypeChanged (interface, field_name, old_field, new_field)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class InterfaceFieldTypeChanged(AbstractInterfanceChange):

    @property
    def message(self):
        return (
            f"Field `{self.interface.name}.{self.field_name}` type "
            f"changed from `{self.old_field.type}` to `{self.new_field.type}`"
        )

Ancestors

AbstractInterfanceChange
Change
abc.ABC

Inherited members

AbstractInterfanceChange:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json

class NewInterfaceImplemented (interface, type_)

Common interface of all schema changes

This class offers the common operations and properties of all schema changes. You may use it as a type hint to get better suggestions in your editor of choice.

Expand source code

class NewInterfaceImplemented(Change):

    criticality = Criticality.dangerous(
        "Adding an interface to an object type may break existing clients "
        "that were not programming defensively against a new possible type."
    )

    def __init__(self, interface, type_):
        self.interface = interface
        self.type_ = type_

    @property
    def message(self):
        return f"`{self.type_.name}` implements new interface `{self.interface.name}`"

    @property
    def path(self):
        return f"{self.type_}"

Ancestors

Change
abc.ABC

Class variables

var criticality : Criticality

Inherited members

Change:
- breaking
- checksum
- dangerous
- message
- path
- restricted
- safe
- to_dict
- to_json