Skip to content

API checks¤

find_breaking_changes ¤

find_breaking_changes(
    old_obj: Object | Alias, new_obj: Object | Alias
) -> Iterator[Breakage]

Find breaking changes between two versions of the same API.

The function will iterate recursively on all objects and yield breaking changes with detailed information.

Parameters:

Yields:

Examples:

>>> import sys, griffe
>>> new = griffe.load("pkg")
>>> old = griffe.load_git("pkg", "1.2.3")
>>> for breakage in griffe.find_breaking_changes(old, new)
...     print(breakage.explain(style=style), file=sys.stderr)
Referenced by:

ExplanationStyle ¤

Bases: str, Enum


              flowchart TD
              griffe.ExplanationStyle[ExplanationStyle]

              

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

Enumeration of the possible styles for explanations.

Used by:

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 class-attribute instance-attribute ¤

GITHUB = 'github'

Explanation as GitHub workflow commands warnings, adapted to CI.

MARKDOWN class-attribute instance-attribute ¤

MARKDOWN = 'markdown'

Explanations in Markdown, adapted to changelogs.

ONE_LINE class-attribute instance-attribute ¤

ONE_LINE = 'oneline'

Explanations on one-line.

Used by:

VERBOSE class-attribute instance-attribute ¤

VERBOSE = 'verbose'

Explanations on multiple lines.

Breakage ¤

Breakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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.

Referenced by: Returned by: Subclassed by: Yielded by:

Methods:

  • as_dict –

    Return this object's data as a dictionary.

  • explain –

    Explain the breakage by showing old and new value.

Attributes:

details instance-attribute ¤

details = details

Some details about the breakage.

kind instance-attribute ¤

kind: BreakageKind

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

BreakageKind ¤

Bases: str, Enum


              flowchart TD
              griffe.BreakageKind[BreakageKind]

              

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

Enumeration of the possible API breakages.

Returned by:

Attributes:

ATTRIBUTE_CHANGED_TYPE class-attribute instance-attribute ¤

ATTRIBUTE_CHANGED_TYPE = 'Attribute types are incompatible'

Attribute types are incompatible

Used by:

ATTRIBUTE_CHANGED_VALUE class-attribute instance-attribute ¤

ATTRIBUTE_CHANGED_VALUE = 'Attribute value was changed'

Attribute value was changed

Used by:

CLASS_REMOVED_BASE class-attribute instance-attribute ¤

CLASS_REMOVED_BASE = 'Base class was removed'

Base class was removed

Used by:

OBJECT_CHANGED_KIND class-attribute instance-attribute ¤

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

Public object points to a different kind of object

Used by:

OBJECT_REMOVED class-attribute instance-attribute ¤

OBJECT_REMOVED = 'Public object was removed'

Public object was removed

Used by:

PARAMETER_ADDED_REQUIRED class-attribute instance-attribute ¤

PARAMETER_ADDED_REQUIRED = "Parameter was added as required"

Parameter was added as required

Used by:

PARAMETER_CHANGED_DEFAULT class-attribute instance-attribute ¤

PARAMETER_CHANGED_DEFAULT = 'Parameter default was changed'

Parameter default was changed

Used by:

PARAMETER_CHANGED_KIND class-attribute instance-attribute ¤

PARAMETER_CHANGED_KIND = 'Parameter kind was changed'

Parameter kind was changed

Used by:

PARAMETER_CHANGED_REQUIRED class-attribute instance-attribute ¤

PARAMETER_CHANGED_REQUIRED = 'Parameter is now required'

Parameter is now required

Used by:

PARAMETER_MOVED class-attribute instance-attribute ¤

PARAMETER_MOVED = 'Positional parameter was moved'

Positional parameter was moved

Used by:

PARAMETER_REMOVED class-attribute instance-attribute ¤

PARAMETER_REMOVED = 'Parameter was removed'

Parameter was removed

Used by:

RETURN_CHANGED_TYPE class-attribute instance-attribute ¤

RETURN_CHANGED_TYPE = 'Return types are incompatible'

Return types are incompatible

Used by:

AttributeChangedTypeBreakage ¤

AttributeChangedTypeBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = ATTRIBUTE_CHANGED_TYPE

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

AttributeChangedValueBreakage ¤

AttributeChangedValueBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = ATTRIBUTE_CHANGED_VALUE

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ClassRemovedBaseBreakage ¤

ClassRemovedBaseBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = CLASS_REMOVED_BASE

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ObjectChangedKindBreakage ¤

ObjectChangedKindBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = OBJECT_CHANGED_KIND

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ObjectRemovedBreakage ¤

ObjectRemovedBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = OBJECT_REMOVED

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterAddedRequiredBreakage ¤

ParameterAddedRequiredBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_ADDED_REQUIRED

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterChangedDefaultBreakage ¤

ParameterChangedDefaultBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_CHANGED_DEFAULT

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterChangedKindBreakage ¤

ParameterChangedKindBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_CHANGED_KIND

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterChangedRequiredBreakage ¤

ParameterChangedRequiredBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_CHANGED_REQUIRED

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterMovedBreakage ¤

ParameterMovedBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_MOVED

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ParameterRemovedBreakage ¤

ParameterRemovedBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

Bases: Breakage


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

                              griffe._internal.diff.Breakage --> griffe.ParameterRemovedBreakage
                


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

Specific breakage class for removed 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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = PARAMETER_REMOVED

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.

ReturnChangedTypeBreakage ¤

ReturnChangedTypeBreakage(
    obj: Object,
    old_value: Any,
    new_value: Any,
    details: str = "",
)

Bases: Breakage


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

                              griffe._internal.diff.Breakage --> griffe.ReturnChangedTypeBreakage
                


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

Specific breakage class for return values which changed type.

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 instance-attribute ¤

details = details

Some details about the breakage.

kind class-attribute instance-attribute ¤

kind: BreakageKind = RETURN_CHANGED_TYPE

The kind of breakage.

new_value instance-attribute ¤

new_value = new_value

The new, incompatible value.

obj instance-attribute ¤

obj = obj

The object related to the breakage.

old_value instance-attribute ¤

old_value = old_value

The old value.

as_dict ¤

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

Return this object's data as a dictionary.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

explain ¤

explain(style: ExplanationStyle = ONE_LINE) -> str

Explain the breakage by showing old and new value.

Parameters:

Returns:

  • str –

    An explanation.