API checks¤

Bases: str, Enum

              flowchart TD
              griffe.ExplanationStyle[ExplanationStyle]

              

              click griffe.ExplanationStyle href "" "griffe.ExplanationStyle"
            

Enumeration of the possible styles for explanations.

Attributes:

• GITHUB –

  Explanation as GitHub workflow commands warnings, adapted to CI.

• MARKDOWN –

  Explanations in Markdown, adapted to changelogs.

• ONE_LINE –

  Explanations on one-line.

• VERBOSE –

  Explanations on multiple lines.

GITHUB = 'github'

MARKDOWN = 'markdown'

ONE_LINE = 'oneline'

VERBOSE = 'verbose'

Breakages can explain what broke from a version to another.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: str, Enum

              flowchart TD
              griffe.BreakageKind[BreakageKind]

              

              click griffe.BreakageKind href "" "griffe.BreakageKind"
            

Enumeration of the possible API breakages.

Attributes:

• ATTRIBUTE_CHANGED_TYPE –

  Attribute types are incompatible

• ATTRIBUTE_CHANGED_VALUE –

  Attribute value was changed

• CLASS_REMOVED_BASE –

  Base class was removed

• OBJECT_CHANGED_KIND –

  Public object points to a different kind of object

• OBJECT_REMOVED –

  Public object was removed

• PARAMETER_ADDED_REQUIRED –

  Parameter was added as required

• PARAMETER_CHANGED_DEFAULT –

  Parameter default was changed

• PARAMETER_CHANGED_KIND –

  Parameter kind was changed

• PARAMETER_CHANGED_REQUIRED –

  Parameter is now required

• PARAMETER_MOVED –

  Positional parameter was moved

• PARAMETER_REMOVED –

  Parameter was removed

• RETURN_CHANGED_TYPE –

  Return types are incompatible

ATTRIBUTE_CHANGED_TYPE = 'Attribute types are incompatible'

ATTRIBUTE_CHANGED_VALUE = 'Attribute value was changed'

CLASS_REMOVED_BASE = 'Base class was removed'

OBJECT_CHANGED_KIND = (
    "Public object points to a different kind of object"
)

OBJECT_REMOVED = 'Public object was removed'

PARAMETER_ADDED_REQUIRED = "Parameter was added as required"

PARAMETER_CHANGED_DEFAULT = 'Parameter default was changed'

PARAMETER_CHANGED_KIND = 'Parameter kind was changed'

PARAMETER_CHANGED_REQUIRED = 'Parameter is now required'

PARAMETER_MOVED = 'Positional parameter was moved'

PARAMETER_REMOVED = 'Parameter was removed'

RETURN_CHANGED_TYPE = 'Return types are incompatible'

Bases: Breakage

              flowchart TD
              griffe.AttributeChangedTypeBreakage[AttributeChangedTypeBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.AttributeChangedTypeBreakage
                


              click griffe.AttributeChangedTypeBreakage href "" "griffe.AttributeChangedTypeBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for attributes whose type changed.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = ATTRIBUTE_CHANGED_TYPE

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.AttributeChangedValueBreakage[AttributeChangedValueBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.AttributeChangedValueBreakage
                


              click griffe.AttributeChangedValueBreakage href "" "griffe.AttributeChangedValueBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for attributes whose value changed.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = ATTRIBUTE_CHANGED_VALUE

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ClassRemovedBaseBreakage[ClassRemovedBaseBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ClassRemovedBaseBreakage
                


              click griffe.ClassRemovedBaseBreakage href "" "griffe.ClassRemovedBaseBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for removed base classes.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = CLASS_REMOVED_BASE

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ObjectChangedKindBreakage[ObjectChangedKindBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ObjectChangedKindBreakage
                


              click griffe.ObjectChangedKindBreakage href "" "griffe.ObjectChangedKindBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for objects whose kind changed.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = OBJECT_CHANGED_KIND

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ObjectRemovedBreakage[ObjectRemovedBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ObjectRemovedBreakage
                


              click griffe.ObjectRemovedBreakage href "" "griffe.ObjectRemovedBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for removed objects.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = OBJECT_REMOVED

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ParameterAddedRequiredBreakage[ParameterAddedRequiredBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ParameterAddedRequiredBreakage
                


              click griffe.ParameterAddedRequiredBreakage href "" "griffe.ParameterAddedRequiredBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for new parameters added as required.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = PARAMETER_ADDED_REQUIRED

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ParameterChangedDefaultBreakage[ParameterChangedDefaultBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ParameterChangedDefaultBreakage
                


              click griffe.ParameterChangedDefaultBreakage href "" "griffe.ParameterChangedDefaultBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for parameters whose default value changed.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = PARAMETER_CHANGED_DEFAULT

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ParameterChangedKindBreakage[ParameterChangedKindBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ParameterChangedKindBreakage
                


              click griffe.ParameterChangedKindBreakage href "" "griffe.ParameterChangedKindBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for parameters whose kind changed.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = PARAMETER_CHANGED_KIND

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ParameterChangedRequiredBreakage[ParameterChangedRequiredBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ParameterChangedRequiredBreakage
                


              click griffe.ParameterChangedRequiredBreakage href "" "griffe.ParameterChangedRequiredBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for parameters which became required.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = PARAMETER_CHANGED_REQUIRED

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()

Bases: Breakage

              flowchart TD
              griffe.ParameterMovedBreakage[ParameterMovedBreakage]
              griffe._internal.diff.Breakage[Breakage]

                              griffe._internal.diff.Breakage --> griffe.ParameterMovedBreakage
                


              click griffe.ParameterMovedBreakage href "" "griffe.ParameterMovedBreakage"
              click griffe._internal.diff.Breakage href "" "griffe._internal.diff.Breakage"
            

Specific breakage class for moved parameters.

Parameters:

• obj ¤

  (Object) –

  The object related to the breakage.

• old_value ¤

  (Any) –

  The old value.

• new_value ¤

  (Any) –

  The new, incompatible value.

• details ¤

  (str, default: '' ) –

  Some details about the breakage.

Methods:

• as_dict –

  Return this object's data as a dictionary.

• explain –

  Explain the breakage by showing old and new value.

Attributes:

• details –

  Some details about the breakage.

• kind (BreakageKind) –

  The kind of breakage.

• new_value –

  The new, incompatible value.

• obj –

  The object related to the breakage.

• old_value –

  The old value.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

def __init__(self, obj: Object, old_value: Any, new_value: Any, details: str = "") -> None:
    """Initialize the breakage.

    Parameters:
        obj: The object related to the breakage.
        old_value: The old value.
        new_value: The new, incompatible value.
        details: Some details about the breakage.
    """
    self.obj = obj
    """The object related to the breakage."""
    self.old_value = old_value
    """The old value."""
    self.new_value = new_value
    """The new, incompatible value."""
    self.details = details
    """Some details about the breakage."""

details = details

kind: BreakageKind = PARAMETER_MOVED

new_value = new_value

obj = obj

old_value = old_value

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:  # noqa: ARG002
    """Return this object's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    return {
        "kind": self.kind,
        "object_path": self.obj.path,
        "old_value": self.old_value,
        "new_value": self.new_value,
    }

explain(style: ExplanationStyle = ONE_LINE) -> str

120
121
122
123
124
125
126
127
128
129

def explain(self, style: ExplanationStyle = ExplanationStyle.ONE_LINE) -> str:
    """Explain the breakage by showing old and new value.

    Parameters:
        style: The explanation style to use.

    Returns:
        An explanation.
    """
    return getattr(self, f"_explain_{style.value}")()