Skip to content

Commit

Permalink
core[runnables]: docstring for class runnable, method with_listeners() (
Browse files Browse the repository at this point in the history
#19515)

**Description:** Docstring for method with_listerners() of class
Runnable
**Issue:** [Add in code documentation to core Runnable methods
#18804](#18804)
**Dependencies:** None
  • Loading branch information
sepiatone authored Mar 25, 2024
1 parent 63343b4 commit aa68fd7
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions libs/core/langchain_core/runnables/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1374,6 +1374,26 @@ def with_listeners(
The Run object contains information about the run, including its id,
type, input, output, error, start_time, end_time, and any tags or metadata
added to the run.
Example:
.. code-block:: python
from langchain_core.runnables import RunnableLambda
import time
def test_runnable(time_to_sleep : int):
time.sleep(time_to_sleep)
def fn_start(run_obj : Runnable):
print("start_time:", run_obj.start_time)
def fn_end(run_obj : Runnable):
print("end_time:", run_obj.end_time)
RunnableLambda(test_runnable).with_listeners(
on_start=fn_start,
on_end=fn_end
).invoke(2)
"""
from langchain_core.tracers.root_listeners import RootListenersTracer

Expand Down

0 comments on commit aa68fd7

Please sign in to comment.