Tool name and command standardization #10
Merged
Conversation
This file contains 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
We've been using the tool name and the actual command in different ways among the different check scripts. This standardizes them to use the same style, and the same behavior. While it would make sense to call the tools by their names because that would be applicable to any tool (be it Python based on or) there are situations on too many platforms where, given the installation of the tool using PIP, the scripts are not readily available on the PATH. Even worse, is that different versions may be picked up from outside a virtual environment, like from system packages. This change standardizes on using the Python module entrypoint for the tools written Python, which will get the right tool if inside a virtual environment becase "python3" will be already set to the active one. A similar change was done for "selftests/style.sh" on Avocado itself. This standardizes the following: * TOOL_NAME is the descriptive name that is given to humans * TOOL_CMD is the actual command that will be called Reference: avocado-framework/avocado@77ca585 Signed-off-by: Cleber Rosa <[email protected]>
clebergnu
force-pushed
the
python_tools_use_module_entrypoint
branch
from
1b1753e to
e245ca8
Compare
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.
We've been using the tool name and the actual command in different ways among the different check scripts. This standardizes them to use the same style, and the same behavior.
While it would make sense to call the tools by their names because that would be applicable to any tool (be it Python based on or) there are situations on too many platforms where, given the installation of the tool using PIP, the scripts are not readily available on the PATH.
Even worse, is that different versions may be picked up from outside a virtual environment, like from system packages. This change standardizes on using the Python module entrypoint for the tools written Python, which will get the right tool if inside a virtual environment becase "python3" will be already set to the active one. A similar change was done for "selftests/style.sh" on Avocado itself.
This standardizes the following:
Reference: avocado-framework/avocado@77ca585