grimp 3.18__tar.gz → 3.19__tar.gz

grimp-3.19/AUTHORS.rst

@@ -0,0 +1,16 @@
+
+Authors
+=======
+
+* David Seddon - https://seddonym.me
+* Kevin Amado - https://github.com/kamadorueda
+* Matthew Gamble - https://github.com/mwgamble
+* NetworkX developers - The shortest path algorithm was adapted from the NetworkX library https://networkx.org/.
+* Peter Byfield - https://github.com/Peter554
+* Shane Smiskol - https://github.com/sshane
+* Andreas Rammhold - https://github.com/andir
+* Nicholas Bunn - https://github.com/NicholasBunn
+* Nathan McDougall - https://github.com/nathanjmcdougall
+* Oleksandr Zaiats - https://github.com/z4y4ts
+* Nikhil Dabas - https://github.com/ndabas
+* Pierre-Yves Le Borgne - https://github.com/pylaterreur

grimp-3.19/LICENSE

@@ -0,0 +1,21 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, David Seddon
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
+conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+  disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{grimp-3.18 → grimp-3.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grimp
-Version: 3.18
+Version: 3.19
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
@@ -8,7 +8,6 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -22,7 +21,7 @@ License-File: AUTHORS.rst
 Summary: Builds a queryable graph of the imports within one or more Python packages.
 Author-email: David Seddon <david@seddonym.me>
 License: BSD 2-Clause License
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst; charset=UTF-8
 Project-URL: Documentation, https://grimp.readthedocs.io/
 Project-URL: Source-code, https://github.com/python-grimp/grimp/

{grimp-3.18 → grimp-3.19}/pyproject.toml

@@ -8,13 +8,13 @@ module-name = "grimp._rustgrimp"
 
 [project]
 name = "grimp"
-version = "3.18"
+version = "3.19"
 license = {text = "BSD 2-Clause License"}
 description = "Builds a queryable graph of the imports within one or more Python packages."
 authors = [
     {name = "David Seddon", email = "david@seddonym.me"},
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = []
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -24,7 +24,6 @@ classifiers = [
     "Operating System :: POSIX",
     "Operating System :: Microsoft :: Windows",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -60,6 +59,7 @@ dev = [
     "requests==2.32.3",
     "sqlalchemy==2.0.35",
     "google-cloud-audit-log==0.3.0",
+    "pyupgrade>=3.21.2",
 ]
 docs = [
     "sphinx>=7.4.7",

{grimp-3.18 → grimp-3.19}/rust/src/graph/cycle_breakers.rs

@@ -1,6 +1,6 @@
-use crate::errors::GrimpResult;
+use crate::errors::{GrimpError, GrimpResult};
 
-use crate::graph::{Graph, ModuleToken};
+use crate::graph::{Graph, ModuleIterator, ModuleToken};
 use rustc_hash::{FxHashMap, FxHashSet};
 use slotmap::SecondaryMap;
 use std::cmp::Ordering;
@@ -9,17 +9,45 @@ impl Graph {
     pub fn nominate_cycle_breakers(
         &self,
         package: ModuleToken,
+        additional_packages: &[ModuleToken],
     ) -> GrimpResult<FxHashSet<(ModuleToken, ModuleToken)>> {
-        // Get children of this package.
-        let children = match self.module_children.get(package) {
-            Some(children) => children,
-            None => return Ok(FxHashSet::default()),
-        };
-        if children.len() < 2 {
+        if additional_packages.is_empty() {
+            // A single package was passed: the nodes of the graph are its children.
+            // Children of a single package can never overlap, so no need to check.
+            let children = match self.module_children.get(package) {
+                Some(children) => children.clone(),
+                None => return Ok(FxHashSet::default()),
+            };
+            self.nominate_cycle_breakers_for_nodes(&children)
+        } else {
+            // Multiple packages were passed: the packages themselves are the nodes.
+            let mut nodes: FxHashSet<ModuleToken> = FxHashSet::default();
+            nodes.insert(package);
+            nodes.extend(additional_packages.iter().copied());
+
+            // The packages must not overlap: if one is a descendant of another, the edges
+            // between them (as packages) would be ill-defined.
+            for node in &nodes {
+                for descendant in self.get_module_descendants(*node).tokens() {
+                    if nodes.contains(&descendant) {
+                        return Err(GrimpError::SharedDescendants);
+                    }
+                }
+            }
+
+            self.nominate_cycle_breakers_for_nodes(&nodes)
+        }
+    }
+
+    fn nominate_cycle_breakers_for_nodes(
+        &self,
+        nodes: &FxHashSet<ModuleToken>,
+    ) -> GrimpResult<FxHashSet<(ModuleToken, ModuleToken)>> {
+        if nodes.len() < 2 {
             return Ok(FxHashSet::default());
         }
         let (orig_imports, orig_reverse_imports, edge_weights) =
-            self.build_graph_maps_of_children(children);
+            self.build_graph_maps_of_nodes(nodes);
 
         // Make a copy of the graph. We'll iteratively remove nodes from this.
         let mut working_imports = orig_imports.clone();
@@ -166,9 +194,9 @@ impl Graph {
     // with empty sets if they have no imports to / from.
     // They are denormalized into two maps for fast lookups.
     #[allow(clippy::type_complexity)]
-    fn build_graph_maps_of_children(
+    fn build_graph_maps_of_nodes(
         &self,
-        children: &FxHashSet<ModuleToken>,
+        nodes: &FxHashSet<ModuleToken>,
     ) -> (
         SecondaryMap<ModuleToken, FxHashSet<ModuleToken>>, // Imports
         SecondaryMap<ModuleToken, FxHashSet<ModuleToken>>, // Reverse imports
@@ -180,25 +208,25 @@ impl Graph {
             SecondaryMap::default();
         let mut weights = FxHashMap::default();
 
-        for child in children {
-            orig_imports.insert(*child, FxHashSet::default());
-            orig_reverse_imports.insert(*child, FxHashSet::default());
+        for node in nodes {
+            orig_imports.insert(*node, FxHashSet::default());
+            orig_reverse_imports.insert(*node, FxHashSet::default());
         }
-        // Get number of imports between each child.
+        // Get number of imports between each node.
         // Add as edges.
-        for child_a in children {
-            for child_b in children.iter().filter(|child| *child != child_a) {
-                // Get number of imports from child_a to child_b (as package).
+        for node_a in nodes {
+            for node_b in nodes.iter().filter(|node| *node != node_a) {
+                // Get number of imports from node_a to node_b (as package).
                 let num_imports_from_a_to_b = self
-                    .find_direct_imports_between(*child_a, *child_b, true)
+                    .find_direct_imports_between(*node_a, *node_b, true)
                     .unwrap()
                     .len();
 
                 if num_imports_from_a_to_b > 0 {
                     // a depends on b - add it as an edge in our temporary graph.
-                    orig_imports[*child_a].insert(*child_b);
-                    orig_reverse_imports[*child_b].insert(*child_a);
-                    weights.insert((*child_a, *child_b), num_imports_from_a_to_b);
+                    orig_imports[*node_a].insert(*node_b);
+                    orig_reverse_imports[*node_b].insert(*node_a);
+                    weights.insert((*node_a, *node_b), num_imports_from_a_to_b);
                 }
             }
         }

{grimp-3.18 → grimp-3.19}/rust/src/graph/mod.rs

@@ -198,6 +198,33 @@ impl GraphWrapper {
 
         PyTuple::new(py, python_dependencies)
     }
+
+    fn convert_cycle_breakers_to_python<'py>(
+        &self,
+        py: Python<'py>,
+        cycle_breakers: FxHashSet<(ModuleToken, ModuleToken)>,
+    ) -> PyResult<Bound<'py, PySet>> {
+        PySet::new(
+            py,
+            cycle_breakers
+                .into_iter()
+                .map(|(importer, imported)| {
+                    let importer = self._graph.get_module(importer).unwrap();
+                    let imported = self._graph.get_module(imported).unwrap();
+                    Import::new(importer.name(), imported.name())
+                })
+                .map(|import| {
+                    PyTuple::new(
+                        py,
+                        [
+                            import.importer.into_py_any(py).unwrap(),
+                            import.imported.into_py_any(py).unwrap(),
+                        ],
+                    )
+                    .unwrap()
+                }),
+        )
+    }
 }
 
 /// Wrapper around the Graph struct that integrates with Python.
@@ -642,29 +669,17 @@ impl GraphWrapper {
         &self,
         py: Python<'py>,
         package: &str,
+        additional_packages: Vec<String>,
     ) -> PyResult<Bound<'py, PySet>> {
         let package = self.get_visible_module_by_name(package)?.token();
-        let cycle_breakers = self._graph.nominate_cycle_breakers(package)?;
-        PySet::new(
-            py,
-            cycle_breakers
-                .into_iter()
-                .map(|(importer, imported)| {
-                    let importer = self._graph.get_module(importer).unwrap();
-                    let imported = self._graph.get_module(imported).unwrap();
-                    Import::new(importer.name(), imported.name())
-                })
-                .map(|import| {
-                    PyTuple::new(
-                        py,
-                        [
-                            import.importer.into_py_any(py).unwrap(),
-                            import.imported.into_py_any(py).unwrap(),
-                        ],
-                    )
-                    .unwrap()
-                }),
-        )
+        let additional_packages = additional_packages
+            .iter()
+            .map(|package| Ok(self.get_visible_module_by_name(package)?.token()))
+            .collect::<PyResult<Vec<_>>>()?;
+        let cycle_breakers = self
+            ._graph
+            .nominate_cycle_breakers(package, &additional_packages)?;
+        self.convert_cycle_breakers_to_python(py, cycle_breakers)
     }
 
     #[pyo3(name = "clone")]

{grimp-3.18 → grimp-3.19}/src/grimp/__init__.py

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

{grimp-3.18 → grimp-3.19}/src/grimp/application/graph.py

@@ -476,14 +476,18 @@ class ImportGraph:
 
         return _dependencies_from_tuple(result)
 
-    def nominate_cycle_breakers(self, package: str) -> set[ImportTuple]:
+    def nominate_cycle_breakers(self, package: str, *additional_packages: str) -> set[ImportTuple]:
         """
-        Identify a set of imports that, if removed, would make the package locally acyclic.
+        Identify a set of imports that, if removed, would make the supplied packages acyclic.
+
+        For more information see the docs in usage.rst.
         """
-        if not self._rustgraph.contains_module(package):
-            msg = f'"{package}" not present in the graph.'
-            raise ModuleNotPresent(msg)
-        return self._rustgraph.nominate_cycle_breakers(package)
+        for package_ in (package, *additional_packages):
+            if not self._rustgraph.contains_module(package_):
+                msg = f'"{package_}" not present in the graph.'
+                raise ModuleNotPresent(msg)
+
+        return self._rustgraph.nominate_cycle_breakers(package, additional_packages)
 
     # Dunder methods
     # --------------

{grimp-3.18 → grimp-3.19}/src/grimp/application/ports/timing.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import abc
 from types import TracebackType
+from typing import Self
 
 
 class Timer(abc.ABC):
@@ -22,7 +23,7 @@ class Timer(abc.ABC):
         # We use a stack so context managers can be nested.
         self._start_stack: list[float] = []
 
-    def __enter__(self) -> Timer:
+    def __enter__(self) -> Self:
         self._start_stack.append(self.get_current_time())
         return self