loctree 0.8.16

Structural code intelligence for AI agents. Scan once, query everything.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Python import resolution.
//!
//! Handles resolution of Python imports (absolute and relative) to their
//! source files, with stdlib detection.
//!
//! VibeCrafted with AI Agents (c)2026 Loctree Team

use std::collections::HashSet;
use std::path::{Path, PathBuf};

use super::super::resolvers::{resolve_python_absolute, resolve_python_relative};
use crate::types::ImportResolutionKind;

/// Resolve a Python import to its source file and determine its resolution kind.
///
/// Returns a tuple of (resolved_path, resolution_kind):
/// - resolved_path: The absolute path to the resolved module, or None if not found
/// - resolution_kind: Whether this is a Local, Stdlib, or Unknown import
pub(super) fn resolve_python_import(
    module: &str,
    file_path: &Path,
    root: &Path,
    py_roots: &[PathBuf],
    extensions: Option<&HashSet<String>>,
    stdlib: &HashSet<String>,
) -> (Option<String>, ImportResolutionKind) {
    if module.starts_with('.') {
        let resolved = resolve_python_relative(module, file_path, root, extensions);
        let kind = if resolved.is_some() {
            ImportResolutionKind::Local
        } else {
            ImportResolutionKind::Unknown
        };
        return (resolved, kind);
    }

    if let Some(resolved) = resolve_python_absolute(module, py_roots, root, extensions) {
        return (Some(resolved), ImportResolutionKind::Local);
    }

    let head = module.split('.').next().unwrap_or(module).to_lowercase();
    if stdlib.contains(&head) {
        return (None, ImportResolutionKind::Stdlib);
    }

    (None, ImportResolutionKind::Unknown)
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::tempdir;

    fn py_exts() -> HashSet<String> {
        ["py"].iter().map(|s| s.to_string()).collect()
    }

    fn stdlib() -> HashSet<String> {
        ["sys", "os", "json", "typing"]
            .iter()
            .map(|s| s.to_string())
            .collect()
    }

    #[test]
    fn resolves_stdlib_module() {
        let dir = tempdir().expect("tempdir");
        let root = dir.path();
        let path = root.join("main.py");

        let (resolved, kind) = resolve_python_import(
            "sys",
            &path,
            root,
            &[root.to_path_buf()],
            Some(&py_exts()),
            &stdlib(),
        );

        assert!(resolved.is_none());
        assert_eq!(kind, ImportResolutionKind::Stdlib);
    }

    #[test]
    fn resolves_local_module() {
        let dir = tempdir().expect("tempdir");
        let root = dir.path();
        std::fs::write(root.join("foo.py"), "VALUE = 1").expect("write foo.py");
        let path = root.join("main.py");

        let (resolved, kind) = resolve_python_import(
            "foo",
            &path,
            root,
            &[root.to_path_buf()],
            Some(&py_exts()),
            &stdlib(),
        );

        assert!(resolved.is_some());
        assert!(resolved.unwrap().ends_with("foo.py"));
        assert_eq!(kind, ImportResolutionKind::Local);
    }

    #[test]
    fn resolves_relative_import() {
        let dir = tempdir().expect("tempdir");
        let root = dir.path();
        std::fs::create_dir_all(root.join("pkg")).expect("mkdir");
        std::fs::write(root.join("pkg/__init__.py"), "").expect("write __init__");
        std::fs::write(root.join("pkg/helper.py"), "def help(): pass").expect("write helper");
        let path = root.join("pkg/main.py");

        let (resolved, kind) = resolve_python_import(
            ".helper",
            &path,
            root,
            &[root.to_path_buf()],
            Some(&py_exts()),
            &stdlib(),
        );

        assert!(resolved.is_some());
        assert!(resolved.unwrap().contains("helper.py"));
        assert_eq!(kind, ImportResolutionKind::Local);
    }

    #[test]
    fn unknown_for_unresolved_module() {
        let dir = tempdir().expect("tempdir");
        let root = dir.path();
        let path = root.join("main.py");

        let (resolved, kind) = resolve_python_import(
            "nonexistent_package",
            &path,
            root,
            &[root.to_path_buf()],
            Some(&py_exts()),
            &stdlib(),
        );

        assert!(resolved.is_none());
        assert_eq!(kind, ImportResolutionKind::Unknown);
    }
}