Session
kedro.framework.session ¶
kedro.framework.session provides access to KedroSession responsible for
project lifecycle.
| Module | Description |
|---|---|
AbstractSession |
Base class for all Kedro session implementations. |
KedroSession |
Implements Kedro session responsible for project lifecycle. |
KedroServiceSession |
Implements Kedro service session responsible for project lifecycle. |
BaseSessionStore |
Implements a dict-like store object used to persist Kedro sessions. |
KedroSessionError |
Raised by KedroSession and KedroServiceSession when they encounter an error. |
kedro.framework.session.abstract_session.AbstractSession ¶
Bases: ABC
AbstractSession is the base class for all Kedro session implementations.
Subclasses must implement the create, close, and run methods.
__enter__ ¶
__enter__()
Source code in kedro/framework/session/abstract_session.py
33 34 | |
__exit__ ¶
__exit__(_exc_type, _exc_value, _tb)
Source code in kedro/framework/session/abstract_session.py
36 37 | |
close
abstractmethod
¶
close()
Close the current session.
Source code in kedro/framework/session/abstract_session.py
23 24 25 26 | |
create
abstractmethod
classmethod
¶
create()
Create a new instance of the session.
Source code in kedro/framework/session/abstract_session.py
15 16 17 18 19 20 21 | |
run
abstractmethod
¶
run()
Run the pipeline.
Source code in kedro/framework/session/abstract_session.py
28 29 30 31 | |
kedro.framework.session.session.KedroSession ¶
KedroSession(session_id, package_name=None, project_path=None, save_on_close=False, conf_source=None)
Bases: AbstractSession
KedroSession is the object that is responsible for managing the lifecycle
of a Kedro run. Use KedroSession.create() as
a context manager to construct a new KedroSession with session data
provided (see the example below).
Example:
from kedro.framework.session import KedroSession
from kedro.framework.startup import bootstrap_project
from pathlib import Path
# If you are creating a session outside of a Kedro project (i.e. not using
# `kedro run` or `kedro jupyter`), you need to run `bootstrap_project` to
# let Kedro find your configuration.
bootstrap_project(Path("<project_root>"))
with KedroSession.create() as session:
session.run()
Source code in kedro/framework/session/session.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | |
__exit__ ¶
__exit__(exc_type, exc_value, tb_)
Source code in kedro/framework/session/session.py
269 270 271 272 | |
_get_config_loader ¶
_get_config_loader()
An instance of the config loader.
Source code in kedro/framework/session/session.py
249 250 251 252 253 254 255 256 257 258 259 260 | |
_init_store ¶
_init_store()
Source code in kedro/framework/session/session.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | |
_log_exception ¶
_log_exception(exc_type, exc_value, exc_tb)
Source code in kedro/framework/session/session.py
211 212 213 214 215 216 217 218 219 220 | |
close ¶
close()
Close the current session and save its store to disk
if save_on_close attribute is True.
Source code in kedro/framework/session/session.py
262 263 264 265 266 267 | |
create
classmethod
¶
create(project_path=None, save_on_close=True, env=None, runtime_params=None, conf_source=None)
Create a new instance of KedroSession with the session data.
Parameters:
-
project_path(Path | str | None, default:None) –Path to the project root directory. Default is current working directory Path.cwd().
-
save_on_close(bool, default:True) –Whether or not to save the session when it's closed.
-
conf_source(str | None, default:None) –Path to a directory containing configuration
-
env(str | None, default:None) –Environment for the KedroContext.
-
runtime_params(dict[str, Any] | None, default:None) –Optional dictionary containing extra project parameters for underlying KedroContext. If specified, will update (and therefore take precedence over) the parameters retrieved from the project configuration.
Returns:
-
KedroSession–A new
KedroSessioninstance.
Source code in kedro/framework/session/session.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | |
load_context ¶
load_context()
An instance of the project context.
Source code in kedro/framework/session/session.py
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | |
run ¶
run(pipeline_name=None, pipeline_names=None, tags=None, runner=None, node_names=None, from_nodes=None, to_nodes=None, from_inputs=None, to_outputs=None, load_versions=None, namespaces=None, only_missing_outputs=False)
Runs the pipeline with a specified runner.
Parameters:
-
pipeline_name(str | None, default:None) –Name of the pipeline that is being run.
-
pipeline_names(list[str] | None, default:None) –Name of the pipelines that is being run.
-
tags(Iterable[str] | None, default:None) –An optional list of node tags which should be used to filter the nodes of the
Pipeline. If specified, only the nodes containing any of these tags will be run. -
runner(AbstractRunner | None, default:None) –An optional parameter specifying the runner that you want to run the pipeline with.
-
node_names(Iterable[str] | None, default:None) –An optional list of node names which should be used to filter the nodes of the
Pipeline. If specified, only the nodes with these names will be run. -
from_nodes(Iterable[str] | None, default:None) –An optional list of node names which should be used as a starting point of the new
Pipeline. -
to_nodes(Iterable[str] | None, default:None) –An optional list of node names which should be used as an end point of the new
Pipeline. -
from_inputs(Iterable[str] | None, default:None) –An optional list of input datasets which should be used as a starting point of the new
Pipeline. -
to_outputs(Iterable[str] | None, default:None) –An optional list of output datasets which should be used as an end point of the new
Pipeline. -
load_versions(dict[str, str] | None, default:None) –An optional flag to specify a particular dataset version timestamp to load.
-
namespaces(Iterable[str] | None, default:None) –The namespaces of the nodes that are being run.
-
only_missing_outputs(bool, default:False) –Run only nodes with missing outputs.
Raises:
ValueError: If the named or __default__ pipeline is not
defined by register_pipelines.
Exception: Any uncaught exception during the run will be re-raised
after being passed to on_pipeline_error hook.
KedroSessionError: If more than one run is attempted to be executed during
a single session.
Returns:
Dictionary with pipeline outputs, where keys are dataset names
and values are dataset objects.
Source code in kedro/framework/session/session.py
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 | |
kedro.framework.session.service_session.KedroServiceSession ¶
KedroServiceSession(session_id, package_name=None, project_path=None, conf_source=None, env=None)
Bases: AbstractSession
KedroServiceSession is the object that is responsible for managing the lifecycle
of multiple Kedro runs. Use KedroServiceSession.create() as
a context manager to construct a new KedroServiceSession with session data
provided (see the example below).
Example:
from kedro.framework.session import KedroServiceSession
from kedro.framework.startup import bootstrap_project
from pathlib import Path
# If you are creating a session outside of a Kedro project (i.e. not using
# `kedro run` or `kedro jupyter`), you need to run `bootstrap_project` to
# let Kedro find your configuration.
bootstrap_project(Path("<project_root>"))
with KedroServiceSession.create() as session:
run_1 = session.run(runtime_params={"param1": "value1"})
run_2 = session.run(runtime_params={"param1": "value2"})
Source code in kedro/framework/session/service_session.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
_get_config_loader ¶
_get_config_loader(runtime_params=None)
An instance of the config loader.
Source code in kedro/framework/session/service_session.py
108 109 110 111 112 113 114 115 116 117 118 | |
close ¶
close()
Source code in kedro/framework/session/service_session.py
105 106 | |
create
classmethod
¶
create(session_id=None, project_path=None, env=None, conf_source=None)
Create a new instance of the session.
Source code in kedro/framework/session/service_session.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | |
load_context ¶
load_context(runtime_params=None)
An instance of the project context with runtime parameters injected.
Source code in kedro/framework/session/service_session.py
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
run ¶
run(run_id=None, pipeline_names=None, tags=None, runner=None, node_names=None, from_nodes=None, to_nodes=None, from_inputs=None, to_outputs=None, load_versions=None, namespaces=None, only_missing_outputs=False, runtime_params=None)
Run the pipeline.
Source code in kedro/framework/session/service_session.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
kedro.framework.session.store.BaseSessionStore ¶
BaseSessionStore(path, session_id)
Bases: UserDict
BaseSessionStore is the base class for all session stores.
BaseSessionStore is an ephemeral store implementation that doesn't
persist the session data.
Source code in kedro/framework/session/store.py
16 17 18 19 | |
read ¶
read()
Read the data from the session store.
Returns:
-
dict[str, Any]–A mapping containing the session store data.
Source code in kedro/framework/session/store.py
25 26 27 28 29 30 31 32 33 34 35 | |
save ¶
save()
Persist the session store
Source code in kedro/framework/session/store.py
37 38 39 40 41 42 | |
kedro.framework.session.abstract_session.KedroSessionError ¶
Bases: Exception
KedroSessionError raised by KedroSession and KedroServiceSession
when they encounter an error.