πͺ² BUG-#262: Fix entry point separator to use standard module.path:attribute format#263
πͺ² BUG-#262: Fix entry point separator to use standard module.path:attribute format#263FernandoCelmer merged 21 commits intodevelopfrom
Conversation
There was a problem hiding this comment.
π Code Review
Code issues found: 3
| # | Severity | Comment |
|---|---|---|
| 1 | [Blocking] | Docs and examples use stale dot format |
| 2 | [Blocking] | ImportModuleError gives misleading message |
| 3 | [Suggestion] | Test does not distinguish separator error from attribute error |
|
[Blocking] Problem β This PR changes the entry point separator from Files not updated: Runnable examples (
Documentation guides (
Failure scenario β A new user opens the docs, copies the first example, and runs: dotflow start --step docs_src.basic.simple_cli.simple_stepThey get: No hint that they need to change it to Fix β Update all affected files to use the colon separator. Each # Before (broken after this PR)
dotflow start --step my.module.my_function
# After (correct)
dotflow start --step my.module:my_functionThis is a blocking issue because the docs and runnable examples are the primary onboarding path for new users. |
Description
Changes the entry point separator in from to to align with Python's standard packaging convention for module entry points. This change affects how the CLI parses and executes module attributes.
Modified files:
Motivation and Context
This change standardizes dotflow's entry point format to match Python's industry-standard module entry point specification (PEP 440 and setuptools conventions). The colon separator () is the standard delimiter used by Python packaging tools, making dotflow more aligned with ecosystem conventions.
Closes #262
Types of changes
Breaking Change Notice
CLI usage changes:
dotflow start --step my_module.my_stepdotflow start --step my_module:my_stepChecklist