Adding Functionality to Packages

Software Engineering Principles in Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Package structure

Package Structure

Adding functionality

working in work_dir/my_package/utils.py

def we_need_to_talk(break_up=False):
    """Helper for communicating with significant other"""
    if break_up:
        print("It's not you, it's me...")
    else:
        print('I <3 U!')

working in work_dir/my_script.py

# Import utils submodule
import my_package.utils

# Decide to start seeing other people
my_package.utils.we_need_to_talk(break_up=True)

It's not you, it's me...

Importing functionality with init.py

working in work_dir/my_package/__init__.py

from .utils import we_need_to_talk

working in work_dir/my_script.py

# Import custom package
import my_package

# Realize you're with your soulmate
my_package.we_need_to_talk(break_up=False)

I <3 U!

Extending package structure

Extended Package Structure

Extending package structure

SubPackage Structure

Let's Practice

Software Engineering Principles in Python

Adding Functionality to Packages

Package structure

Adding functionality

Importing functionality with __init__.py

Extending package structure

Extending package structure

Let's Practice

Importing functionality with init.py