coding-guide.md

Style Guide for Python Code

1 Introduction

This document gives coding conventions for the Python code comprising OpenVINO™ Explainable AI Toolkit.

This style guide supplements the PEP 8 -- Style Guide for Python Code with a list of dos and don'ts for Python code. If no guidelines were found in this style guide then the PEP 8 -- Style Guide for Python Code should be followed.

2 Automating Code Formatting

To maintain consistency and readability throughout the codebase, we use a set of tools for formatting. Before committing any changes, it's important to run a pre-commit command to ensure that the code is properly formatted. You can use the following commands for this:

pre-commit run --all-files

Also recommend configuring your IDE to run Black and isort tools automatically when saving files.

Automatic code formatting is mandatory for all Python files, but you can disable it for specific cases if required.

3 Python Language Rules

3.1 Type Annotated Code

Code should be annotated with type hints according to PEP-484 with PEP-604 update, and type-check the code at build time with a type checking tool like mypy.

def func(a: int) -> List[int]:

def func(a: int | str) -> List[int | str]:

3.2 Avoid using mutable default arguments

Use None as the default value.

def add_to_list(nums: List[int] | None = None, item: int) -> List[int]:
  if nums is None:
    nums = []
  nums.append(item)
  return nums

4 Python Style Rules

TBD