-
Notifications
You must be signed in to change notification settings - Fork 140
chore: migrate ansys-tools-path -> ansys-tools-common #4307
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Update dependency, imports, docs, links, and tests to use ansys-tools-common (ansys.tools.common.path) instead of ansys-tools-path. Add _HAS_ATC feature flag and provide a backward-compatible _HAS_ATP alias. Adjust CLI/help text, sphinx intersphinx mapping, workflow comment, and numerous test patches to reflect the new package name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR migrates the project from the deprecated ansys-tools-path package to its successor ansys-tools-common. The path-related functionality remains available in the ansys.tools.common.path module. The migration includes updating dependencies, imports, feature flags, and all references across source code, tests, and documentation.
- Replaced
ansys-tools-pathwithansys-tools-commonin project dependencies - Updated all imports from
ansys.tools.pathtoansys.tools.common.path - Replaced
_HAS_ATPfeature flag with_HAS_ATCwhile maintaining backward compatibility
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated dependency from ansys-tools-path>=0.3.1 to ansys-tools-common>=0.2.1 |
| src/ansys/mapdl/core/init.py | Added _HAS_ATC flag and _HAS_ATP backward compatibility alias; updated imports |
| src/ansys/mapdl/core/launcher.py | Updated feature flag usage and imports; updated error messages and documentation |
| src/ansys/mapdl/core/pool.py | Updated feature flag usage and imports; updated error messages |
| src/ansys/mapdl/core/licensing.py | Updated feature flag usage and imports |
| src/ansys/mapdl/core/mapdl_core.py | Updated feature flag usage and documentation references |
| src/ansys/mapdl/core/report.py | Updated feature flag usage, imports, and error messages |
| src/ansys/mapdl/core/cli/start.py | Updated help text to reference ansys.tools.common.path |
| doc/source/links.rst | Updated documentation link for ansys-tools-path |
| doc/source/conf.py | Updated intersphinx mapping to ansys-tools-common |
| doc/source/api/launcher.rst | Updated library references in documentation |
| doc/source/user_guide/troubleshoot.rst | Updated function reference to new module path |
| tests/test_launcher.py | Updated feature flag usage, imports, and test patches to new module path |
| tests/test_mapdl.py | Updated test decorator and patches to reference new module path |
| tests/test_pool.py | Updated dependency check and import |
| tests/test_inprocess.py | Updated import path |
| tests/test_licensing.py | Updated test decorators to require new package |
| tests/conftest.py | Updated dependency check and import |
| tests/common.py | Updated imports |
| .github/workflows/test-local.yml | Updated comment referencing the package name |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #4307 +/- ##
==========================================
- Coverage 91.31% 91.27% -0.05%
==========================================
Files 193 193
Lines 15742 15742
==========================================
- Hits 14375 14368 -7
- Misses 1367 1374 +7 🚀 New features to boost your workflow:
|
|
@pyansys-ci-bot LGTM. |
pyansys-ci-bot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* chore: migrate ansys-tools-path -> ansys-tools-common Update dependency, imports, docs, links, and tests to use ansys-tools-common (ansys.tools.common.path) instead of ansys-tools-path. Add _HAS_ATC feature flag and provide a backward-compatible _HAS_ATP alias. Adjust CLI/help text, sphinx intersphinx mapping, workflow comment, and numerous test patches to reflect the new package name. * chore: adding changelog file 4307.maintenance.md [dependabot-skip] * Update src/ansys/mapdl/core/report.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* chore: migrate ansys-tools-path -> ansys-tools-common Update dependency, imports, docs, links, and tests to use ansys-tools-common (ansys.tools.common.path) instead of ansys-tools-path. Add _HAS_ATC feature flag and provide a backward-compatible _HAS_ATP alias. Adjust CLI/help text, sphinx intersphinx mapping, workflow comment, and numerous test patches to reflect the new package name. * chore: adding changelog file 4307.maintenance.md [dependabot-skip] * Update src/ansys/mapdl/core/report.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* chore: migrate ansys-tools-path -> ansys-tools-common Update dependency, imports, docs, links, and tests to use ansys-tools-common (ansys.tools.common.path) instead of ansys-tools-path. Add _HAS_ATC feature flag and provide a backward-compatible _HAS_ATP alias. Adjust CLI/help text, sphinx intersphinx mapping, workflow comment, and numerous test patches to reflect the new package name. * chore: adding changelog file 4307.maintenance.md [dependabot-skip] * Update src/ansys/mapdl/core/report.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Description
This PR migrates the project from using
ansys-tools-pathtoansys-tools-common. Theansys-tools-pathpackage has been superseded byansys-tools-common, which provides the same path-related functionality in theansys.tools.common.pathmodule.Changes
Dependencies
ansys-tools-path>=0.3.1withansys-tools-common>=0.3.1inpyproject.tomlansys-tools-commonCode Changes
_HAS_ATCfeature flag foransys.tools.common_HAS_ATPalias pointing to_HAS_ATCansys.tools.pathtoansys.tools.common.path_HAS_ATPto_HAS_ATCin source files:src/ansys/mapdl/core/launcher.pysrc/ansys/mapdl/core/report.pysrc/ansys/mapdl/core/pool.pysrc/ansys/mapdl/core/licensing.pysrc/ansys/mapdl/core/mapdl_core.pyTests
ansys.tools.common.pathansys.tools.common.path.path)tests/test_launcher.pytests/test_mapdl.pytests/test_pool.pytests/test_inprocess.pytests/conftest.pytests/common.pyDocumentation
ansys.tools.common.pathdoc/source/links.rstto point to ansys-tools-common documentationTesting
All affected tests have been run and pass successfully:
Backward Compatibility
The
_HAS_ATPalias ensures backward compatibility for any code that may reference this internal flag.