Remove backward compatibility shims from chipflow package#154
Merged
Remove backward compatibility shims from chipflow package#154
Conversation
- Move PACKAGE_DEFINITIONS from chipflow/platforms/_packages.py to chipflow/packages.py - Move _json_compare.py from chipflow/steps/ to chipflow/common/ - Remove chipflow/platforms/ directory (shims that re-exported from chipflow.platform) - Remove chipflow/steps/ directory (shims that re-exported from chipflow.platform) - Remove chipflow/config.py and chipflow/config_models.py shims - Update chipflow_lib/ backward compat shims to import from chipflow.platform directly - Update all internal imports to use chipflow.config instead of chipflow.config_models - Update all internal imports to use chipflow.platform instead of chipflow.platforms - Update tests and docs to use new import paths The backward compatibility shims for the old chipflow_lib package name are now only in the chipflow_lib/ directory, making the chipflow package cleaner with no internal shim redirects. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
|
- Add chipflow/common/__init__.py to make it a proper Python package - Update platform-api.rst to use autoapi toctree with quick links 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Update the default step references in cli.py to use the new chipflow.platform module paths instead of the removed chipflow.steps paths. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Enable autoapi.extension in Sphinx config - Configure autoapi settings matching chipflow-docs - Update platform-api.rst to link to autoapi-generated index - Add suppress_warnings for expected warnings from re-exports - Add docs/chipflow-lib to .gitignore for generated autoapi files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update Python requirement from >=3.11 to >=3.12 - Update sphinx-autoapi to >=3.6.1 to fix "Unable to read file" bug 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PACKAGE_DEFINITIONSfromchipflow/platforms/_packages.pytochipflow/packages.py_json_compare.pyfromchipflow/steps/tochipflow/common/chipflow/platforms/directory (shims that re-exported fromchipflow.platform)chipflow/steps/directory (shims that re-exported fromchipflow.platform)chipflow/config.pyandchipflow/config_models.pyshimschipflow_lib/backward compat shims to import fromchipflow.platformdirectlychipflow.configinstead ofchipflow.config_modelschipflow.platforminstead ofchipflow.platformsThe backward compatibility shims for the old
chipflow_libpackage name are now only in thechipflow_lib/directory, making thechipflowpackage cleaner with no internal shim redirects.Test plan
pdm test)pdm lint)pdm run pyright chipflow)🤖 Generated with Claude Code