Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.48 KB

packages-best-practices.md

File metadata and controls

37 lines (23 loc) · 1.48 KB
Raw

Python Packages Best Practices

This page contains steps on when and how to create a Python package.

When should you make a Python package?

A Python package used by Open 3D Engine (O3DE) should be created when the package meets the following conditions:

  • The library contains reusable modules.
  • Multiple tests running in the Open 3D Engine pipeline depend on the library.
  • The tests or modules cannot be moved to relatively import the library.

Consider adding a module to an already existing package instead of creating a new one.

How to make a Python package

Follow the official Python documentation to create the test package. Existing packages such as Tools/LyTestTools can be referenced as examples.

Adding the package to the O3DE bundled Python

Set up automatic installation of the newly created package during CMake configuration by editing cmake/LYPython.cmake. This adds a minor cost to installation time. Use the ly_pip_install_local_package_editable() function to install your new package.

ly_pip_install_local_package_editable(${LY_ROOT_FOLDER}/<path-to-package> <package-name>)

Risks of path hacks

A workaround for importing modules is to hard code relative paths via sys.path.append(). We highly discourage use of this method because the solution is not scalable when any involved files move.

import sys

# Not recommended
sys.path.append('../relative-path')
import my_module