Align signatures of pw.run and pw.run_all. (#5502)

* Align signatures and add docstring

* kwonly

* Add breaking entry in changelog

* Update public/pathway/CHANGELOG.md

Co-authored-by: Michał Bartoszkiewicz <[email protected]>

---------

Co-authored-by: Michał Bartoszkiewicz <[email protected]>
GitOrigin-RevId: 9a48ce60d23e62a74ad8e16eb011c5c2f01dc100

Author: 2 people

CHANGELOG.md

@@ -9,6 +9,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `pw.io.http.rest_connector` can now handle different kinds of HTTP requests.
 - `pw.io.http.PathwayWebserver` can now enable CORS on the added endpoints.
 
+### Changed
+- `pw.run` now takes additional parameter `runtime_typechecking` allowing to enable strict type checking at runtime.
+- **BREAKING**: `pw.run` and `pw.run_all` now take only keyword arguments.
+
 ### Fixed
 - Returning `pw.Duration` from UDFs or using them as constant values no longer results in errors.
 
@@ -28,7 +32,6 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - `pw.io.http.rest_connector` now also accepts port as a string for backwards compatibility.
 - `pw.stdlib.ml.index.KNNIndex` now sorts by distance by default.
 
-
 ## [0.7.8] - 2024-01-18
 
 ### Added

python/pathway/internals/run.py

@@ -10,11 +10,13 @@
 
 @check_arg_types
 def run(
+    *,
     debug: bool = False,
     monitoring_level: MonitoringLevel = MonitoringLevel.AUTO,
     with_http_server: bool = False,
     default_logging: bool = True,
     persistence_config: PersistenceConfig | None = None,
+    runtime_typechecking: bool | None = None,
 ):
     """Runs the computation graph.
 
@@ -30,6 +32,7 @@ def run(
             it to False if you want to set your own logging handler.
         persistence_config: the config for persisting the state in case this
             persistence is required.
+        runtime_typechecking: enables additional strict type checking at runtime
     """
     GraphRunner(
         parse_graph.G,
@@ -38,22 +41,42 @@ def run(
         with_http_server=with_http_server,
         default_logging=default_logging,
         persistence_config=persistence_config,
+        runtime_typechecking=runtime_typechecking,
     ).run_outputs()
 
 
 @check_arg_types
 def run_all(
+    *,
     debug: bool = False,
     monitoring_level: MonitoringLevel = MonitoringLevel.AUTO,
     with_http_server: bool = False,
     default_logging: bool = True,
+    persistence_config: PersistenceConfig | None = None,
     runtime_typechecking: bool | None = None,
 ):
+    """Runs the computation graph with disabled tree-shaking optimization.
+
+    Args:
+        debug: enable output out of table.debug() operators
+        monitoring_level: the verbosity of stats monitoring mechanism. One of
+            pathway.MonitoringLevel.NONE, pathway.MonitoringLevel.IN_OUT,
+            pathway.MonitoringLevel.ALL. If unset, pathway will choose between
+            NONE and IN_OUT based on output interactivity.
+        with_http_server: whether to start a http server with runtime metrics. Learn
+            more in a `tutorial </developers/user-guide/deployment/prometheus-monitoring/>`_ .
+        default_logging: whether to allow pathway to set its own logging handler. Set
+            it to False if you want to set your own logging handler.
+        persistence_config: the config for persisting the state in case this
+            persistence is required.
+        runtime_typechecking: enables additional strict type checking at runtime
+    """
     GraphRunner(
         parse_graph.G,
         debug=debug,
         monitoring_level=monitoring_level,
         with_http_server=with_http_server,
         default_logging=default_logging,
+        persistence_config=persistence_config,
         runtime_typechecking=runtime_typechecking,
     ).run_all()

python/pathway/tests/test_common.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import functools
+import inspect
 import os
 import pathlib
 import re
@@ -6077,3 +6078,7 @@ def test_reducers_ix(reducer, expected, expected_type):
     )
 
     assert_table_equality_wo_index(result, expected)
+
+
+def test_pw_run_signature():
+    assert inspect.signature(pw.run) == inspect.signature(pw.run_all)