debtmap 0.23.0

Code complexity and technical debt analyzer
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

//! Import-aware Python call candidates for the shared call graph.

use crate::core::Language;
use crate::extraction::{ExtractedFileData, ImportInfo, ImportKind};
use crate::priority::call_graph::FunctionId;
use std::collections::HashMap;
use std::path::{Path, PathBuf};

#[derive(Default)]
pub(super) struct PythonImportIndex {
    bindings: HashMap<PathBuf, HashMap<String, Vec<FunctionId>>>,
}

impl PythonImportIndex {
    pub(super) fn from_extracted(files: &[(&PathBuf, &ExtractedFileData)]) -> Self {
        let bindings = files
            .iter()
            .filter(|(path, _)| Language::from_path(path) == Language::Python)
            .filter_map(|(path, file)| {
                let imports = import_bindings(file, files);
                (!imports.is_empty()).then(|| ((*path).clone(), imports))
            })
            .collect();
        Self { bindings }
    }

    pub(super) fn candidates(&self, file: &Path, call: &str) -> Vec<FunctionId> {
        self.bindings
            .get(file)
            .and_then(|bindings| bindings.get(call))
            .cloned()
            .unwrap_or_default()
    }
}

fn import_bindings(
    file: &ExtractedFileData,
    files: &[(&PathBuf, &ExtractedFileData)],
) -> HashMap<String, Vec<FunctionId>> {
    file.imports
        .iter()
        .fold(HashMap::new(), |mut bindings, import| {
            add_import(&mut bindings, import, files);
            bindings
        })
}

fn add_import(
    bindings: &mut HashMap<String, Vec<FunctionId>>,
    import: &ImportInfo,
    files: &[(&PathBuf, &ExtractedFileData)],
) {
    match import.kind {
        ImportKind::Symbol => add_symbol_import(bindings, import, files),
        ImportKind::Module => add_module_import(bindings, import, files),
        ImportKind::Unknown | ImportKind::Glob => {}
    }
}

fn add_symbol_import(
    bindings: &mut HashMap<String, Vec<FunctionId>>,
    import: &ImportInfo,
    files: &[(&PathBuf, &ExtractedFileData)],
) {
    let Some((module, symbol)) = import.path.rsplit_once('.') else {
        return;
    };
    let binding = import.alias.as_deref().unwrap_or(symbol);
    for target in module_functions(module, files)
        .into_iter()
        .filter(|target| target.name == symbol)
    {
        add_candidate(bindings, binding, target);
    }
}

fn add_module_import(
    bindings: &mut HashMap<String, Vec<FunctionId>>,
    import: &ImportInfo,
    files: &[(&PathBuf, &ExtractedFileData)],
) {
    let binding = import.alias.as_deref().unwrap_or(&import.path);
    for target in module_functions(&import.path, files) {
        add_candidate(bindings, &format!("{binding}.{}", target.name), target);
    }
}

fn module_functions(module: &str, files: &[(&PathBuf, &ExtractedFileData)]) -> Vec<FunctionId> {
    files
        .iter()
        .filter(|(path, _)| path_matches_module(path, module))
        .flat_map(|(path, file)| {
            file.functions
                .iter()
                .filter(|function| !function.qualified_name.contains('.'))
                .map(|function| {
                    FunctionId::new(
                        (*path).clone(),
                        function.qualified_name.clone(),
                        function.line,
                    )
                })
        })
        .collect()
}

fn path_matches_module(path: &Path, module: &str) -> bool {
    let mut path_parts: Vec<String> = path
        .components()
        .filter_map(|component| component.as_os_str().to_str().map(str::to_string))
        .collect();
    let Some(file) = path_parts.pop() else {
        return false;
    };
    let stem = Path::new(&file)
        .file_stem()
        .and_then(|value| value.to_str())
        .unwrap_or("");
    if stem != "__init__" {
        path_parts.push(stem.to_string());
    }
    has_module_suffix(&path_parts, module)
}

fn has_module_suffix(path_parts: &[String], module: &str) -> bool {
    let module_parts: Vec<_> = module
        .trim_start_matches('.')
        .split('.')
        .filter(|part| !part.is_empty())
        .collect();
    !module_parts.is_empty()
        && path_parts.len() >= module_parts.len()
        && path_parts[path_parts.len() - module_parts.len()..]
            .iter()
            .map(String::as_str)
            .eq(module_parts)
}

fn add_candidate(bindings: &mut HashMap<String, Vec<FunctionId>>, name: &str, target: FunctionId) {
    let candidates = bindings.entry(name.to_string()).or_default();
    if !candidates.contains(&target) {
        candidates.push(target);
        candidates.sort();
    }
}