API Reference

This section provides an overview of all KiCadFiles modules organized by functionality.

For detailed documentation of each module, see Detailed Module Documentation.

Core Classes

kicadfiles.base_element.NamedObject()

Base class for named S-expression objects.

kicadfiles.base_element.ParseStrictness(*values)

Parser strictness levels for error handling.

File Format Classes

These classes represent complete KiCad file formats and support both from_file() and save_to_file() methods:

kicadfiles.board_layout.KicadPcb([version, ...])

KiCad PCB board file definition.

kicadfiles.schematic_system.KicadSch([...])

KiCad schematic file definition.

kicadfiles.footprint_library.Footprint([...])

Footprint definition token that defines a complete footprint.

kicadfiles.symbol_library.KicadSymbolLib([...])

KiCad symbol library file definition.

kicadfiles.text_and_documents.KicadWks([...])

KiCad worksheet definition token.

kicadfiles.project_settings.KicadProject([...])

KiCad project file definition (.kicad_pro format).

kicadfiles.design_rules.KiCadDesignRules([...])

KiCad design rules file definition.

kicadfiles.library_tables.FpLibTable([...])

Footprint library table (fp-lib-table file).

kicadfiles.library_tables.SymLibTable([...])

Symbol library table (sym-lib-table file).

Complete Module Reference