[PyFDB] Findlibs version display - #293
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a small diagnostic CLI to PyFDB to help users inspect how findlibs resolves fdb5 and related runtime dependencies, and documents how to use it (addresses feature request in issue #288).
Changes:
- Add
python -m pyfdbCLI flags to print resolved library “home” paths and show relevantfindlibsenvironment variables. - Document the new diagnostic commands in the PyFDB installation guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/pyfdb/__main__.py |
Adds a python -m pyfdb CLI with --print-home and --findlibs-setup diagnostics powered by findlibs. |
docs/pyfdb/installation.rst |
Documents how to use the new CLI to diagnose library resolution issues. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This leverages findlibs to figure out the configured runtime path for the dependencies.
a89ecab to
d0eabe4
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #293 +/- ##
===========================================
- Coverage 71.06% 71.02% -0.04%
===========================================
Files 370 370
Lines 23455 23455
Branches 2463 2463
===========================================
- Hits 16669 16660 -9
- Misses 6786 6795 +9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
mcakircali
left a comment
mcakircali
left a comment
There was a problem hiding this comment.
nothing major but see my comments. (in PR description, a sample output could be helpful)
tmi
left a comment
tmi
left a comment
There was a problem hiding this comment.
this is really good -- it is just a question of how much should be here, and how much in findlibs themselves, as this is a really general-purpose code that should benefit all packages. I included some concrete feedback, but thats not really crucial -- maybe a good strategy is to merge as is, gather real feedback from users, and then refactor the improved code into findlibs, and retain the original CLI option in pyfdb but instead invoke the findlibs with fdb5lib as a param
cc @iainrussell -- we discussed some time ago (not sure if week or year ago) to have a diagnostics command in either earthkit or findlibs. This is a good basis for it. Note at that time we had additionally consistency in mind (same buildcounter) which is absent here
Also added tests for the cli functionality. Due to the lack of dependency resolution during runtime execution this has to be written down in the __main__.py.
f8c56a5 to
9da4588
Compare
tbkr
added
enhancement
caraghbiner
left a comment
caraghbiner
left a comment
There was a problem hiding this comment.
Approved, though are you assuming #292 is merged first?
151d66e to
bfbcf97
Compare
Description
Add feature to display runtime information of findlibs for pyfdb and its dependencies.
This was a direct feature request in #288.
Contributor Declaration
By opening this pull request, I affirm the following:
🌈🌦️📖🚧 Documentation FDB 🚧📖🌦️🌈
https://sites.ecmwf.int/docs/fdb/pull-requests/PR-293