Skip to content

Commit

Permalink
Automated reference documentation update for PR 40 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 4, 2024
1 parent c88cba1 commit 46bf27a
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions docs/dagrunner.execute_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ see [function: dagrunner.utils.visualisation.visualise_graph](dagrunner.utils.vi

## class: `ExecuteGraph`

[Source](../dagrunner/execute_graph.py#L170)
[Source](../dagrunner/execute_graph.py#L197)

### Call Signature:

Expand All @@ -24,7 +24,7 @@ ExecuteGraph(networkx_graph: str, <function plugin_executor>, scheduler: str = '

### function: `__call__`

[Source](../dagrunner/execute_graph.py#L264)
[Source](../dagrunner/execute_graph.py#L291)

#### Call Signature:

Expand All @@ -36,7 +36,7 @@ Call self as a function.

### function: `__init__`

[Source](../dagrunner/execute_graph.py#L171)
[Source](../dagrunner/execute_graph.py#L198)

#### Call Signature:

Expand Down Expand Up @@ -76,7 +76,7 @@ Args:

### function: `visualise`

[Source](../dagrunner/execute_graph.py#L261)
[Source](../dagrunner/execute_graph.py#L288)

#### Call Signature:

Expand All @@ -99,7 +99,7 @@ subsequent tasks.

## function: `main`

[Source](../dagrunner/execute_graph.py#L277)
[Source](../dagrunner/execute_graph.py#L304)

### Call Signature:

Expand All @@ -112,7 +112,7 @@ Parses command line arguments and executes the graph using the ExecuteGraph clas

## function: `plugin_executor`

[Source](../dagrunner/execute_graph.py#L41)
[Source](../dagrunner/execute_graph.py#L50)

### Call Signature:

Expand All @@ -124,12 +124,14 @@ Executes a plugin function or method with the provided arguments and keyword arg

Args:
- `*args`: Positional arguments to be passed to the plugin function or method.
- `call`: A tuple containing the callable object or python dot path to one, and its keyword arguments.
- `call`: A tuple containing the callable object or python dot path to one, keyword arguments
to instantiate this class (optional and where this callable is a class) and finally the keyword
arguments to be passed to this callable.
- `verbose`: A boolean indicating whether to print verbose output.
- `dry_run`: A boolean indicating whether to perform a dry run without executing the plugin.
- `common_kwargs`: A dictionary of optional keyword arguments to apply to all applicable plugins.
That is, being passed to the plugin call if such keywords are expected from the plugin.
This is a useful alternative to global or environment variable usage.
That is, being passed to the plugin initialisation and or call if such keywords are expected
from the plugin. This is a useful alternative to global or environment variable usage.
- `**node_properties`: Node properties. These will be passed to 'node-aware' plugins.

Returns:
Expand Down

0 comments on commit 46bf27a

Please sign in to comment.