法布吕克
- 作者仓库星标 3,367
- 许可证 MIT
- 作者仓库 atopile
- 领域
- 通用
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @atopile · MIT
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- Node.js · Python
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
import faebryk.core.faebrykpy as fbrk
import faebryk.core.graph as graph
g = graph.GraphView.create()
tg = fbrk.TypeGraph.create(g=g)
# Faebryk Core Module
The Faebryk core here is the **TypeGraph** + edge types implemented in Zig and exposed to Python via `faebryk.core.faebrykpy`.
Source-of-truth for API + behavior:
- `src/faebryk/core/faebrykpy.py` (Python-facing wrapper + type-safe `EdgeTrait.traverse`)
- `src/faebryk/core/zig/gen/faebryk/typegraph.pyi` (public stubbed API surface)
- `src/faebryk/core/zig/src/faebryk/*` (Zig implementation)
## Quick Start
```python
import faebryk.core.faebrykpy as fbrk
import faebryk.core.graph as graph
g = graph.GraphView.create()
tg = fbrk.TypeGraph.create(g=g)
```
## Relevant Files
- `src/faebryk/core/faebrykpy.py` (re-exports + `EdgeTraversal` + type-safe `EdgeTrait.traverse`)
- `src/faebryk/core/zig/gen/faebryk/typegraph.pyi` (TypeGraph stub)
- Key edge types (imported by `faebrykpy.py`):
- `EdgeComposition` (parent/child structure)
- `EdgeTrait` / `Trait` (trait attachment)
- `EdgePointer` (references)
- `EdgeInterfaceConnection` (interface connections)
- `EdgeOperand` (solver operand wiring)
- `EdgeType` / `EdgeNext` (type graph plumbing)
- Linker:
- `Linker` (used by compiler/linking stages)
## Dependants (Call Sites)
- FabLL: `src/faebryk/core/node.py` (binds Python classes into the TypeGraph; uses composition/trait edges)
- Compiler: `src/atopile/compiler/*` (creates and links TypeGraphs)
- Solver: `src/faebryk/core/solver/*` (operand edges and instance traversal)
- Build/export pipeline: `src/atopile/build_steps.py` (visits type/instance edges for PCB/layout features)
## How to Work With / Develop / Test
### Core Concepts
- **GraphView + TypeGraph**: a `TypeGraph` is created against a `GraphView`:
```python
import faebryk.core.graph as graph
import faebryk.core.faebrykpy as fbrk
g = graph.GraphView.create()
tg = fbrk.TypeGraph.create(g=g)
```
- **Type nodes vs instance nodes**:
- TypeGraph stores type definitions (“what exists structurally on a type”)
- GraphView also holds instances created from those types (“a concrete design graph”)
- **EdgeTraversal**: `TypeGraph.ensure_child_reference(..., path=[...])` uses `EdgeTraversal` items to walk references through the type graph.
### Development Workflow
1) Zig-side changes: edit `src/faebryk/core/zig/src/faebryk/*` (edges, typegraph internals).
2) Rebuild bindings: `ato dev compile` (imports `faebryk.core.zig`).
3) Python ergonomics: add wrappers/helpers in `src/faebryk/core/faebrykpy.py` (example: type-safe `EdgeTrait.traverse`).
### Testing
- TypeGraph-heavy tests live in compiler/runtime suites:
- `ato dev test --llm test/compiler/test_typegraph.py -q`
- `ato dev test --llm test/compiler/test_runtime.py -q`
- Zig-backed traversal tests:
- `ato dev test --llm test/core/zig/test_interface_pathfinder.py -q`
## Best Practices
- Import edges/TypeGraph via `faebryk.core.faebrykpy` (so callers get Python helpers, not just raw generated types).
- Prefer type-safe trait traversal:
- `EdgeTrait.traverse(trait_type=SomeTrait)` over stringly-typed `trait_type_name=...`.
- When building reference paths, be explicit about edge semantics (composition vs pointer vs trait) rather than relying on implicit string behavior.
章节与文件索引
按说明文件中的顺序排列。
相关文件
家属(呼叫站点)
核心概念
开发流程
测试
文件/命令 -> faebryk.core.faebrykpy · src/faebryk/core/faebrykpy.py · EdgeTrait.traverse · src/faebryk/core/zig/gen/faebryk/typegraph.pyi · src/faebryk/core/zig/src/faebryk/* · EdgeTraversal · faebrykpy.py · EdgeComposition
内容校验值 -> 5e0bc10f7159
当前原文的自动摘译,尚未人工审校。
相关文件
src/faebryk/core/faebrykpy.py(重新导出+EdgeTraversal+类型安全EdgeTrait.traverse)src/faebryk/core/zig/gen/faebryk/typegraph.pyi(TypeGraph存根)关键边类型(由faebrykpy.py导入):EdgeComposition(父/子结构)EdgeTrait/Trait(特征附件)家属(呼叫站点)
FabLL:
src/faebryk/core/node.py(将 Python 类绑定到 TypeGraph;使用组合/特征边缘) 编译器:src/atopile/compiler/*(创建并链接 TypeGraph) 求解器:src/faebryk/core/solver/*(操作数边缘和实例遍历) 构建/导出管道:src/atopile/build_steps.py(访问 PCB/布局功能的类型/实例边缘)核心概念
GraphView + TypeGraph:针对
GraphView创建TypeGraph:类型节点与实例节点:TypeGraph 存储类型定义(“类型上结构上存在的内容”) GraphView 还保存从这些类型创建的实例(“具体设计图”) EdgeTraversal:TypeGraph.ensure_child_reference(..., path=[...])使用EdgeTraversal项在类型图中遍历引用。开发流程
Zig 侧更改:编辑
src/faebryk/core/zig/src/faebryk/*(边缘、字体内部结构)。重建绑定:ato dev compile(导入faebryk.core.zig)。 Python 人体工程学:在src/faebryk/core/faebrykpy.py中添加包装器/帮助器(例如:类型安全EdgeTrait.traverse)。测试
TypeGraph 密集型测试位于编译器/运行时套件中:
ato dev test --llm test/compiler/test_typegraph.py -qato dev test --llm test/compiler/test_runtime.py -qZig 支持的遍历测试:ato dev test --llm test/core/zig/test_interface_pathfinder.py -q