You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tracing_ext.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# method_call_ctx_factory - tracing extention of pandas_flavor
2
2
3
3
`method_call_ctx_factory` global var defined in [pandas_flavor/register.py](https://github.com/pyjanitor-devs/pandas_flavor/blob/c60bfd43adbcc304b3455055af73ed9fc9ac10d1/pandas_flavor/register.py#L8) is used
4
-
as an extention to allow registered method to be traced.
4
+
to allow the methods registered via `pandas_flavors` to be traced.
5
5
6
-
Default value of `method_call_ctx_factory` is None.
6
+
Default value of `method_call_ctx_factory` is None.
7
7
8
-
Starting version 0.5.0 `pandas_flavor` implements the way to pass registerd method name, signature and parameters to
8
+
Starting version 0.5.0 `pandas_flavor` implements the way to pass registered method name, signature and parameters to
9
9
be handled by user-defined object when the call is made. To allow this the user of pandas_flavor must set
10
10
`method_call_ctx_factory` to refer to function with signature `(method_name: str, method_args: list, method_kwargs: dict) -> tracing_ctx`.
11
11
`tracing_ctx` should be class which implements methods with signatures as below:
@@ -29,4 +29,4 @@ So `handle_start_method_call` and `handle_end_method_call` will have the chance
29
29
Aslo, __exit__ method will be called if any exception would occur. This way it is possible to handle the situation of
30
30
actual method ends by raising exception.
31
31
32
-
The example of tracer class implementation and factory function registration is given in [tracing_ext-demo.py...](...)
32
+
The example of tracer class implementation and factory function registration is given in [tracing_ext-demo.py](/docs/tracing_ext-demo.py)
0 commit comments