From 930f2ef01d9d87aeff2a3851bf3a583027c4d2b8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 14 Dec 2023 16:49:27 +0000 Subject: [PATCH] Update unreleased documentation (#504) * Update versions.json * Deployed ccc962ff6 to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0 * Sort docs versions --------- Co-authored-by: GitHub Actions Bot --- .../api-ref/prefect/engine/index.html | 1192 ++++++++--------- .../deployment/push-work-pools/index.html | 20 +- versions/unreleased/search/search_index.json | 2 +- versions/unreleased/sitemap.xml.gz | Bin 1443 -> 1443 bytes 4 files changed, 607 insertions(+), 607 deletions(-) diff --git a/versions/unreleased/api-ref/prefect/engine/index.html b/versions/unreleased/api-ref/prefect/engine/index.html index fb4c845113..38f28cf41b 100644 --- a/versions/unreleased/api-ref/prefect/engine/index.html +++ b/versions/unreleased/api-ref/prefect/engine/index.html @@ -7640,9 +7640,7 @@

Source code in prefect/engine.py - 
468
-469
-470
+            
470
 471
 472
 473
@@ -7745,7 +7743,9 @@ 

 570
 571
 572
-573
async def begin_flow_run(
+573
+574
+575
async def begin_flow_run(
     flow: Flow,
     flow_run: FlowRun,
     parameters: Dict[str, Any],
@@ -7879,55 +7879,7 @@ 

 
           

             Source code in prefect/engine.py
-            
1319
-1320
-1321
-1322
-1323
-1324
-1325
-1326
-1327
-1328
-1329
-1330
-1331
-1332
-1333
-1334
-1335
-1336
-1337
-1338
-1339
-1340
-1341
-1342
-1343
-1344
-1345
-1346
-1347
-1348
-1349
-1350
-1351
-1352
-1353
-1354
-1355
-1356
-1357
-1358
-1359
-1360
-1361
-1362
-1363
-1364
-1365
-1366
-1367
+            
1367
 1368
 1369
 1370
@@ -7971,7 +7923,55 @@ 

 1408
 1409
 1410
-1411
async def begin_task_map(
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
async def begin_task_map(
     task: Task,
     flow_run_context: FlowRunContext,
     parameters: Dict[str, Any],
@@ -8111,55 +8111,7 @@ 

 
           

             Source code in prefect/engine.py
-            
1645
-1646
-1647
-1648
-1649
-1650
-1651
-1652
-1653
-1654
-1655
-1656
-1657
-1658
-1659
-1660
-1661
-1662
-1663
-1664
-1665
-1666
-1667
-1668
-1669
-1670
-1671
-1672
-1673
-1674
-1675
-1676
-1677
-1678
-1679
-1680
-1681
-1682
-1683
-1684
-1685
-1686
-1687
-1688
-1689
-1690
-1691
-1692
-1693
+            
1693
 1694
 1695
 1696
@@ -8227,7 +8179,55 @@ 

 1758
 1759
 1760
-1761
async def begin_task_run(
+1761
+1762
+1763
+1764
+1765
+1766
+1767
+1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
async def begin_task_run(
     task: Task,
     task_run: TaskRun,
     parameters: Dict[str, Any],
@@ -8382,50 +8382,50 @@ 

 
           

             Source code in prefect/engine.py
-            
1414
-1415
-1416
-1417
-1418
-1419
-1420
-1421
-1422
-1423
-1424
-1425
-1426
-1427
-1428
-1429
-1430
-1431
-1432
-1433
-1434
-1435
-1436
-1437
-1438
-1439
-1440
-1441
-1442
-1443
-1444
-1445
-1446
-1447
-1448
-1449
-1450
-1451
-1452
-1453
-1454
-1455
-1456
-1457
async def collect_task_run_inputs(expr: Any, max_depth: int = -1) -> Set[TaskRunInput]:
+            
1462
+1463
+1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
async def collect_task_run_inputs(expr: Any, max_depth: int = -1) -> Set[TaskRunInput]:
     """
     This function recurses through an expression to generate a set of any discernible
     task run inputs it finds in the data structure. It produces a set of all inputs
@@ -8525,9 +8525,7 @@ 

 
           

             Source code in prefect/engine.py
-            
576
-577
-578
+            
578
 579
 580
 581
@@ -8682,7 +8680,9 @@ 

 730
 731
 732
-733
@inject_client
+733
+734
+735
@inject_client
 async def create_and_begin_subflow_run(
     flow: Flow,
     parameters: Dict[str, Any],
@@ -8869,9 +8869,7 @@ 

 
           

             Source code in prefect/engine.py
-            
327
-328
-329
+            
329
 330
 331
 332
@@ -8936,7 +8934,9 @@ 

 391
 392
 393
-394
@inject_client
+394
+395
+396
@inject_client
 async def create_then_begin_flow_run(
     flow: Flow,
     parameters: Dict[str, Any],
@@ -9030,9 +9030,7 @@ 

             Source code in prefect/engine.py
-            
218
-219
-220
+            
220
 221
 222
 223
@@ -9107,7 +9105,9 @@ 
292
 293
 294
-295
def enter_flow_run_engine_from_flow_call(
+295
+296
+297
def enter_flow_run_engine_from_flow_call(
     flow: Flow,
     parameters: Dict[str, Any],
     wait_for: Optional[Iterable[PrefectFuture]],
@@ -9213,9 +9213,7 @@ 

             Source code in prefect/engine.py
-            
298
-299
-300
+            
300
 301
 302
 303
@@ -9239,7 +9237,9 @@ 
321
 322
 323
-324
def enter_flow_run_engine_from_subprocess(flow_run_id: UUID) -> State:
+324
+325
+326
def enter_flow_run_engine_from_subprocess(flow_run_id: UUID) -> State:
     """
     Sync entrypoint for flow runs that have been submitted for execution by an agent
 
@@ -9290,49 +9290,49 @@ 

 
           

             Source code in prefect/engine.py
-            
1274
-1275
-1276
-1277
-1278
-1279
-1280
-1281
-1282
-1283
-1284
-1285
-1286
-1287
-1288
-1289
-1290
-1291
-1292
-1293
-1294
-1295
-1296
-1297
-1298
-1299
-1300
-1301
-1302
-1303
-1304
-1305
-1306
-1307
-1308
-1309
-1310
-1311
-1312
-1313
-1314
-1315
-1316
def enter_task_run_engine(
+            
1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
def enter_task_run_engine(
     task: Task,
     parameters: Dict[str, Any],
     wait_for: Optional[Iterable[PrefectFuture]],
@@ -9400,17 +9400,17 @@ 

 
           

             Source code in prefect/engine.py
-            
2465
-2466
-2467
-2468
-2469
-2470
-2471
-2472
-2473
def get_state_for_result(obj: Any) -> Optional[State]:
-    """
-    Get the state related to a result object.
+            
2513
+2514
+2515
+2516
+2517
+2518
+2519
+2520
+2521
def get_state_for_result(obj: Any) -> Optional[State]:
+    """
+    Get the state related to a result object.
 
     `link_state_to_result` must have been called first.
     """
@@ -9468,61 +9468,61 @@