Inline default for community endpoints part 1

Author: FlorentinD

graphdatascience/procedure_surface/api/community/clique_counting_endpoints.py

@@ -22,7 +22,7 @@ def mutate(
         log_progress: bool = True,
         node_labels: list[str] = ALL_LABELS,
         relationship_types: list[str] = ALL_TYPES,
-        sudo: bool | None = False,
+        sudo: bool = False,
         username: str | None = None,
     ) -> CliqueCountingMutateResult:
         """
@@ -44,7 +44,7 @@ def mutate(
             The node labels used to select nodes for this algorithm run
         relationship_types : list[str]
             The relationship types used to select relationships for this algorithm run
-        sudo : bool | None, default=False
+        sudo : bool, default=False
             Override memory estimation limits
         username : str | None, default=None
             The username to attribute the procedure run to

graphdatascience/procedure_surface/api/community/k1coloring_endpoints.py

@@ -21,15 +21,16 @@ def mutate(
         self,
         G: GraphV2,
         mutate_property: str,
-        batch_size: int | None = None,
-        max_iterations: int | None = None,
-        relationship_types: list[str] = ALL_TYPES,
-        node_labels: list[str] = ALL_LABELS,
-        sudo: bool | None = None,
+        *,
+        batch_size: int = 10000,
+        concurrency: int | None = None,
+        job_id: str | None = None,
         log_progress: bool = True,
+        max_iterations: int = 10,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        sudo: bool = False,
         username: str | None = None,
-        concurrency: Any | None = None,
-        job_id: Any | None = None,
     ) -> K1ColoringMutateResult:
         """
         Executes the K-1 Coloring algorithm and writes the results to the in-memory graph as node properties.
@@ -40,24 +41,24 @@ def mutate(
             The graph to run the algorithm on
         mutate_property : str
             The property name to store the color for each node
-        batch_size : int | None, default=None
+        batch_size : int, default=10000
             The batch size for processing
-        max_iterations : int
+        concurrency : int | None, default=None
+            The number of concurrent threads
+        job_id : str | None, default=None
+            An identifier for the job
+        log_progress : bool, default=True
+            Whether to log progress
+        max_iterations : int, default=10
             The maximum number of iterations of K-1 Coloring to run
-        relationship_types : list[str]
-            The relationships types used to select relationships for this algorithm run
         node_labels : list[str]
             The node labels used to select nodes for this algorithm run
-        sudo : bool
+        relationship_types : list[str]
+            The relationship types used to select relationships for this algorithm run
+        sudo : bool, default=False
             Override memory estimation limits
-        log_progress : bool | None, default=None
-            Whether to log progress
         username : str | None, default=None
             The username to attribute the procedure run to
-        concurrency : Any | None, default=None
-            The number of concurrent threads
-        job_id : Any | None, default=None
-            An identifier for the job
 
         Returns
         -------
@@ -70,15 +71,16 @@ def mutate(
     def stats(
         self,
         G: GraphV2,
-        batch_size: int | None = None,
-        max_iterations: int | None = None,
-        relationship_types: list[str] = ALL_TYPES,
-        node_labels: list[str] = ALL_LABELS,
-        sudo: bool | None = None,
+        *,
+        batch_size: int = 10000,
+        concurrency: int | None = None,
+        job_id: str | None = None,
         log_progress: bool = True,
+        max_iterations: int = 10,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        sudo: bool = False,
         username: str | None = None,
-        concurrency: Any | None = None,
-        job_id: Any | None = None,
     ) -> K1ColoringStatsResult:
         """
         Executes the K-1 Coloring algorithm and returns statistics.
@@ -87,24 +89,24 @@ def stats(
         ----------
         G : GraphV2
             The graph to run the algorithm on
-        batch_size : int | None, default=None
+        batch_size : int, default=10000
             The batch size for processing
-        max_iterations : int
+        concurrency : int | None, default=None
+            The number of concurrent threads
+        job_id : str | None, default=None
+            An identifier for the job
+        log_progress : bool, default=True
+            Whether to log progress
+        max_iterations : int, default=10
             The maximum number of iterations of K-1 Coloring to run
-        relationship_types : list[str]
-            The relationships types used to select relationships for this algorithm run
         node_labels : list[str]
             The node labels used to select nodes for this algorithm run
-        sudo : bool
+        relationship_types : list[str]
+            The relationship types used to select relationships for this algorithm run
+        sudo : bool, default=False
             Override memory estimation limits
-        log_progress : bool | None, default=None
-            Whether to log progress
         username : str | None, default=None
             The username to attribute the procedure run to
-        concurrency : Any | None, default=None
-            The number of concurrent threads
-        job_id : Any | None, default=None
-            An identifier for the job
 
         Returns
         -------
@@ -117,16 +119,17 @@ def stats(
     def stream(
         self,
         G: GraphV2,
-        batch_size: int | None = None,
-        max_iterations: int | None = None,
-        relationship_types: list[str] = ALL_TYPES,
-        node_labels: list[str] = ALL_LABELS,
-        sudo: bool | None = None,
+        *,
+        batch_size: int = 10000,
+        concurrency: int | None = None,
+        job_id: str | None = None,
         log_progress: bool = True,
-        username: str | None = None,
-        concurrency: Any | None = None,
-        job_id: Any | None = None,
+        max_iterations: int = 10,
         min_community_size: int | None = None,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        sudo: bool = False,
+        username: str | None = None,
     ) -> DataFrame:
         """
         Executes the K-1 Coloring algorithm and returns a stream of results.
@@ -135,26 +138,26 @@ def stream(
         ----------
         G : GraphV2
             The graph to run the algorithm on
-        batch_size : int | None, default=None
+        batch_size : int, default=10000
             The batch size for processing
-        max_iterations : int
+        concurrency : int | None, default=None
+            The number of concurrent threads
+        job_id : str | None, default=None
+            An identifier for the job
+        log_progress : bool, default=True
+            Whether to log progress
+        max_iterations : int, default=10
             The maximum number of iterations of K-1 Coloring to run
-        relationship_types : list[str]
-            The relationships types considered in this algorithm run
+        min_community_size : int | None, default=None
+            Only community ids of communities with a size greater than or equal to the given value are returned
         node_labels : list[str]
             The node labels used to select nodes for this algorithm run
-        sudo : bool
+        relationship_types : list[str]
+            The relationship types considered in this algorithm run
+        sudo : bool, default=False
             Override memory estimation limits
-        log_progress : bool | None, default=None
-            Whether to log progress
         username : str | None, default=None
             The username to attribute the procedure run to
-        concurrency : Any | None, default=None
-            The number of concurrent threads
-        job_id : Any | None, default=None
-            An identifier for the job
-        min_community_size : int | None, default=None
-            Only community ids of communities with a size greater than or equal to the given value are returned
 
         Returns
         -------
@@ -168,17 +171,18 @@ def write(
         self,
         G: GraphV2,
         write_property: str,
-        batch_size: int | None = None,
-        max_iterations: int | None = None,
-        relationship_types: list[str] = ALL_TYPES,
-        node_labels: list[str] = ALL_LABELS,
-        sudo: bool | None = None,
+        *,
+        batch_size: int = 10000,
+        concurrency: int | None = None,
+        job_id: str | None = None,
         log_progress: bool = True,
-        username: str | None = None,
-        concurrency: Any | None = None,
-        job_id: Any | None = None,
-        write_concurrency: Any | None = None,
+        max_iterations: int = 10,
         min_community_size: int | None = None,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        sudo: bool = False,
+        username: str | None = None,
+        write_concurrency: int | None = None,
     ) -> K1ColoringWriteResult:
         """
         Executes the K-1 Coloring algorithm and writes the results to the Neo4j database.
@@ -189,28 +193,28 @@ def write(
             The graph to run the algorithm on
         write_property : str
             The property name to write colors to
-        batch_size : int | None, default=None
+        batch_size : int, default=10000
             The batch size for processing
-        max_iterations : int
+        concurrency : int | None, default=None
+            The number of concurrent threads
+        job_id : str | None, default=None
+            An identifier for the job
+        log_progress : bool, default=True
+            Whether to log progress
+        max_iterations : int, default=10
             The maximum number of iterations of K-1 Coloring to run
-        relationship_types : list[str]
-            The relationships types considered in this algorithm run
+        min_community_size : int | None, default=None
+            Only community ids of communities with a size greater than or equal to the given value are written to Neo4j
         node_labels : list[str]
             The node labels used to select nodes for this algorithm run
-        sudo : bool
+        relationship_types : list[str]
+            The relationship types considered in this algorithm run
+        sudo : bool, default=False
             Override memory estimation limits
-        log_progress : bool | None, default=None
-            Whether to log progress
         username : str | None, default=None
             The username to attribute the procedure run to
-        concurrency : Any | None, default=None
-            The number of concurrent threads
-        job_id : Any | None, default=None
-            An identifier for the job
-        write_concurrency : Any | None, default=None
+        write_concurrency : int | None, default=None
             The number of concurrent threads during the write phase
-        min_community_size : int | None, default=None
-            Only community ids of communities with a size greater than or equal to the given value are written to Neo4j
 
         Returns
         -------
@@ -223,11 +227,12 @@ def write(
     def estimate(
         self,
         G: GraphV2 | dict[str, Any],
-        batch_size: int | None = None,
-        max_iterations: int | None = None,
-        relationship_types: list[str] = ALL_TYPES,
+        *,
+        batch_size: int = 10000,
+        concurrency: int | None = None,
+        max_iterations: int = 10,
         node_labels: list[str] = ALL_LABELS,
-        concurrency: Any | None = None,
+        relationship_types: list[str] = ALL_TYPES,
     ) -> EstimationResult:
         """
         Estimate the memory consumption of an algorithm run.
@@ -236,16 +241,16 @@ def estimate(
         ----------
         G : GraphV2 | dict[str, Any]
             The graph to run the algorithm on or a dictionary representing the graph.
-        batch_size : int | None, default=None
+        batch_size : int, default=10000
             The batch size for processing
-        max_iterations : int
+        concurrency : int | None, default=None
+            The number of concurrent threads
+        max_iterations : int, default=10
             The maximum number of iterations of K-1 Coloring to run
-        relationship_types : list[str]
-            The relationship types used to select relationships for this algorithm run
         node_labels : list[str]
             The node labels used to select nodes for this algorithm run
-        concurrency : Any | None, default=None
-            The number of concurrent threads
+        relationship_types : list[str]
+            The relationship types used to select relationships for this algorithm run
 
         Returns
         -------