src.module1

Module1 - the first module

Module Contents

Functions

first_function(kind=None)	Return a list of random ingredients as strings.
get_random_ingredients(kind=None)	Return a list of random ingredients as strings.
another_function(kind=None, arg2=None)	Return a list of random ingredients as strings.

Attributes

__version__

src.module1.__version__ = 0.1.0

exception src.module1.InvalidKindError

Bases: Exception

Raised if the kind is invalid.

src.module1.first_function(kind=None)

Return a list of random ingredients as strings.

Parameters

kind (list[str] or None) – Optional “kind” of ingredients.

Raises

lumache.InvalidKindError – If the kind is invalid.

Returns

The ingredients list.

Return type

list[str]

src.module1.get_random_ingredients(kind=None)

Return a list of random ingredients as strings. :param kind: Optional “kind” of ingredients. :type kind: list[str] or None :raise lumache.InvalidKindError: If the kind is invalid. :return: The ingredients list. :rtype: list[str]

src.module1.another_function(kind=None, arg2=None)

Return a list of random ingredients as strings.

Parameters

• kind (list[str] or None) – Optional “kind” of ingredients.

• arg2 – Optional.

Returns

The ingredients list.

Return type

list[str]