py-armodel: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

py-armodel is a Python library for parsing, manipulating, and writing AUTOSAR XML (ARXML) files. It follows the AUTOSAR standard specifications and supports versions from 4.0.3 to R24-11, with particular focus on CP R23-11 standard compliance.

Current Version: 1.9.9 Python Requirements: >= 3.8 (CI tests on 3.8-3.13) License: MIT Repository: http://github.com/melodypapa/py-armodel

Critical Architecture Concepts

M2 Schema Structure

The codebase is organized according to the AUTOSAR M2 meta-model:

• src/armodel/models/M2/MSR/ - Meta-model semantic rules (AsamHdo, DataDictionary, Documentation, CalibrationData)
• src/armodel/models/M2/AUTOSARTemplates/ - AUTOSAR template models organized by domain

Wildcard Import Pattern:

• All model classes use wildcard imports in __init__.py files (e.g., from .my_class import *)
• When adding new model classes, ensure they are exported from the appropriate __init__.py
• This allows imports like from armodel.models.M2.AUTOSARTemplates import SwcInternalBehavior
• Each module's __init__.py re-exports all classes from its submodules for convenience

AUTOSAR Singleton Pattern

AUTOSAR class uses singleton pattern:

• AUTOSAR.getInstance() - Get/create the singleton instance
• AUTOSAR.new() - Clear and create fresh instance
• AUTOSAR.setARRelease(version) - MUST be called before parsing/writing to select correct XML schema

Parent-Child Object Graph

AUTOSAR model objects maintain bi-directional references:

• Every object has a parent attribute pointing to its container
• Parents hold collections of children
• ARPackage hierarchy is the primary containment structure
• When manipulating models, maintain parent-child relationships carefully

Element Naming

• AUTOSAR elements use "short name" as primary identifier (not Python's __name__)
• Short names must be unique within their containing package/context
• Use findXXX() methods for lookups by short name; they return None if not found (not exceptions)
• Same short name can exist in different packages or with different types