Add --include-vendored flag and warning for skipped vendor modules #20769
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.
Summary
This PR addresses the issue where stubgen silently skips directories named 'vendor', 'vendored', '_vendor', etc., even when they are legitimate user packages rather than vendored third-party code.
Changes
--include-vendoredflag to allow generating stubs for vendored packagesremove_blacklisted_modules()to print a warning message when skipping vendored modules (unless--quietis specified)Optionsclass to include theinclude_vendoredparameterBehavior
Before
Running
stubgen aon a project with structure:Would silently skip the
vendordirectory with no indication to the user.After
Running
stubgen awill now print:To generate stubs for the vendor directory, users can use:
Or suppress the warning with:
Test Plan
stubgenwithout flags - verify warning is printed and vendor is skippedstubgen --include-vendored- verify vendor stubs are generatedstubgen -q- verify no warning is printedFixes #9599