Fill-in missing implementation for is_native_module_file_name (#5410)

## Summary

This was just an oversight -- the last remaining `todo!()` that I never
filled in. We clearly don't have any test coverage for it yet, but this
mimics the Pyright implementation.
This commit is contained in:
Charlie Marsh 2023-06-28 10:50:54 -04:00 committed by GitHub
parent 979049b2a6
commit ea7bb199bc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 86 additions and 23 deletions

View file

@ -64,12 +64,7 @@ pub(crate) fn find(dir_path: &Path, exclusions: &[&Path]) -> BTreeMap<String, Im
.exists()
{
// E.g., `foo.abi3.so` becomes `foo`.
let file_stem = path
.file_stem()
.and_then(OsStr::to_str)
.and_then(|file_stem| {
file_stem.split_once('.').map(|(file_stem, _)| file_stem)
});
let file_stem = native_module::native_module_name(&path);
let is_native_lib = true;
(file_stem, is_native_lib)
} else {

View file

@ -8,7 +8,66 @@ pub(crate) fn is_native_module_file_extension(file_extension: &OsStr) -> bool {
file_extension == "so" || file_extension == "pyd" || file_extension == "dylib"
}
/// Returns `true` if the given file name is that of a native module.
pub(crate) fn is_native_module_file_name(_module_name: &Path, _file_name: &Path) -> bool {
todo!()
/// Given a file name, returns the name of the native module it represents.
///
/// For example, given `foo.abi3.so`, return `foo`.
pub(crate) fn native_module_name(file_name: &Path) -> Option<&str> {
file_name
.file_stem()
.and_then(OsStr::to_str)
.map(|file_stem| {
file_stem
.split_once('.')
.map_or(file_stem, |(file_stem, _)| file_stem)
})
}
/// Returns `true` if the given file name is that of a native module with the given name.
pub(crate) fn is_native_module_file_name(module_name: &str, file_name: &Path) -> bool {
// The file name must be that of a native module.
if !file_name
.extension()
.map_or(false, is_native_module_file_extension)
{
return false;
};
// The file must represent the module name.
native_module_name(file_name) == Some(module_name)
}
#[cfg(test)]
mod tests {
use std::path::PathBuf;
#[test]
fn module_name() {
assert_eq!(
super::native_module_name(&PathBuf::from("foo.so")),
Some("foo")
);
assert_eq!(
super::native_module_name(&PathBuf::from("foo.abi3.so")),
Some("foo")
);
assert_eq!(
super::native_module_name(&PathBuf::from("foo.cpython-38-x86_64-linux-gnu.so")),
Some("foo")
);
assert_eq!(
super::native_module_name(&PathBuf::from("foo.cp39-win_amd64.pyd")),
Some("foo")
);
}
#[test]
fn module_file_extension() {
assert!(super::is_native_module_file_extension("so".as_ref()));
assert!(super::is_native_module_file_extension("pyd".as_ref()));
assert!(super::is_native_module_file_extension("dylib".as_ref()));
assert!(!super::is_native_module_file_extension("py".as_ref()));
}
}

View file

@ -1,6 +1,7 @@
//! Resolves Python imports to their corresponding files on disk.
use std::collections::BTreeMap;
use std::ffi::OsStr;
use std::path::{Path, PathBuf};
use log::debug;
@ -138,18 +139,21 @@ fn resolve_module_descriptor(
} else {
if allow_native_lib && dir_path.is_dir() {
// We couldn't find a `.py[i]` file; search for a native library.
if let Some(native_lib_path) = dir_path
.read_dir()
.unwrap()
.flatten()
.filter(|entry| entry.file_type().map_or(false, |ft| ft.is_file()))
.find(|entry| {
native_module::is_native_module_file_name(&dir_path, &entry.path())
})
{
debug!("Resolved import with file: {native_lib_path:?}");
is_native_lib = true;
resolved_paths.push(native_lib_path.path());
if let Some(module_name) = dir_path.file_name().and_then(OsStr::to_str) {
if let Some(native_lib_path) = dir_path
.read_dir()
.unwrap()
.flatten()
.filter(|entry| entry.file_type().map_or(false, |ft| ft.is_file()))
.map(|entry| entry.path())
.find(|path| {
native_module::is_native_module_file_name(module_name, path)
})
{
debug!("Resolved import with file: {native_lib_path:?}");
is_native_lib = true;
resolved_paths.push(native_lib_path);
}
}
}
@ -427,8 +431,13 @@ fn is_namespace_package_resolved(
implicit_imports: &BTreeMap<String, ImplicitImport>,
) -> bool {
if !module_descriptor.imported_symbols.is_empty() {
// Pyright uses `!Array.from(moduleDescriptor.importedSymbols.keys()).some((symbol) => implicitImports.has(symbol))`.
// But that only checks if any of the symbols are in the implicit imports?
// TODO(charlie): Pyright uses:
//
// ```typescript
// !Array.from(moduleDescriptor.importedSymbols.keys()).some((symbol) => implicitImports.has(symbol))`
// ```
//
// However, that only checks if _any_ of the symbols are in the implicit imports.
for symbol in &module_descriptor.imported_symbols {
if !implicit_imports.contains_key(symbol) {
return false;