Add CLI flag to override typeshed #488
Open
+41
−3
Conversation
This file contains hidden or 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
Add --typeshed-path flag to pyrefly check command for testing typeshed upgrades and custom typeshed modifications. - Add typeshed_path CLI argument to ConfigOverrideArgs - Add typeshed_path field to ConfigFile struct - Wire custom typeshed lookup into find_import() logic - Custom typeshed takes precedence over bundled typeshed - Falls back gracefully to bundled typeshed if module not found Fixes facebook#483
connernilsen
requested changes
Jun 16, 2025
There was a problem hiding this comment.
Hey @krikera, thanks for doing this! Just a few things that need to be changed before we can get this in.
Once you're able to fix them, please re-request my review and I'll come check it out!
Comment on lines
+367
to
+387
| } else if let Some(path) = typeshed() | ||
| .map_err(|err| FindError::not_found(err, module))? | ||
| .find(module) | ||
| { | ||
| Ok(path) | ||
| } else if let Some(path) = find_module_in_search_path(module, self.fallback_search_path.iter()) { | ||
| Ok(path) | ||
| } else if let Some(path) = find_module_in_site_package_path( | ||
| module, | ||
| self.site_package_path(), | ||
| self.use_untyped_imports, | ||
| self.ignore_missing_source, | ||
| )? { | ||
| Ok(path) | ||
| } else { | ||
| Err(FindError::import_lookup_path( | ||
| self.structured_import_lookup_path(), | ||
| module, | ||
| &self.source, | ||
| )) | ||
| } |
There was a problem hiding this comment.
Oops, it looks like this part might have been duplicated from below. Can you remove this?
| module, | ||
| &self.source, | ||
| )) | ||
| } | ||
| } else if let Some(path) = typeshed() |
There was a problem hiding this comment.
We should only use the builtin typeshed if one isn't provided. Can we add an extra condition for that here?
} else if self.typeshed_path.is_none() && let Some(path) = ...
| @@ -174,6 +174,9 @@ struct ConfigOverrideArgs { | |||
| /// after first checking `search_path` and `typeshed`. | |||
| #[arg(long, env = clap_env("SITE_PACKAGE_PATH"))] | |||
| site_package_path: Option<Vec<PathBuf>>, | |||
| /// Override the bundled typeshed with a custom path. | |||
| #[arg(long = "typeshed-path", env = clap_env("TYPESHED_PATH"))] | |||
There was a problem hiding this comment.
nit: arg(long, ...) does the same thing as arg(long = "typeshed-path", ...), but specifying "typeshed-path" is more prone to typos/less resilient to refactors. Can we just leave this as arg(long, ...)?
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.
Add --typeshed-path flag to pyrefly check command for testing typeshed upgrades and custom typeshed modifications.
Fixes #483