Add Doxygen binary path validation #90
Conversation
|
@zyphlar please, test it. Thanks, Jacob |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Enhancement
PR Summary: This pull request introduces validation for the Doxygen binary path in the mkdoxy/doxyrun.py module. It adds a check at the initialization of the main class to ensure the provided Doxygen binary path is valid, either by being a recognized command in the system's PATH or by being a valid, executable file path. Additionally, it defines a custom exception for handling invalid Doxygen binary path scenarios.
Decision: Comment
📝 Type: 'Enhancement' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.
General suggestions:
- Consider enhancing the error message provided when the Doxygen binary path is invalid to include more detailed troubleshooting steps or common misconfigurations.
- Ensure that the check for 'doxygen' in the system's PATH is robust across different operating systems, including those with case-sensitive file systems.
- Review the implementation of the path validation to ensure it covers all common scenarios and edge cases where Doxygen might be installed or accessible.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
| @@ -40,6 +42,14 @@ def __init__( | |||
| @param tempDoxyFolder: (str) Temporary folder for Doxygen. | |||
| @param doxyCfgNew: (dict) New Doxygen config options that will be added to the default config (new options will overwrite default options) | |||
| """ # noqa: E501 | |||
|
|
|||
| if not self.is_doxygen_valid_path(doxygenBinPath): | |||
| raise DoxygenBinPathNotValid( | |||
There was a problem hiding this comment.
suggestion (llm): Raising an exception for an invalid Doxygen binary path is a good practice for early failure. However, consider providing a more detailed error message or suggestions for common misconfigurations to aid in troubleshooting.
| @return: (bool) True if the Doxygen binary path is valid, False otherwise. | ||
| """ | ||
| # If the path is just 'doxygen', search for it in the system's PATH | ||
| if doxygen_bin_path.lower() == "doxygen": |
There was a problem hiding this comment.
issue (llm): Checking for 'doxygen' in the system's PATH is a user-friendly feature. However, ensure that this check is case-insensitive on all operating systems, including those with case-sensitive file systems.
JakubAndrysek
force-pushed
the
doxygen-path-check
branch
from
5dd7dce
to
fde20ba
Compare
No description provided.