grimp 3.16__tar.gz → 3.17__tar.gz

{grimp-3.16 → grimp-3.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grimp
-Version: 3.16
+Version: 3.17
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License

{grimp-3.16 → grimp-3.17}/pyproject.toml

@@ -8,7 +8,7 @@ module-name = "grimp._rustgrimp"
 
 [project]
 name = "grimp"
-version = "3.16"
+version = "3.17"
 license = {text = "BSD 2-Clause License"}
 description = "Builds a queryable graph of the imports within one or more Python packages."
 authors = [

{grimp-3.16 → grimp-3.17}/rust/src/caching.rs

@@ -75,17 +75,27 @@ impl<'a, 'py> FromPyObject<'a, 'py> for ImportsByModule {
     }
 }
 
+/// The version of the data cache file format.
+///
+/// Bump this whenever the serialized structure changes. On read, a file with a
+/// different (or missing) version is treated as a version mismatch and rebuilt,
+/// rather than being mistaken for a corrupt file.
+const CACHE_SCHEMA_VERSION: u32 = 2;
+
 fn serialize_imports_by_module(
     imports_by_module: &HashMap<Module, HashSet<DirectImport>>,
 ) -> String {
-    let raw_map: HashMap<&str, Vec<(&str, usize, &str)>> = imports_by_module
+    // Fields are ordered to match the `get_import_details` dict (`imported`, `is_lazy`,
+    // `line_number`, `line_contents`); `importer` is the map key.
+    let raw_map: HashMap<&str, Vec<(&str, bool, usize, &str)>> = imports_by_module
         .iter()
         .map(|(module, imports)| {
-            let imports_vec: Vec<(&str, usize, &str)> = imports
+            let imports_vec: Vec<(&str, bool, usize, &str)> = imports
                 .iter()
                 .map(|import| {
                     (
                         import.imported.as_str(),
+                        import.is_lazy,
                         import.line_number,
                         import.line_contents.as_str(),
                     )
@@ -95,16 +105,33 @@ fn serialize_imports_by_module(
         })
         .collect();
 
-    serde_json::to_string(&raw_map).expect("Failed to serialize to JSON")
+    let envelope = serde_json::json!({
+        "version": CACHE_SCHEMA_VERSION,
+        "imports_by_module": raw_map,
+    });
+
+    serde_json::to_string(&envelope).expect("Failed to serialize to JSON")
 }
 
 pub fn parse_json_to_map(
     json_str: &str,
     filename: &str,
 ) -> GrimpResult<HashMap<Module, HashSet<DirectImport>>> {
-    let raw_map: HashMap<String, Vec<(String, usize, String)>> = serde_json::from_str(json_str)
+    // Parse into a generic value first, so we can distinguish genuinely corrupt
+    // JSON from a cache file written by a different format version (e.g. by an
+    // older Grimp). The latter should be silently rebuilt, not warned about.
+    let value: serde_json::Value = serde_json::from_str(json_str)
         .map_err(|_| GrimpError::CorruptCache(filename.to_string()))?;
 
+    let version = value.get("version").and_then(|v| v.as_u64());
+    if version != Some(CACHE_SCHEMA_VERSION as u64) {
+        return Err(GrimpError::CacheVersionMismatch(filename.to_string()));
+    }
+
+    let raw_map: HashMap<String, Vec<(String, bool, usize, String)>> =
+        serde_json::from_value(value.get("imports_by_module").cloned().unwrap_or_default())
+            .map_err(|_| GrimpError::CorruptCache(filename.to_string()))?;
+
     let mut parsed_map: HashMap<Module, HashSet<DirectImport>> = HashMap::new();
 
     for (module_name, imports) in raw_map {
@@ -113,12 +140,15 @@ pub fn parse_json_to_map(
         };
         let import_set: HashSet<DirectImport> = imports
             .into_iter()
-            .map(|(imported, line_number, line_contents)| DirectImport {
-                importer: module_name.clone(),
-                imported,
-                line_number,
-                line_contents,
-            })
+            .map(
+                |(imported, is_lazy, line_number, line_contents)| DirectImport {
+                    importer: module_name.clone(),
+                    imported,
+                    line_number,
+                    line_contents,
+                    is_lazy,
+                },
+            )
             .collect();
         parsed_map.insert(module, import_set);
     }

{grimp-3.16 → grimp-3.17}/rust/src/errors.rs

@@ -36,6 +36,9 @@ pub enum GrimpError {
 
     #[error("Could not use corrupt cache file {0}.")]
     CorruptCache(String),
+
+    #[error("Cache file {0} was written by a different version of Grimp.")]
+    CacheVersionMismatch(String),
 }
 
 pub type GrimpResult<T> = Result<T, GrimpError>;
@@ -55,6 +58,9 @@ impl From<GrimpError> for PyErr {
                 line_number, text, ..
             } => PyErr::new::<exceptions::ParseError, _>((line_number, text)),
             GrimpError::CorruptCache(_) => exceptions::CorruptCache::new_err(value.to_string()),
+            GrimpError::CacheVersionMismatch(_) => {
+                exceptions::CacheVersionMismatch::new_err(value.to_string())
+            }
         }
     }
 }

{grimp-3.16 → grimp-3.17}/rust/src/exceptions.rs

@@ -6,6 +6,7 @@ create_exception!(_rustgrimp, ModuleNotPresent, PyException);
 create_exception!(_rustgrimp, NoSuchContainer, PyException);
 create_exception!(_rustgrimp, InvalidModuleExpression, PyException);
 create_exception!(_rustgrimp, CorruptCache, PyException);
+create_exception!(_rustgrimp, CacheVersionMismatch, PyException);
 
 // We need to use here `pyclass(extends=PyException)` instead of `create_exception!`
 // since the exception contains custom data. See:

{grimp-3.16 → grimp-3.17}/rust/src/graph/graph_manipulation.rs

@@ -120,6 +120,7 @@ impl Graph {
         imported: ModuleToken,
         line_number: u32,
         line_contents: &str,
+        is_lazy: bool,
     ) {
         self.imports
             .entry(importer)
@@ -137,7 +138,7 @@ impl Graph {
             self.import_details
                 .entry((importer, imported))
                 .or_default()
-                .insert(PyImportDetails::new(line_number, line_contents));
+                .insert(PyImportDetails::new(line_number, line_contents, is_lazy));
         }
     }
 

{grimp-3.16 → grimp-3.17}/rust/src/graph/mod.rs

@@ -264,29 +264,45 @@ impl GraphWrapper {
         Ok(self.get_visible_module_by_name(module)?.is_squashed())
     }
 
-    #[pyo3(signature = (*, importer, imported, line_number=None, line_contents=None))]
+    #[pyo3(signature = (*, importer, imported, is_lazy=None, line_number=None, line_contents=None))]
     pub fn add_import(
         &mut self,
         importer: &str,
         imported: &str,
+        is_lazy: Option<bool>,
         line_number: Option<u32>,
         line_contents: Option<&str>,
-    ) {
-        let importer = self._graph.get_or_add_module(importer).token();
-        let imported = self._graph.get_or_add_module(imported).token();
-        match (line_number, line_contents) {
-            (Some(line_number), Some(line_contents)) => {
-                self._graph
-                    .add_detailed_import(importer, imported, line_number, line_contents)
-            }
-            (None, None) => {
+    ) -> PyResult<()> {
+        match (line_number, line_contents, is_lazy) {
+            (None, None, None) => {
+                let importer = self._graph.get_or_add_module(importer).token();
+                let imported = self._graph.get_or_add_module(imported).token();
                 self._graph.add_import(importer, imported);
             }
-            _ => {
-                // TODO handle better.
-                panic!("Expected line_number and line_contents, or neither.");
+            (Some(line_number), Some(line_contents), is_lazy) => {
+                let is_lazy = is_lazy.unwrap_or(false);
+                let importer = self._graph.get_or_add_module(importer).token();
+                let imported = self._graph.get_or_add_module(imported).token();
+                self._graph.add_detailed_import(
+                    importer,
+                    imported,
+                    line_number,
+                    line_contents,
+                    is_lazy,
+                );
+            }
+            (_, _, Some(_is_lazy)) => {
+                return Err(PyValueError::new_err(
+                    "You must provide line_number and line_contents when providing is_lazy.",
+                ));
+            }
+            (_, _, None) => {
+                return Err(PyValueError::new_err(
+                    "Expected line_number and line_contents, or neither.",
+                ));
             }
         }
+        Ok(())
     }
 
     #[pyo3(signature = (*, importer, imported))]
@@ -402,6 +418,7 @@ impl GraphWrapper {
                         imported.name(),
                         import_details.line_number(),
                         import_details.line_contents(),
+                        import_details.is_lazy(),
                     )
                 })
                 .sorted()
@@ -417,6 +434,7 @@ impl GraphWrapper {
                             "line_contents",
                             import_details.line_contents.into_py_any(py).unwrap(),
                         ),
+                        ("is_lazy", import_details.is_lazy.into_py_any(py).unwrap()),
                     ]
                     .into_py_dict(py)
                     .unwrap()
@@ -667,6 +685,7 @@ struct ImportDetails {
     imported: String,
     line_number: u32,
     line_contents: String,
+    is_lazy: bool,
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, new)]
@@ -754,6 +773,9 @@ pub struct PyImportDetails {
 
     #[getset(get_copy = "pub")]
     interned_line_contents: DefaultSymbol,
+
+    #[getset(get_copy = "pub")]
+    is_lazy: bool,
 }
 
 impl PyImportDetails {

{grimp-3.16 → grimp-3.17}/rust/src/import_parsing.rs

@@ -10,6 +10,7 @@ pub struct ImportedObject {
     pub line_number: usize,
     pub line_contents: String,
     pub typechecking_only: bool,
+    pub is_lazy: bool,
 }
 
 impl ImportedObject {
@@ -18,12 +19,14 @@ impl ImportedObject {
         line_number: usize,
         line_contents: String,
         typechecking_only: bool,
+        is_lazy: bool,
     ) -> Self {
         Self {
             name,
             line_number,
             line_contents,
             typechecking_only,
+            is_lazy,
         }
     }
 }
@@ -84,6 +87,7 @@ impl<'a> StatementVisitor<'a> for Visitor<'a> {
                         line_number.get(),
                         self.source_code.line_text(line_number).trim().to_string(),
                         self.typechecking_only,
+                        import_stmt.is_lazy,
                     ))
                 }
                 walk_stmt(self, stmt);
@@ -113,6 +117,7 @@ impl<'a> StatementVisitor<'a> for Visitor<'a> {
                         line_number.get(),
                         self.source_code.line_text(line_number).trim().to_string(),
                         self.typechecking_only,
+                        import_from_stmt.is_lazy,
                     ))
                 }
                 walk_stmt(self, stmt);

{grimp-3.16 → grimp-3.17}/rust/src/import_scanning.rs

@@ -16,6 +16,7 @@ pub struct DirectImport {
     pub imported: String,
     pub line_number: usize,
     pub line_contents: String,
+    pub is_lazy: bool,
 }
 
 impl<'a, 'py> FromPyObject<'a, 'py> for DirectImport {
@@ -26,12 +27,14 @@ impl<'a, 'py> FromPyObject<'a, 'py> for DirectImport {
         let imported: String = ob.getattr("imported")?.getattr("name")?.extract()?;
         let line_number: usize = ob.getattr("line_number")?.extract()?;
         let line_contents: String = ob.getattr("line_contents")?.extract()?;
+        let is_lazy: bool = ob.getattr("is_lazy")?.extract()?;
 
         Ok(DirectImport {
             importer,
             imported,
             line_number,
             line_contents,
+            is_lazy,
         })
     }
 }
@@ -152,6 +155,7 @@ fn scan_for_imports_no_py_single_module(
                     imported: imported_module.name.to_string(),
                     line_number: imported_object.line_number,
                     line_contents: imported_object.line_contents,
+                    is_lazy: imported_object.is_lazy,
                 });
             }
             None => {
@@ -165,6 +169,7 @@ fn scan_for_imports_no_py_single_module(
                         imported: imported_module,
                         line_number: imported_object.line_number,
                         line_contents: imported_object.line_contents,
+                        is_lazy: imported_object.is_lazy,
                     });
                 }
             }
@@ -196,6 +201,7 @@ fn to_py_direct_imports<'a>(
         kwargs
             .set_item("line_contents", &rust_import.line_contents)
             .unwrap();
+        kwargs.set_item("is_lazy", rust_import.is_lazy).unwrap();
         let py_direct_import = py_direct_import_class.call((), Some(&kwargs)).unwrap();
         pyset.add(&py_direct_import).unwrap();
     }

{grimp-3.16 → grimp-3.17}/rust/src/lib.rs

@@ -29,6 +29,7 @@ mod _rustgrimp {
 
     #[pymodule_export]
     use crate::exceptions::{
-        CorruptCache, InvalidModuleExpression, ModuleNotPresent, NoSuchContainer, ParseError,
+        CacheVersionMismatch, CorruptCache, InvalidModuleExpression, ModuleNotPresent,
+        NoSuchContainer, ParseError,
     };
 }

{grimp-3.16 → grimp-3.17}/src/grimp/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.16"
+__version__ = "3.17"
 
 from .application.graph import DetailedImport, Import, ImportGraph
 from .domain.analysis import PackageDependency, Route

{grimp-3.16 → grimp-3.17}/src/grimp/adaptors/caching.py

@@ -203,6 +203,12 @@ class Cache(AbstractCache):
         except rust.CorruptCache:
             logger.warning(f"Could not use corrupt cache file {data_cache_filename}.")
             return {}
+        except rust.CacheVersionMismatch:
+            logger.info(
+                f"Cache file {data_cache_filename} was written by a different version of Grimp; "
+                "rebuilding."
+            )
+            return {}
 
         logger.info(f"Used cache data file {data_cache_filename}.")
         return imports_by_module

{grimp-3.16 → grimp-3.17}/src/grimp/application/graph.py

@@ -27,6 +27,7 @@ ImportTuple = tuple[str, str]
 class DetailedImport(Import):
     line_number: int
     line_contents: str
+    is_lazy: bool
 
 
 class ImportGraph:
@@ -138,10 +139,15 @@ class ImportGraph:
         imported: str,
         line_number: int | None = None,
         line_contents: str | None = None,
+        is_lazy: bool | None = None,
     ) -> None:
         """
         Add a direct import between two modules to the graph. If the modules are not already
         present, they will be added to the graph.
+
+        Raises:
+            ValueError if only one of line_number and line_contents is supplied, or if
+            is_lazy is supplied without line_number and line_contents.
         """
         self._cached_modules = None
         self._rustgraph.add_import(
@@ -149,6 +155,7 @@ class ImportGraph:
             imported=imported,
             line_number=line_number,
             line_contents=line_contents,
+            is_lazy=is_lazy,
         )
 
     def remove_import(self, *, importer: str, imported: str) -> None:
@@ -249,6 +256,7 @@ class ImportGraph:
                 'imported': 'mypackage.imported',
                 'line_number': 5,
                 'line_contents': 'from mypackage import imported',
+                'is_lazy': False,
             },
             (additional imports here)
         ]

{grimp-3.16 → grimp-3.17}/src/grimp/application/usecases.py

@@ -184,6 +184,7 @@ def _assemble_graph(
                 imported=direct_import.imported.name,
                 line_number=direct_import.line_number,
                 line_contents=direct_import.line_contents,
+                is_lazy=direct_import.is_lazy,
             )
     return graph
 

{grimp-3.16 → grimp-3.17}/src/grimp/domain/valueobjects.py

@@ -55,9 +55,12 @@ class DirectImport:
     imported: Module
     line_number: int
     line_contents: str
+    # Import in the form `lazy import` or `lazy from import`.
+    is_lazy: bool = False
 
     def __str__(self) -> str:
-        return f"{self.importer} -> {self.imported} (l. {self.line_number})"
+        lazy_label = ", lazy" if self.is_lazy else ""
+        return f"{self.importer} -> {self.imported} (l. {self.line_number}{lazy_label})"
 
 
 @dataclass(frozen=True, order=True)