Add --list-sources to CLI
#346
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
Nour-Mws
approved these changes
Aug 9, 2023
Increase transparency and debug-friendliness by including our Source
objects in the --json output.
In order to more easily differentiate the various types of Source
objects in this output, we want to include the Source subclass name in
its JSON representation. This is accomplished by making a proper Source
base class that automatically injects a .source_type member which
records the subclass. This is then included in the JSON representation.
Without this, a CodeSource, DepsSource, and PyEnvSource would be
represented like this, and differentiating them would have to be done by
looking at incidental members:
"sources": [
{
"path": "/some/path/code.py",
"base_dir": "/some/path",
},
{
"path": "/some/path/requirements.txt",
"parser_choice": "requirements.txt",
},
{
"path": "/some/path/.venv",
},
]
Instead, we make the entries self-documenting, by including the subclass
name:
"sources": [
{
"source_type": "CodeSource",
"path": "/some/path/code.py",
"base_dir": "/some/path",
},
{
"source_type": "DepsSource",
"path": "/some/path/requirements.txt",
"parser_choice": "requirements.txt",
},
{
"source_type": "PyEnvSource",
"path": "/some/path/.venv",
},
],
This allows FawltyDeps to stop early and print the sources that would be used for finding imports and declared dependencies in the project. This can be used to help find the appropriate options to pass to FawltyDeps in order to have it analyze the desired files. The (default) --summary view lists all file paths that are used as sources. The --detailed view also categorizes sources by type, and adds extra information relevant to the type (for CodeSource, which base path is used to recognize 1st-party imports, and for DepsSource, which parser is used to parse declared dependencies).
jherland
force-pushed
the
jherland/list-sources
branch
from
0c2835d
to
33c6709
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.
Make the traversal logic in FawltyDeps more visible/debuggable to the end user:
*Sourceobjects to the JSON output--list-sourcesCLI action with a human-readable version of the sameCommits:
main: AddAnalysis.sourcesto JSON output--list-sourcesCLI argumentmain: Reformatprint_human_readable()to fix pylint's 'Too many branches'