Circular import: importing data_designer.engine.models.errors (or .registry) first raises ImportError
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
Start with engine/models/errors.py, engine/models/clients/__init__.py, and engine/models/clients/factory.py to trace the import cycle; then read tests/test_lazy_imports.py and its _run_python_snippet helper. Reproduce the failure with a fresh-process import of data_designer.engine.models.errors and check whether registry is covered too. Done means the relevant first-import cases succeed and regression tests pass.
索引モデルが issue の本文から書いたものです。
説明
Priority Level
Medium (Annoying but has workaround)
Describe the bug
In a fresh interpreter, import data_designer.engine.models.errors fails with:
ImportError: cannot import name 'FormattedLLMErrorMessage' from partially initialized module 'data_designer.engine.models.errors' (most likely due to a circular import)
import data_designer.engine.models.registry fails the same way, because it imports errors first. Importing almost any other Data Designer module first (data_designer.interface, data_designer.engine.models, ...models.facade, ...models.factory, ...models.clients) loads the modules in an order that avoids the cycle. So whether the import works depends on what the process happened to import earlier.
data_designer.engine.models.errors defines the model exception classes (ModelRateLimitError, ModelAuthenticationError, ModelContextWindowExceededError, and so on), and they aren't re-exported anywhere else. Code that catches them, such as a plugin, a script or a test module, crashes on import when this is its first Data Designer import. In test suites that shows up as failures that depend on collection order.
Steps/Code to reproduce bug
python -c "import data_designer.engine.models.errors"
Traceback (most recent call last):
File "<string>", line 1, in <module>
import data_designer.engine.models.errors
File ".../data_designer/engine/models/errors.py", line 14, in <module>
from data_designer.engine.models.clients.errors import ProviderError, ProviderErrorKind, SyncClientUnavailableError
File ".../data_designer/engine/models/clients/__init__.py", line 14, in <module>
from data_designer.engine.models.clients.factory import create_model_client
File ".../data_designer/engine/models/clients/factory.py", line 15, in <module>
from data_designer.engine.models.errors import FormattedLLMErrorMessage
ImportError: cannot import name 'FormattedLLMErrorMessage' from partially initialized module 'data_designer.engine.models.errors' (most likely due to a circular import) (.../data_designer/engine/models/errors.py)
python -c "import data_designer.engine.models.registry" fails with the same traceback. Importing another module first works around it:
python -c "import data_designer.engine.models.factory; import data_designer.engine.models.errors"
Reproduced on data-designer 0.9.3 and on main at f9aff6e (built from source).
Expected behavior
Every module imports successfully regardless of which Data Designer module the process imports first.
Agent Diagnostic / Prior Investigation
The cycle (at f9aff6e):
engine/models/errors.pyL14 importsengine.models.clients.errors, which first executes theclientspackage__init__.engine/models/clients/__init__.pyL14 eagerly importscreate_model_clientfromclients.factory.engine/models/clients/factory.pyL15 importsFormattedLLMErrorMessagefromengine.models.errors, which is still on its line 14, so the class (defined at L155) doesn't exist yet.factory.pyuses it in one place (L100).
registry.py imports errors at L11, so it enters the same cycle.
#781 fixed a regression caused by this same cycle. Its first revision made create_model_client a lazy export in clients/__init__.py, which broke the cycle. The merged version instead removed the health-check script's direct import of engine.models.errors and reverted the lazy export. The cycle itself is still present, so the error returns whenever errors or registry is the first module imported. The fresh-process test in tests/test_lazy_imports.py covers the health-check script's entry point, not this import order.
Additional context
Possible fixes, not mutually exclusive:
- Smallest: in
clients/factory.py, importFormattedLLMErrorMessageinside the function that uses it, with a short comment explaining why the import is deferred. - Remove the edge: move
FormattedLLMErrorMessageinto a module that doesn't importclients(for example next toGenerationTruncationReasoninengine/models/utils.py), and re-export it fromerrors.pyfor compatibility. - Public import path: if
engine.*is meant to stay internal, re-export the model exception classes from a public module (such asdata_designer.interface), so downstream code never has to importengine.models.errorsto catch them. That would fit the boundary direction taken in #781.
Regression coverage: a parametrized fresh-process test (the _run_python_snippet helper in tests/test_lazy_imports.py already does this) that imports each module under data_designer.engine.models as the very first import.
Happy to contribute a PR for whichever direction is preferred.
Checklist
- I reproduced this issue or provided a minimal example
- I searched the docs/issues myself, or had my agent do so
- If I used an agent, I included its diagnostics above
- 主要言語
- Python
- スター
- 2.4k
- フォーク
- 234
- 平均マージ
- 23時間
- マージ済み PR(30日)
- 75
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NVIDIA-NeMo/DataDesigner のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
NVIDIA-NeMo/DataDesigner#1089 ·
メンテナーはふだん 1 日以内に返信
-
`ValidationColumnConfig` misaligns rows and discards the whole batch after an upstream row is dropped対応中かも @suryapilla が 2 日前に担当しました。 オープンtriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NVIDIA-NeMo/DataDesigner#1073 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
docs: required_columns description is incomplete for LLM and multimodal columns対応中かも @rksharma-owg が 9 日前に担当しました。 オープンbug triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
NVIDIA-NeMo/DataDesigner#1002 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
enforce \from future import annotations` via ruff FA102 rule`対応中かも @chethanuk が 44 日前に担当しました。 オープンtask
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
NVIDIA-NeMo/DataDesigner#760 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
NVIDIA-NeMo/DataDesigner#1088 ·
メンテナーはふだん 1 日以内に返信
NVIDIA-NeMo/DataDesigner の issue をすべて見る
似ている issue
-
bug P2 rust
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
jscott3201/rusty-bacnet#2085 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
evarness-ai/iris-harness#401 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
sistemicorp/scripts#62 ·
-
area/mac help wanted needs-qa
難易度 1/5 1時間未満 初心者へのやさしさ 76/100