Functions

List of functions in the ude.api_diff namespace.

Entity Name	Description
_get_class_signature	Signature for a class: its base classes and interfaces.
_get_method_signature	Signature for a method: its primary signature plus overloads.
_get_variable_signature	Signature for a variable: its type.
_get_constant_signature	Signature for a constant: its type.
_get_enum_signature	Signature for an enum: its sorted values.
_get_type_alias_signature	Signature for a type alias: its aliased type.
_extract_public_entities
diff_catalogs	Compares an old catalog with a new catalog and reports public API drift.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_extract_public_entities function

Returns a dict mapping fully qualified name -> (signature, entity_type, file, line). Only public entities are included.

Methods

_extract_public_entities

_extract_public_entities(catalog: ProjectCatalog) -> Dict[str, Tuple[str, str, Optional[str], Optional[int]]]

Returns a dict mapping fully qualified name -> (signature, entity_type, file, line). Only public entities are included.

Parameter	Type	Description
catalog	`ProjectCatalog`

Generated with Flude

_get_class_signature function

Signature for a class: its base classes and interfaces.

Methods

_get_class_signature

_get_class_signature(cls_model: ClassModel) -> str

Signature for a class: its base classes and interfaces.

Parameter	Type	Description
cls_model	`ClassModel`

Generated with Flude

_get_constant_signature function

Signature for a constant: its type.

Methods

_get_constant_signature

_get_constant_signature(const: ConstantModel const) -> str

Signature for a constant: its type.

Parameter	Type	Description
const	`ConstantModel const`

Generated with Flude

_get_enum_signature function

Signature for an enum: its sorted values.

Methods

_get_enum_signature

_get_enum_signature(enum: EnumModel) -> str

Signature for an enum: its sorted values.

Parameter	Type	Description
enum	`EnumModel`

Generated with Flude

_get_method_signature function

Signature for a method: its primary signature plus overloads.

Methods

_get_method_signature

_get_method_signature(method: MethodModel) -> str

Signature for a method: its primary signature plus overloads.

Parameter	Type	Description
method	`MethodModel`

Generated with Flude

_get_type_alias_signature function

Signature for a type alias: its aliased type.

Methods

_get_type_alias_signature

_get_type_alias_signature(alias: TypeAliasModel) -> str

Signature for a type alias: its aliased type.

Parameter	Type	Description
alias	`TypeAliasModel`

Generated with Flude

_get_variable_signature function

Signature for a variable: its type.

Methods

_get_variable_signature

_get_variable_signature(var: VariableModel) -> str

Signature for a variable: its type.

Parameter	Type	Description
var	`VariableModel`

Generated with Flude

diff_catalogs function

Compares an old catalog with a new catalog and reports public API drift.

Returns:

A list of Findings representing added, removed, and changed public APIs.

Methods

diff_catalogs

diff_catalogs(old: Optional, new: ProjectCatalog) -> List[Finding]

Compares an old catalog with a new catalog and reports public API drift.

Returns:

A list of Findings representing added, removed, and changed public APIs.

Parameter	Type	Description
old	`Optional`	The previous ProjectCatalog baseline, or None if no baseline exists.
new	`ProjectCatalog`	The current ProjectCatalog to compare against.

Generated with Flude