5.3.1. decomposers.base — Base classes for decomposers

class plmapp.decomposers.base.DecomposersManager

Bases: object

The DecomposersManager has methods to register a Decomposer (a class helping to decompose a part) and to get a decomposition message that is displayed on the BOM page of a part.

classmethod register(decomposer)

Registers decomposer.

classmethod count()

Returns the number of registered decomposers.

classmethod get_decomposition_message(part)

Returns a decomposition message to decompose part.

Returns an empty string if no decomposer can decompose part.

classmethod is_decomposable(part, msg=False)

Returns True if part is decomposable.

classmethod get_decomposable_parts(part_ids)

Returns all part of part_ids (an iterable of part ids) that are decomposable by the registered decomposers.

class plmapp.decomposers.base.Decomposer(part)

Bases: object

Interface of a decomposer. A decomposer is initialized with a part and has two methods: is_decomposable() and get_message()

The default constructor sets the part attribute with the given part.

is_decomposable(msg=True)

Returns True if the part is decomposable.

get_message()

Returns a message (in html) that is displayed if the part is decomposable.

The returned message should contains a link to decompose the part and should be explicit.

get_decomposable_parts(part_ids)

Returns all part of part_ids (an iterable of part ids) that are decomposable by this decomposer.