Python Style Guide

This document outlines the Python coding standards and conventions used across Function.

General Principles

Readability: Code should be clear and self-documenting.
Consistency: Follow established patterns throughout the codebase.
Type Safety: Use comprehensive type annotations.
Modularity: Keep functions and classes focused on single responsibilities.
Performance: Consider efficiency in compiler-related code.

File Structure and Organization

This section covers how to structure Python files, organize imports, and arrange code within modules to maintain clarity and consistency.

File Headers

Import Organization

Imports should be organized in the following order:

# 1. Future imports
from __future__ import annotations

# 2. Standard library imports (alphabetical)
from abc import ABC, abstractmethod
from collections.abc import Callable
from pathlib import Path

# 3. Third-party imports (alphabetical)
from pydantic import BaseModel
from yaml import safe_load

# 4. Local/project imports (alphabetical, relative imports last)
from .schema import Operator

Module Structure

Prefer structuring modules sequentially:

# 1. Copyright header
# 2. Future imports
# 3. Other imports
# 4. Module-level constants
# 5. Exception classes
# 6. Data classes/models
# 7. Function definitions
# 8. Class definitions
# 9. Main execution block (if applicable)

Imports

We use specific imports rather than wildcards, always include from __future__ import annotations when needed, and organize imports in four distinct groups with alphabetical ordering within each group. Related imports are grouped together, and we prefer absolute imports for clarity.

Import Style

Use from __future__ import annotations at the top of files that use forward references
Prefer specific imports over wildcard imports
Group related imports together
Use absolute imports for clarity

Example:

# Good: Absolute imports
from __future__ import annotations
from pathlib import Path
from typing import Iterator

# Good: Relative imports
from ..foo import SomeType, AnotherType
from .schema import SomeModel

# Bad
from pathlib import *
from ..foo import *

Naming Conventions

We use snake_case for variables and functions, PascalCase for classes, UPPER_SNAKE_CASE for constants, and single leading underscores for private members. Names should be descriptive and avoid abbreviations unless they’re well-known in the domain.

Variables and Functions

Use snake_case for variables, functions, and module names
Use descriptive names that clearly indicate purpose
Avoid abbreviations unless they’re well-known

# Good
def get_function_signature (func: Callable[..., object]) -> CppSignature:
    entrypoint_ref = get_entrypoint_reference(entrypoint)
    ir_signature = sandbox.get_func_signature(entrypoint_ref)

# Avoid
def get_func_sig (f):
    ref = get_ep_ref(ep)

Classes

Constants

Private Members

Use single leading underscore for internal functions/methods
Use double leading underscore for name mangling when necessary

def _resolve_reference (obj_ref: ObjectReference) -> ObjectReference:
    pass

class _TensorSpec (BaseModel):
    pass

Function and Class Definitions

We requrie comprehensive type annotations on functions and classes. We use keyword-only arguments for optional parameters, and group logically.

Function Signatures

Always include type annotations for parameters and return values
Use keyword-only arguments for optional parameters when appropriate
Group related parameters together
Add a space before the opening parenthesis in function definitions

# Good: Space before parentheses
def do_stuff () -> None:
    pass

# Good: Fully annotate parameter and return types
def process_data (items: list[str]) -> list[str]:
    return items

# Good: Use keyword-only arguments for optional parameters when appropriate
def compile (
    source: SourceCode,
    *,
    src_dir: Path=Path("src"),
    build_dir: Path=Path("build"),
    config: BuildConfig="MinSizeRel",
) -> CompiledCode | None:

# Bad: No space before parentheses
def do_stuff():
    pass

Class Definitions

Inherit from appropriate base classes (ABC, BaseModel, etc.)
Use abstract methods when defining interfaces
Include type annotations for class attributes
Add a space before the opening parenthesis in class definitions

# Good: Sspace before parentheses
class SomeModel (BaseModel):
    pass

# Good: Inherit from an appropriate base class
class Database (ABC):

    # Good: Use abstract methods when defining interfaces
    @abstractmethod
    def search (
        self,
        query: str,
        *,
        limit: int = 10
    ) -> list[Item]:
        """
        Search for items given a query
        """
        pass

# Bad: No space before parentheses
class SomeModel(BaseModel):
    pass

Type Annotations

We use comprehensive type annotations throughout the codebase. All function parameters, return types, and class attributes must be annotated.

Basic Types

Use built-in types and typing module for annotations:

from typing import Iterator, Literal
from collections.abc import Callable

def process_items (items: list[str]) -> Iterator[str]:
    pass

def create_model (backend: Literal["cpu", "gpu", "htp"]) -> Model:
    pass

Union Types

Generic Types

Make sure to specify type arguments for generic types:

# Good: Specify generic type arguments
def sum (value: list[int]) -> int:
    return value

# Bad: No generic type arguments for generic type
def sum (value: list) -> int:
    return value

Forward References

Prefer using from __future__ import annotations for forward references over string annotations:

from __future__ import annotations

class Node:

    # Good: Use type annotation
    def __init__ (self, parent: Node | None = None):
        self.parent = parent

    # Bad: Using string annotations
    def __init__ (self, parent: "Node" | None = None):
        self.parent = parent

Comments and Docstrings

We encourage the use of comments and docstrings to provide context around code.

Docstrings

Use triple-quoted strings for docstrings. Follow Google-style format:

def detect_objects (
    image: Image.Image
    *,
    min_score: float=0.3,
    max_iou: float=0.5
) -> list[Detection]:
    """
    Detect objects in an image.

    Parameters:
        image (PIL.Image): Input image
        min_score (float): Minimum detection score.
        max_iou (float): Maximum IoU.

    Returns:
        list: Detected objects.
    """

Inline Comments

Use comments sparingly for complex logic
Prefer self-documenting code over comments
Use # CHECK for areas that need review
Use # INCOMPLETE for unfinished functionality

# CHECK # This might have issues with complex nested structures
if isinstance(value, dict):
    process_dict(value)

# INCOMPLETE # Add support for additional tensor types
tensor_type = get_basic_tensor_type(input_tensor)

Code Formatting

We write highly ergonomic code that is easy to both look at and reason about:

Line Length

Maximum line length: 120 characters
Break long lines using parentheses for natural grouping

# Good: Long list declarations over multiple lines
shell_args = [
    f"echo",
    f"'Hello world'",
]

# Good: Long function calls over multiple lines
result = some_long_function_name(
    first_argument,
    second_argument,
    third_argument
)

Spacing

Use 4 spaces for indentation
No trailing whitespace
Single blank line between function and class definitions
No spaces around = in keyword arguments
Add a space before parentheses in function and class definitions

def function_one ():
    pass

def function_two ():
    pass

class FirstClass:
    pass

class SecondClass:
    pass

Block Comments

Use comments to separate logical blocks within functions or methods instead of empty lines:

def process_model (model_path: Path) -> ProcessedModel:
    # Load and validate model
    model = load_model(model_path)
    validate_model_format(model)
    # Process model layers
    layers = extract_layers(model)
    optimized_layers = optimize_layers(layers)
    # Generate output
    processed_model = create_processed_model(optimized_layers)
    return processed_model

String Formatting

Use f-strings for string interpolation
Use double quotes for strings consistently
Use triple double quotes for multiline strings

# Use double quotes for string literals
greeting = "Hello and have a nice day!"

# Use F-strings for string interpolation
sql_query = f"SELECT * FROM {table_name} WHERE id = {item_id}"

# Use triple double quotes for multiline strings
template = """
This is a multiline
string template with {variable}.
"""

Error Handling

We encourage defining a small set of custom exception types that can be explicitly handled:

Exception Classes

Error Messages

Provide clear, actionable error messages
Include context about what failed and why

if param_type is None:
    raise CompileError(
        f"Missing type annotation for parameter `{name}` in "
        f"function [hot_pink]{func.__name__}[/hot_pink]."
    )

Exception Handling

Catch specific errors when it makes sense to do so.
When propagating errors from an exception handler, chain exceptions with raise ... from ex to preserve context.

try:
    result = risky_operation()
except SpecificError as ex:
    logger.error(f"Operation failed: {ex}")
    raise CompileError(f"Failed to process: {ex}") from ex
except Exception as ex:
    logger.exception("Unexpected error")
    raise

Testing

Tests follow the Arrange-Act-Assert pattern with comments, and are organized in a test/ directory that mirrors the source code structure.

Test Structure

Use descriptive test function names with test_ prefix
Group related tests in classes
Use clear assertions

def test_search_in_memory_dialect ():
    # Arrange
    num_a = 9
    num_b = 10
    # Act
    result = num_a + num_b
    # Assert
    assert result == 21

Test Files

Dependencies

We prefer well-maintained packages with pinned versions for critical dependencies, use optional import patterns with try/except blocks for non-critical features, and favor relative imports for internal modules.

External Dependencies

Prefer well-maintained, widely-used packages
Pin versions for critical dependencies
Use optional imports for non-critical features

# Optional import pattern
try:
    from onnxruntime import InferenceSession
except ImportError:
    InferenceSession = None

def onnx_model_inference (model):
    if InferenceSession and isinstance(model, InferenceSession):
        # Handle ONNX model
        pass

Internal Dependencies

Open Source

Style Guides

General Principles

File Structure and Organization

Imports

Naming Conventions

Function and Class Definitions

Type Annotations

Comments and Docstrings

Code Formatting

Error Handling

Testing

Dependencies

Open Source

Style Guides

​General Principles

​File Structure and Organization

​Imports

​Naming Conventions

​Function and Class Definitions

​Type Annotations

​Comments and Docstrings

​Code Formatting

​Error Handling

​Testing

​Dependencies

General Principles

File Structure and Organization

Imports

Naming Conventions

Function and Class Definitions

Type Annotations

Comments and Docstrings

Code Formatting

Error Handling

Testing

Dependencies