/usr/lib/python2.7/dist-packages/cylc/config.py is in python-cylc 7.6.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 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 127 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 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 266 267 268 269 270 271 272 273 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 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 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 1317 1318 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 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 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 1460 1461 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 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 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 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 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 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 | #!/usr/bin/env python
# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2017 NIWA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Parse and validate the suite definition file
Do some consistency checking, then construct task proxy objects and graph
structures.
"""
from copy import copy
from fnmatch import fnmatchcase
import os
import re
import traceback
from cylc.c3mro import C3
from cylc.conditional_simplifier import ConditionalSimplifier
from cylc.exceptions import CylcError
from cylc.graph_parser import GraphParser
from cylc.param_expand import NameExpander
from cylc.cfgspec.suite import RawSuiteConfig
from cylc.cycling.loader import (
get_point, get_point_relative, get_interval, get_interval_cls,
get_sequence, get_sequence_cls, init_cyclers, INTEGER_CYCLING_TYPE,
ISO8601_CYCLING_TYPE)
from cylc.cycling import IntervalParsingError
from cylc.envvar import check_varnames
import cylc.flags
from cylc.graphnode import GraphNodeParser, GraphNodeError
from cylc.print_tree import print_tree
from cylc.taskdef import TaskDef, TaskDefError
from cylc.task_id import TaskID
from cylc.task_trigger import TaskTrigger, Dependency
from cylc.wallclock import get_current_time_string
from isodatetime.data import Calendar
from isodatetime.parsers import DurationParser
from parsec.OrderedDict import OrderedDictWithDefaults
from parsec.util import replicate
from cylc.suite_logging import OUT, ERR
from cylc.task_outputs import TASK_OUTPUT_SUCCEEDED
RE_CLOCK_OFFSET = re.compile(r'(' + TaskID.NAME_RE + r')(?:\(\s*(.+)\s*\))?')
RE_EXT_TRIGGER = re.compile(r'(.*)\s*\(\s*(.+)\s*\)\s*')
RE_SEC_MULTI_SEQ = re.compile(r'(?![^(]+\)),')
RE_SUITE_NAME_VAR = re.compile(r'\${?CYLC_SUITE_(REG_)?NAME}?')
RE_TASK_NAME_VAR = re.compile(r'\${?CYLC_TASK_NAME}?')
NUM_RUNAHEAD_SEQ_POINTS = 5 # Number of cycle points to look at per sequence.
# Message trigger offset regex.
BCOMPAT_MSG_RE_C6 = re.compile(r'^(.*)\[\s*(([+-])?\s*(.*))?\s*\](.*)$')
class SuiteConfigError(Exception):
"""
Attributes:
message - what the problem is.
TODO - element - config element causing the problem
"""
def __init__(self, msg):
self.msg = msg
def __str__(self):
return repr(self.msg)
# TODO: separate config for run and non-run purposes?
class SuiteConfig(object):
"""Class for suite configuration items and derived quantities."""
_INSTANCES = {}
Q_DEFAULT = 'default'
@classmethod
def get_inst(cls, suite=None, fpath=None, template_vars=None,
owner=None, run_mode='live', is_validate=False, strict=False,
collapsed=[], cli_initial_point_string=None,
cli_start_point_string=None, cli_final_point_string=None,
is_reload=False, output_fname=None,
vis_start_string=None, vis_stop_string=None,
mem_log_func=None):
"""Return a singleton instance.
On 1st call, instantiate the singleton.
Argument list is only relevant on 1st call.
"""
if suite not in cls._INSTANCES or is_reload:
cls._INSTANCES[suite] = cls(
suite, fpath, template_vars, owner,
run_mode, is_validate, strict, collapsed,
cli_initial_point_string, cli_start_point_string,
cli_final_point_string, is_reload, output_fname,
vis_start_string, vis_stop_string, mem_log_func)
# Default instance
if suite is not None:
cls._INSTANCES[None] = cls._INSTANCES[suite]
return cls._INSTANCES[suite]
def __init__(self, suite, fpath, template_vars=None,
owner=None, run_mode='live', is_validate=False, strict=False,
collapsed=[], cli_initial_point_string=None,
cli_start_point_string=None, cli_final_point_string=None,
is_reload=False, output_fname=None,
vis_start_string=None, vis_stop_string=None,
mem_log_func=None):
self.mem_log = mem_log_func
if mem_log_func is None:
self.mem_log = lambda *a: False
self.mem_log("config.py:config.py: start init config")
self.suite = suite # suite name
self.fpath = fpath # suite definition
self.fdir = os.path.dirname(fpath)
self.owner = owner
self.run_mode = run_mode
self.strict = strict
self.naked_dummy_tasks = []
self.edges = {}
self.taskdefs = {}
self.initial_point = None
self.start_point = None
self.first_graph = True
self.clock_offsets = {}
self.expiration_offsets = {}
self.ext_triggers = {}
self.suite_polling_tasks = {}
self.vis_start_point_string = vis_start_string
self.vis_stop_point_string = vis_stop_string
self._last_graph_raw_id = None
self._last_graph_raw_edges = []
self.sequences = []
self.actual_first_point = None
self._start_point_for_actual_first_point = None
self.task_param_vars = {}
self.custom_runahead_limit = None
self.max_num_active_cycle_points = None
# runtime hierarchy dicts keyed by namespace name:
self.runtime = {
# lists of parent namespaces
'parents': {},
# lists of C3-linearized ancestor namespaces
'linearized ancestors': {},
# lists of first-parent ancestor namepaces
'first-parent ancestors': {},
# lists of all descendant namespaces
# (not including the final tasks)
'descendants': {},
# lists of all descendant namespaces from the first-parent
# hierarchy (first parents are collapsible in suite
# visualization)
'first-parent descendants': {},
}
# tasks
self.leaves = []
# one up from root
self.feet = []
# parse, upgrade, validate the suite, but don't expand with default
# items
self.mem_log("config.py: before RawSuiteConfig.get_inst")
self.pcfg = RawSuiteConfig.get_inst(
fpath, is_reload=is_reload, tvars=template_vars,
output_fname=output_fname)
self.mem_log("config.py: after RawSuiteConfig.get_inst")
self.mem_log("config.py: before get(sparse=True")
self.cfg = self.pcfg.get(sparse=True)
self.mem_log("config.py: after get(sparse=True)")
# First check for the essential scheduling section.
if 'scheduling' not in self.cfg:
raise SuiteConfigError("ERROR: missing [scheduling] section.")
if 'dependencies' not in self.cfg['scheduling']:
raise SuiteConfigError(
"ERROR: missing [scheduling][[dependencies]] section.")
# (The check that 'graph' is definied is below).
# The two runahead limiting schemes are mutually exclusive.
rlim = self.cfg['scheduling'].get('runahead limit', None)
mact = self.cfg['scheduling'].get('max active cycle points', None)
if rlim is not None and mact is not None:
raise SuiteConfigError(
"ERROR: use 'runahead limit' OR "
"'max active cycle points', not both")
# Override the suite defn with an initial point from the CLI.
if cli_initial_point_string is not None:
self.cfg['scheduling']['initial cycle point'] = (
cli_initial_point_string)
dependency_map = self.cfg.get('scheduling', {}).get(
'dependencies', {})
if not self.is_graph_defined(dependency_map):
raise SuiteConfigError('No suite dependency graph defined.')
if 'cycling mode' not in self.cfg.get('scheduling', {}):
# Auto-detect integer cycling for pure async graph suites.
if dependency_map.get('graph'):
# There is an async graph setting.
# If it is by itself, it is integer shorthand.
# If there are cycling graphs as well, it is obsolete
# (pre cylc-6) syntax.
just_has_async_graph = True
non_async_item = None
for item, value in dependency_map.items():
if item != 'graph' and value.get('graph'):
just_has_async_graph = False
non_async_item = item
break
icp = self.cfg['scheduling'].get('initial cycle point')
fcp = self.cfg['scheduling'].get('final cycle point')
if just_has_async_graph and not (
icp in [None, "1"] and fcp in [None, icp]):
raise SuiteConfigError(
'Conflicting syntax: integer vs ' +
'cycling suite: ' +
'are you missing a [dependencies][[[R1]]] section?')
if just_has_async_graph:
# There aren't any other graphs, so set integer cycling.
self.cfg['scheduling']['cycling mode'] = (
INTEGER_CYCLING_TYPE
)
if 'initial cycle point' not in self.cfg['scheduling']:
self.cfg['scheduling']['initial cycle point'] = "1"
if 'final cycle point' not in self.cfg['scheduling']:
self.cfg['scheduling']['final cycle point'] = "1"
else:
# Looks like cylc-5 mixed-async.
raise SuiteConfigError(
'Obsolete syntax: mixed integer [dependencies]graph ' +
'with cycling [dependencies][{0}]'.format(
non_async_item)
)
# allow test suites with no [runtime]:
if 'runtime' not in self.cfg:
self.cfg['runtime'] = OrderedDictWithDefaults()
if 'root' not in self.cfg['runtime']:
self.cfg['runtime']['root'] = OrderedDictWithDefaults()
try:
parameter_values = self.cfg['cylc']['parameters']
except KeyError:
# (Suite config defaults not put in yet.)
parameter_values = {}
try:
parameter_templates = self.cfg['cylc']['parameter templates']
except KeyError:
parameter_templates = {}
# parameter values and templates are normally needed together.
self.parameters = (parameter_values, parameter_templates)
if cylc.flags.verbose:
OUT.info(
"Expanding [runtime] namespace lists and parameters")
# Set default parameter expansion templates if necessary.
for pname, pvalues in parameter_values.items():
if pname not in parameter_templates:
try:
[int(i) for i in pvalues]
except ValueError:
# Don't prefix string values with the parameter name.
parameter_templates[pname] = "_%(" + pname + ")s"
else:
# All int values, prefix values with the parameter name.
parameter_templates[pname] = (
"_" + pname + "%(" + pname + ")s")
# Expand parameters in 'special task' lists.
if 'special tasks' in self.cfg['scheduling']:
for spec, names in self.cfg['scheduling']['special tasks'].items():
self.cfg['scheduling']['special tasks'][spec] = (
self._expand_name_list(names))
# Expand parameters in internal queue member lists.
if 'queues' in self.cfg['scheduling']:
for queue, cfg in self.cfg['scheduling']['queues'].items():
if 'members' not in cfg:
continue
self.cfg['scheduling']['queues'][queue]['members'] = (
self._expand_name_list(cfg['members']))
self.mem_log("config.py: before _expand_runtime")
self._expand_runtime()
self.mem_log("config.py: after _expand_runtime")
self.ns_defn_order = self.cfg['runtime'].keys()
# check var names before inheritance to avoid repetition
self.check_env_names()
self.mem_log("config.py: before compute_family_tree")
# do sparse inheritance
self.compute_family_tree()
self.mem_log("config.py: after compute_family_tree")
self.mem_log("config.py: before inheritance")
self.compute_inheritance()
self.mem_log("config.py: after inheritance")
# self.print_inheritance() # (debugging)
# filter task environment variables after inheritance
self.filter_env()
# Now add config defaults. Items added prior to this ends up in the
# sparse dict (e.g. parameter-expanded namepaces).
self.mem_log("config.py: before get(sparse=False)")
self.cfg = self.pcfg.get(sparse=False)
self.mem_log("config.py: after get(sparse=False)")
# after the call to init_cyclers, we can start getting proper points.
init_cyclers(self.cfg)
# Running in UTC time? (else just use the system clock)
cylc.flags.utc = self.cfg['cylc']['UTC mode']
# Capture cycling mode
cylc.flags.cycling_mode = self.cfg['scheduling']['cycling mode']
# Initial point from suite definition (or CLI override above).
icp = self.cfg['scheduling']['initial cycle point']
if icp is None:
raise SuiteConfigError(
"This suite requires an initial cycle point.")
if icp == "now":
icp = get_current_time_string()
self.initial_point = get_point(icp).standardise()
self.cfg['scheduling']['initial cycle point'] = str(self.initial_point)
if cli_start_point_string:
# Warm start from a point later than initial point.
if cli_start_point_string == "now":
cli_start_point_string = get_current_time_string()
cli_start_point = get_point(cli_start_point_string).standardise()
self.start_point = cli_start_point
else:
# Cold start.
self.start_point = self.initial_point
# Validate initial cycle point against any constraints
if self.cfg['scheduling']['initial cycle point constraints']:
valid_icp = False
for entry in (
self.cfg['scheduling']['initial cycle point constraints']):
possible_pt = get_point_relative(
entry, self.initial_point
).standardise()
if self.initial_point == possible_pt:
valid_icp = True
break
if not valid_icp:
constraints_str = str(
self.cfg['scheduling']['initial cycle point constraints'])
raise SuiteConfigError(
("Initial cycle point %s does not meet the constraints " +
"%s") % (
str(self.initial_point),
constraints_str
)
)
if (self.cfg['scheduling']['final cycle point'] is not None and
self.cfg['scheduling']['final cycle point'].strip() is ""):
self.cfg['scheduling']['final cycle point'] = None
final_point_string = (cli_final_point_string or
self.cfg['scheduling']['final cycle point'])
final_point = None
if final_point_string is not None:
# Is the final "point"(/interval) relative to initial?
if get_interval_cls().get_null().TYPE == INTEGER_CYCLING_TYPE:
if "P" in final_point_string:
# Relative, integer cycling.
final_point = get_point_relative(
self.cfg['scheduling']['final cycle point'],
self.initial_point
).standardise()
else:
try:
# Relative, ISO8601 cycling.
final_point = get_point_relative(
final_point_string, self.initial_point).standardise()
except ValueError:
# (not relative)
pass
if final_point is None:
# Must be absolute.
final_point = get_point(final_point_string).standardise()
self.cfg['scheduling']['final cycle point'] = str(final_point)
if final_point is not None and self.initial_point > final_point:
raise SuiteConfigError(
"The initial cycle point:" +
str(self.initial_point) + " is after the final cycle point:" +
str(final_point) + ".")
# Validate final cycle point against any constraints
if (final_point is not None and
self.cfg['scheduling']['final cycle point constraints']):
valid_fcp = False
for entry in (
self.cfg['scheduling']['final cycle point constraints']):
possible_pt = get_point_relative(
entry, final_point).standardise()
if final_point == possible_pt:
valid_fcp = True
break
if not valid_fcp:
constraints_str = str(
self.cfg['scheduling']['final cycle point constraints'])
raise SuiteConfigError(
"Final cycle point %s does not meet the constraints %s" % (
str(final_point), constraints_str))
# Parse special task cycle point offsets, and replace family names.
if cylc.flags.verbose:
OUT.info("Parsing [special tasks]")
for s_type in self.cfg['scheduling']['special tasks']:
result = copy(self.cfg['scheduling']['special tasks'][s_type])
extn = ''
for item in self.cfg['scheduling']['special tasks'][s_type]:
name = item
if s_type == 'external-trigger':
match = RE_EXT_TRIGGER.match(item)
if match is None:
raise SuiteConfigError(
"ERROR: Illegal %s spec: %s" % (s_type, item)
)
name, ext_trigger_msg = match.groups()
extn = "(" + ext_trigger_msg + ")"
elif s_type in ['clock-trigger', 'clock-expire']:
match = RE_CLOCK_OFFSET.match(item)
if match is None:
raise SuiteConfigError(
"ERROR: Illegal %s spec: %s" % (s_type, item)
)
if (self.cfg['scheduling']['cycling mode'] !=
Calendar.MODE_GREGORIAN):
raise SuiteConfigError(
"ERROR: %s tasks require "
"[scheduling]cycling mode=%s" % (
s_type, Calendar.MODE_GREGORIAN)
)
name, offset_string = match.groups()
if not offset_string:
offset_string = "PT0M"
if cylc.flags.verbose:
if offset_string.startswith("-"):
ERR.warning(
"%s offsets are normally positive: %s" % (
s_type, item))
try:
offset_interval = (
get_interval(offset_string).standardise())
except IntervalParsingError:
raise SuiteConfigError(
"ERROR: Illegal %s spec: %s" % (
s_type, offset_string))
extn = "(" + offset_string + ")"
# Replace family names with members.
if name in self.runtime['descendants']:
result.remove(item)
for member in self.runtime['descendants'][name]:
if member in self.runtime['descendants']:
# (sub-family)
continue
result.append(member + extn)
if s_type == 'clock-trigger':
self.clock_offsets[member] = offset_interval
if s_type == 'clock-expire':
self.expiration_offsets[member] = offset_interval
if s_type == 'external-trigger':
self.ext_triggers[member] = ext_trigger_msg
elif s_type == 'clock-trigger':
self.clock_offsets[name] = offset_interval
elif s_type == 'clock-expire':
self.expiration_offsets[name] = offset_interval
elif s_type == 'external-trigger':
self.ext_triggers[name] = self.dequote(ext_trigger_msg)
self.cfg['scheduling']['special tasks'][s_type] = result
self.collapsed_families_rc = (
self.cfg['visualization']['collapsed families'])
for fam in self.collapsed_families_rc:
if fam not in self.runtime['first-parent descendants']:
raise SuiteConfigError(
'ERROR [visualization]collapsed families: '
'%s is not a first parent' % fam)
if is_reload:
# on suite reload retain an existing state of collapse
# (used by the "cylc graph" viewer)
self.closed_families = collapsed
else:
self.closed_families = self.collapsed_families_rc
for cfam in self.closed_families:
if cfam not in self.runtime['descendants']:
self.closed_families.remove(cfam)
if not is_reload and cylc.flags.verbose:
ERR.warning(
'[visualization][collapsed families]: ' +
'family ' + cfam + ' not defined')
# check for run mode override at suite level
if self.cfg['cylc']['force run mode']:
self.run_mode = self.cfg['cylc']['force run mode']
self.process_directories()
self.mem_log("config.py: before load_graph()")
self.load_graph()
if not is_validate:
GraphNodeParser.get_inst().clear()
self.mem_log("config.py: after load_graph()")
self.compute_runahead_limits()
self.configure_queues()
if self.run_mode in ['simulation', 'dummy', 'dummy-local']:
self.configure_sim_modes()
self.configure_suite_state_polling_tasks()
# Warn or abort (if --strict) if naked dummy tasks (no runtime
# section) are found in graph or queue config.
if len(self.naked_dummy_tasks) > 0:
if self.strict or cylc.flags.verbose:
err_msg = ('naked dummy tasks detected (no entry'
' under [runtime]):')
for ndt in self.naked_dummy_tasks:
err_msg += '\n+\t' + str(ndt)
ERR.warning(err_msg)
if self.strict:
raise SuiteConfigError(
'ERROR: strict validation fails naked dummy tasks')
if is_validate:
self.check_tasks()
# Check that external trigger messages are only used once (they have to
# be discarded immediately to avoid triggering the next instance of the
# just-triggered task).
seen = {}
for name, tdef in self.taskdefs.items():
for msg in tdef.external_triggers:
if msg not in seen:
seen[msg] = name
else:
ERR.error(
"External trigger '%s'\n used in tasks %s and %s." % (
msg, name, seen[msg]))
raise SuiteConfigError(
"ERROR: external triggers must be used only once.")
ngs = self.cfg['visualization']['node groups']
# If a node group member is a family, include its descendants too.
replace = {}
for ng, mems in ngs.items():
replace[ng] = []
for mem in mems:
replace[ng] += [mem]
if mem in self.runtime['descendants']:
replace[ng] += self.runtime['descendants'][mem]
for ng in replace:
ngs[ng] = replace[ng]
# Define family node groups automatically so that family and
# member nodes can be styled together using the family name.
# Users can override this for individual nodes or sub-groups.
for fam in self.runtime['descendants']:
if fam not in ngs:
ngs[fam] = [fam] + self.runtime['descendants'][fam]
if cylc.flags.verbose:
OUT.info("Checking [visualization] node attributes")
# TODO - these should probably be done in non-verbose mode too.
# 1. node groups should contain valid namespace names
nspaces = self.cfg['runtime'].keys()
bad = {}
for ng, mems in ngs.items():
n_bad = []
for mem in mems:
if mem not in nspaces:
n_bad.append(mem)
if n_bad:
bad[ng] = n_bad
if bad:
err_msg = "undefined node group members"
for ng, mems in bad.items():
err_msg += "\n+ " + ng + ":\t,".join(mems)
ERR.warning(err_msg)
# 2. node attributes must refer to node groups or namespaces
bad = []
for na in self.cfg['visualization']['node attributes']:
if na not in ngs and na not in nspaces:
bad.append(na)
if bad:
err_msg = "undefined node attribute targets"
for na in bad:
err_msg += "\n+ " + str(na)
ERR.warning(err_msg)
# 3. node attributes must be lists of quoted "key=value" pairs.
fail = False
for node, attrs in (
self.cfg['visualization']['node attributes'].items()):
for attr in attrs:
# Check form is 'name = attr'.
if attr.count('=') != 1:
fail = True
ERR.error(
"[visualization][node attributes]%s = %s" % (
node, attr))
if fail:
raise SuiteConfigError("Node attributes must be of the form "
"'key1=value1', 'key2=value2', etc.")
# (Note that we're retaining 'default node attributes' even
# though this could now be achieved by styling the root family,
# because putting default attributes for root in the suite.rc spec
# results in root appearing last in the ordered dict of node
# names, so it overrides the styling for lesser groups and
# nodes, whereas the reverse is needed - fixing this would
# require reordering task_attr in lib/cylc/graphing.py).
self.leaves = self.get_task_name_list()
for ancestors in self.runtime['first-parent ancestors'].values():
try:
foot = ancestors[-2] # one back from 'root'
except IndexError:
pass
else:
if foot not in self.feet:
self.feet.append(foot)
# CLI override for visualization settings.
if self.vis_start_point_string:
self.cfg['visualization']['initial cycle point'] = (
self.vis_start_point_string)
if self.vis_stop_point_string:
self.cfg['visualization']['final cycle point'] = (
self.vis_stop_point_string)
# For static visualization, start point defaults to suite initial
# point; stop point must be explicit with initial point, or None.
if self.cfg['visualization']['initial cycle point'] is None:
self.cfg['visualization']['initial cycle point'] = (
self.cfg['scheduling']['initial cycle point'])
# If viz initial point is None don't accept a final point.
if self.cfg['visualization']['final cycle point'] is not None:
if cylc.flags.verbose:
ERR.warning(
"ignoring [visualization]final cycle point\n"
"(it must be defined with an initial cycle point)")
self.cfg['visualization']['final cycle point'] = None
vfcp = self.cfg['visualization']['final cycle point']
if vfcp:
try:
vfcp = get_point_relative(
self.cfg['visualization']['final cycle point'],
self.initial_point).standardise()
except ValueError:
vfcp = get_point(
self.cfg['visualization']['final cycle point']
).standardise()
else:
vfcp = None
# A viz final point can't be beyond the suite final point.
if vfcp is not None and final_point is not None:
if vfcp > final_point:
self.cfg['visualization']['final cycle point'] = str(
final_point)
# Replace suite name in suite URL.
url = self.cfg['meta']['URL']
if url is not '':
self.cfg['meta']['URL'] = RE_SUITE_NAME_VAR.sub(self.suite, url)
# Replace suite and task name in task URLs.
for name, cfg in self.cfg['runtime'].items():
if cfg['meta']['URL']:
cfg['meta']['URL'] = RE_TASK_NAME_VAR.sub(
name, cfg['meta']['URL'])
cfg['meta']['URL'] = RE_SUITE_NAME_VAR.sub(
self.suite, cfg['meta']['URL'])
if is_validate:
self.mem_log("config.py: before _check_circular()")
self._check_circular()
self.mem_log("config.py: after _check_circular()")
self.mem_log("config.py: end init config")
def _check_circular(self):
"""Check for circular dependence in graph."""
start_point_string = (
self.cfg['visualization']['initial cycle point'])
lhs2rhss = {} # left hand side to right hand sides
rhs2lhss = {} # right hand side to left hand sides
for lhs, rhs in self.get_graph_raw(
start_point_string, stop_point_string=None, is_validate=True):
lhs2rhss.setdefault(lhs, set())
lhs2rhss[lhs].add(rhs)
rhs2lhss.setdefault(rhs, set())
rhs2lhss[rhs].add(lhs)
self._check_circular_helper(lhs2rhss, rhs2lhss)
if rhs2lhss:
# Before reporting circular dependence, pick out all the edges with
# no outgoings.
self._check_circular_helper(rhs2lhss, lhs2rhss)
err_msg = ''
for rhs, lhss in sorted(rhs2lhss.items()):
for lhs in sorted(lhss):
err_msg += ' %s => %s' % (
TaskID.get(*lhs), TaskID.get(*rhs))
if err_msg:
raise SuiteConfigError(
'ERROR: circular edges detected:' + err_msg)
@staticmethod
def _check_circular_helper(x2ys, y2xs):
"""Topological elimination.
An implementation of Kahn's algorithm for topological sorting, but
only use the part for pulling out starter nodes with no incoming
edges. See https://en.wikipedia.org/wiki/Topological_sorting
x2ys is a map of {x1: [y1, y2, ...], ...}
to map edges using x's as keys, such as x1 => y1, x1 => y2, etc
y2xs is a map of {y3: [x4, x5, ...], ...}
to map edges using y's as keys, such as x4 => y3, x5 => y3, etc
"""
# Starter x nodes are those with no incoming, i.e.
# x nodes that never appear as a y.
sxs = set(x01 for x01 in x2ys if x01 not in y2xs)
while sxs:
sx01 = sxs.pop()
for y01 in x2ys[sx01]:
y2xs[y01].remove(sx01)
if not y2xs[y01]:
if y01 in x2ys:
# No need to look at this again if it does not have any
# outgoing.
sxs.add(y01)
del y2xs[y01]
del x2ys[sx01]
def _expand_name_list(self, orig_names):
"""Expand any parameters in lists of names."""
name_expander = NameExpander(self.parameters)
exp_names = []
for orig_name in orig_names:
exp_names += [name for name, _ in name_expander.expand(orig_name)]
return exp_names
def _expand_runtime(self):
"""Expand [runtime] name lists or parameterized names.
This makes individual runtime namespaces out of any headings that
represent multiple namespaces, like [[foo, bar]] or [[foo<m,n>]].
It requires replicating the sparse runtime OrderedDict into a new
OrderedDict - we can't just stick expanded names on the end because the
order matters (for add-or-override by repeated namespaces).
TODO - this will have an impact on memory footprint for large suites
with a lot of runtime config. We should consider ditching OrderedDict
and instead using an ordinary dict with a separate list of keys.
"""
if (not self.parameters[0] and
not any(',' in ns for ns in self.cfg['runtime'])):
# No parameters, no namespace lists: no expansion needed.
return
newruntime = OrderedDictWithDefaults()
name_expander = NameExpander(self.parameters)
for namespace_heading, namespace_dict in self.cfg['runtime'].items():
for name, indices in name_expander.expand(namespace_heading):
if name not in newruntime:
newruntime[name] = OrderedDictWithDefaults()
# Put parameter index values in task environment.
replicate(newruntime[name], namespace_dict)
if indices:
new_environ = OrderedDictWithDefaults()
self.task_param_vars[name] = {}
for p_name, p_val in indices.items():
p_var_name = 'CYLC_TASK_PARAM_%s' % p_name
self.task_param_vars[name][p_var_name] = p_val
if 'environment' in newruntime[name]:
for k, v in newruntime[name]['environment'].items():
new_environ[k] = v
newruntime[name]['environment'] = new_environ
if 'inherit' in newruntime[name]:
parents = newruntime[name]['inherit']
origin = 'inherit = %s' % ' '.join(parents)
repl_parents = []
for parent in parents:
repl_parents.append(name_expander.replace_params(
parent, indices, origin))
newruntime[name]['inherit'] = repl_parents
self.cfg['runtime'] = newruntime
# Parameter expansion of visualization node attributes. TODO - do vis
# 'node groups' too, or deprecate them (use families in 'node attrs').
name_expander = NameExpander(self.parameters)
expanded_node_attrs = OrderedDictWithDefaults()
if 'visualization' not in self.cfg:
self.cfg['visualization'] = OrderedDictWithDefaults()
if 'node attributes' not in self.cfg['visualization']:
self.cfg['visualization']['node attributes'] = (
OrderedDictWithDefaults())
for node, val in self.cfg['visualization']['node attributes'].items():
for name, _ in name_expander.expand(node):
expanded_node_attrs[name] = val
self.cfg['visualization']['node attributes'] = expanded_node_attrs
def is_graph_defined(self, dependency_map):
for item, value in dependency_map.items():
if item == 'graph':
# Async graph.
if value != '':
return True
else:
# Cycling section.
for subitem, subvalue in value.items():
if subitem == 'graph':
if subvalue != '':
return True
return False
def dequote(self, s):
"""Strip quotes off a string."""
if (s[0] == s[-1]) and s.startswith(("'", '"')):
return s[1:-1]
return s
def check_env_names(self):
# check for illegal environment variable names
bad = {}
for label in self.cfg['runtime']:
res = []
if 'environment' in self.cfg['runtime'][label]:
res = check_varnames(self.cfg['runtime'][label]['environment'])
if res:
bad[label] = res
if bad:
err_msg = "bad env variable names:"
for label, vars_ in bad.items():
err_msg += '\nNamespace:\t' + label
for var in vars_:
err_msg += "\n\t\t" + var
ERR.error(err_msg)
raise SuiteConfigError(
"Illegal environment variable name(s) detected")
def filter_env(self):
# filter environment variables after sparse inheritance
for ns in self.cfg['runtime'].values():
try:
oenv = ns['environment']
except KeyError:
# no environment to filter
continue
try:
fincl = ns['environment filter']['include']
except KeyError:
# empty include-filter means include all
fincl = []
try:
fexcl = ns['environment filter']['exclude']
except KeyError:
# empty exclude-filter means exclude none
fexcl = []
if not fincl and not fexcl:
# no filtering to do
continue
nenv = OrderedDictWithDefaults()
for key, val in oenv.items():
if (not fincl or key in fincl) and key not in fexcl:
nenv[key] = val
ns['environment'] = nenv
def compute_family_tree(self):
first_parents = {}
demoted = {}
for name in self.cfg['runtime']:
if name == 'root':
self.runtime['parents'][name] = []
first_parents[name] = []
continue
# get declared parents, with implicit inheritance from root.
pts = self.cfg['runtime'][name].get('inherit', ['root'])
if not pts:
pts = ['root']
for p in pts:
if p == "None":
# see just below
continue
if p not in self.cfg['runtime']:
raise SuiteConfigError(
"ERROR, undefined parent for " + name + ": " + p)
if pts[0] == "None":
if len(pts) < 2:
raise SuiteConfigError(
"ERROR: null parentage for " + name)
demoted[name] = pts[1]
pts = pts[1:]
first_parents[name] = ['root']
else:
first_parents[name] = [pts[0]]
self.runtime['parents'][name] = pts
if cylc.flags.verbose and demoted:
log_msg = "First parent(s) demoted to secondary:\n"
for n, p in demoted.items():
log_msg += " + %s as parent of '%s'\n" % (p, n)
OUT.info(log_msg)
c3 = C3(self.runtime['parents'])
c3_single = C3(first_parents)
for name in self.cfg['runtime']:
try:
self.runtime['linearized ancestors'][name] = c3.mro(name)
self.runtime['first-parent ancestors'][name] = (
c3_single.mro(name))
except RuntimeError:
if cylc.flags.debug:
raise
exc_lines = traceback.format_exc().splitlines()
if exc_lines[-1].startswith(
"RuntimeError: maximum recursion depth exceeded"):
raise SuiteConfigError(
"ERROR: circular [runtime] inheritance?")
raise
for name in self.cfg['runtime']:
ancestors = self.runtime['linearized ancestors'][name]
for p in ancestors[1:]:
if p not in self.runtime['descendants']:
self.runtime['descendants'][p] = []
if name not in self.runtime['descendants'][p]:
self.runtime['descendants'][p].append(name)
first_ancestors = self.runtime['first-parent ancestors'][name]
for p in first_ancestors[1:]:
if p not in self.runtime['first-parent descendants']:
self.runtime['first-parent descendants'][p] = []
if name not in self.runtime['first-parent descendants'][p]:
self.runtime['first-parent descendants'][p].append(name)
def compute_inheritance(self, use_simple_method=True):
if cylc.flags.verbose:
OUT.info("Parsing the runtime namespace hierarchy")
results = OrderedDictWithDefaults()
# n_reps = 0
already_done = {} # to store already computed namespaces by mro
# Loop through runtime members, 'root' first.
nses = self.cfg['runtime'].keys()
nses.sort(key=lambda ns: ns != 'root')
for ns in nses:
# for each namespace ...
hierarchy = copy(self.runtime['linearized ancestors'][ns])
hierarchy.reverse()
result = OrderedDictWithDefaults()
if use_simple_method:
# Go up the linearized MRO from root, replicating or
# overriding each namespace element as we go.
for name in hierarchy:
replicate(result, self.cfg['runtime'][name])
# n_reps += 1
else:
# As for the simple method, but store the result of each
# completed MRO (full or partial) as we go, and re-use
# these wherever possible. This ought to be a lot more
# efficient for big namespaces (e.g. lots of environment
# variables) in deep hiearchies, but results may vary...
prev_shortcut = False
mro = []
for name in hierarchy:
mro.append(name)
i_mro = '*'.join(mro)
if i_mro in already_done:
ad_result = already_done[i_mro]
prev_shortcut = True
else:
if prev_shortcut:
prev_shortcut = False
# copy ad_result (to avoid altering already_done)
result = OrderedDictWithDefaults()
replicate(result, ad_result) # ...and use stored
# n_reps += 1
# override name content into tmp
replicate(result, self.cfg['runtime'][name])
# n_reps += 1
# record this mro as already done
already_done[i_mro] = result
results[ns] = result
# replace pre-inheritance namespaces with the post-inheritance result
self.cfg['runtime'] = results
# uncomment this to compare the simple and efficient methods
# print ' Number of namespace replications:', n_reps
# def print_inheritance(self):
# # (use for debugging)
# for foo in self.runtime:
# log_msg = '\t' + foo
# for item, val in self.runtime[foo].items():
# log_msg += '\t\t' + item + '\t' + val
# OUT.info(log_msg)
def compute_runahead_limits(self):
"""Extract the runahead limits information."""
max_cycles = self.cfg['scheduling']['max active cycle points']
if max_cycles == 0:
raise SuiteConfigError(
"ERROR: max cycle points must be greater than %s" %
(max_cycles)
)
self.max_num_active_cycle_points = self.cfg['scheduling'][
'max active cycle points']
limit = self.cfg['scheduling']['runahead limit']
if (limit is not None and limit.isdigit() and
get_interval_cls().get_null().TYPE == ISO8601_CYCLING_TYPE):
# Backwards-compatibility for raw number of hours.
limit = "PT%sH" % limit
# The custom runahead limit is None if not user-configured.
self.custom_runahead_limit = get_interval(limit)
def get_custom_runahead_limit(self):
"""Return the custom runahead limit (may be None)."""
return self.custom_runahead_limit
def get_max_num_active_cycle_points(self):
"""Return the maximum allowed number of pool cycle points."""
return self.max_num_active_cycle_points
def get_config(self, args, sparse=False):
return self.pcfg.get(args, sparse)
def adopt_orphans(self, orphans):
# Called by the scheduler after reloading the suite definition
# at run time and finding any live task proxies whose
# definitions have been removed from the suite. Keep them
# in the default queue and under the root family, until they
# run their course and disappear.
queues = self.cfg['scheduling']['queues']
for orphan in orphans:
self.runtime['linearized ancestors'][orphan] = [orphan, 'root']
queues[self.Q_DEFAULT]['members'].append(orphan)
def configure_queues(self):
"""Assign tasks to internal queues."""
# Note this modifies the parsed config dict.
queues = self.cfg['scheduling']['queues']
if cylc.flags.verbose:
OUT.info("Configuring internal queues")
# First add all tasks to the default queue.
all_task_names = self.get_task_name_list()
queues[self.Q_DEFAULT]['members'] = all_task_names
# Then reassign to other queues as requested.
warnings = []
requeued = []
for key, queue in queues.copy().items():
# queues.copy() is essential here to allow items to be removed from
# the queues dict.
if key == self.Q_DEFAULT:
continue
# Assign tasks to queue and remove them from default.
qmembers = []
for qmember in queue['members']:
# Is a family.
if qmember in self.runtime['descendants']:
# Replace with member tasks.
for fmem in self.runtime['descendants'][qmember]:
# This includes sub-families.
if qmember not in qmembers:
try:
queues[self.Q_DEFAULT]['members'].remove(fmem)
except ValueError:
if fmem in requeued:
msg = "%s: ignoring %s from %s (%s)" % (
key, fmem, qmember,
'already assigned to a queue')
warnings.append(msg)
else:
# Ignore: task not used in the graph.
pass
else:
qmembers.append(fmem)
requeued.append(fmem)
else:
# Is a task.
if qmember not in qmembers:
try:
queues[self.Q_DEFAULT]['members'].remove(qmember)
except ValueError:
if qmember in requeued:
msg = "%s: ignoring '%s' (%s)" % (
key, qmember, 'task already assigned')
warnings.append(msg)
elif qmember not in all_task_names:
msg = "%s: ignoring '%s' (%s)" % (
key, qmember, 'task not defined')
warnings.append(msg)
else:
# Ignore: task not used in the graph.
pass
else:
qmembers.append(qmember)
requeued.append(qmember)
if warnings:
err_msg = "Queue configuration warnings:"
for msg in warnings:
err_msg += "\n+ %s" % msg
ERR.warning(err_msg)
if qmembers:
queue['members'] = qmembers
else:
del queues[key]
if cylc.flags.verbose and len(queues) > 1:
log_msg = "Internal queues created:"
for key, queue in queues.items():
if key == self.Q_DEFAULT:
continue
log_msg += "\n+ %s: %s" % (key, ', '.join(queue['members']))
OUT.info(log_msg)
def configure_suite_state_polling_tasks(self):
# Check custom script is not defined for automatic suite polling tasks.
for l_task in self.suite_polling_tasks:
try:
cs = self.pcfg.getcfg(sparse=True)['runtime'][l_task]['script']
except:
pass
else:
if cs:
OUT.info(cs)
# (allow explicit blanking of inherited script)
raise SuiteConfigError(
"ERROR: script cannot be defined for automatic" +
" suite polling task " + l_task)
# Generate the automatic scripting.
for name, tdef in self.taskdefs.items():
if name not in self.suite_polling_tasks:
continue
rtc = tdef.rtconfig
comstr = "cylc suite-state" + \
" --task=" + tdef.suite_polling_cfg['task'] + \
" --point=$CYLC_TASK_CYCLE_POINT" + \
" --status=" + tdef.suite_polling_cfg['status']
for key, fmt in [
('user', ' --%s=%s'),
('host', ' --%s=%s'),
('interval', ' --%s=%d'),
('max-polls', ' --%s=%s'),
('run-dir', ' --%s=%s'),
('template', ' --%s=%s')]:
if rtc['suite state polling'][key]:
comstr += fmt % (key, rtc['suite state polling'][key])
comstr += " " + tdef.suite_polling_cfg['suite']
script = "echo " + comstr + "\n" + comstr
rtc['script'] = script
def configure_sim_modes(self):
"""Adjust task defs for simulation mode and dummy modes."""
for tdef in self.taskdefs.values():
# Compute simulated run time by scaling the execution limit.
rtc = tdef.rtconfig
limit = rtc['job']['execution time limit']
speedup = rtc['simulation']['speedup factor']
if limit and speedup:
sleep_sec = (DurationParser().parse(
str(limit)).get_seconds() / speedup)
else:
sleep_sec = DurationParser().parse(
str(rtc['simulation']['default run length'])
).get_seconds()
rtc['job']['execution time limit'] = (
sleep_sec + DurationParser().parse(str(
rtc['simulation']['time limit buffer'])
).get_seconds())
rtc['job']['simulated run length'] = sleep_sec
# Generate dummy scripting.
rtc['init-script'] = ""
rtc['env-script'] = ""
rtc['pre-script'] = ""
rtc['post-script'] = ""
scr = "sleep %d" % sleep_sec
# Dummy message outputs.
for msg in rtc['outputs'].values():
scr += "\ncylc message '%s'" % msg
if rtc['simulation']['fail try 1 only']:
arg1 = "true"
else:
arg1 = "false"
arg2 = " ".join(rtc['simulation']['fail cycle points'])
scr += "\ncylc__job__dummy_result %s %s || exit 1" % (arg1, arg2)
rtc['script'] = scr
# Disable batch scheduler in dummy modes.
# TODO - to use batch schedulers in dummy mode we need to
# identify which resource directives to disable or modify.
# (Only execution time limit is automatic at the moment.)
rtc['job']['batch system'] = 'background'
# Disable environment, in case it depends on env-script.
rtc['environment'] = {}
if tdef.run_mode == 'dummy-local':
# Run all dummy tasks on the suite host.
rtc['remote']['host'] = None
rtc['remote']['owner'] = None
# Simulation mode tasks should fail in which cycle points?
f_pts = []
f_pts_orig = rtc['simulation']['fail cycle points']
if 'all' in f_pts_orig:
# None for "fail all points".
f_pts = None
else:
# (And [] for "fail no points".)
for point_str in f_pts_orig:
f_pts.append(get_point(point_str).standardise())
rtc['simulation']['fail cycle points'] = f_pts
def get_parent_lists(self):
return self.runtime['parents']
def get_first_parent_ancestors(self, pruned=False):
if pruned:
# prune non-task namespaces from ancestors dict
pruned_ancestors = {}
for key, val in self.runtime['first-parent ancestors'].items():
if key not in self.taskdefs:
continue
pruned_ancestors[key] = val
return pruned_ancestors
else:
return self.runtime['first-parent ancestors']
def get_linearized_ancestors(self):
return self.runtime['linearized ancestors']
def get_first_parent_descendants(self):
return self.runtime['first-parent descendants']
def define_inheritance_tree(self, tree, hierarchy):
"""Combine inheritance hierarchies into a tree structure."""
for rt in hierarchy:
hier = copy(hierarchy[rt])
hier.reverse()
cur_tree = tree
for item in hier:
if item not in cur_tree:
cur_tree[item] = {}
cur_tree = cur_tree[item]
def add_tree_titles(self, tree):
for key, val in tree.items():
if val == {}:
if 'title' in self.cfg['runtime'][key]['meta']:
tree[key] = self.cfg['runtime'][key]['meta']['title']
else:
tree[key] = 'No title provided'
elif isinstance(val, dict):
self.add_tree_titles(val)
def get_namespace_list(self, which):
names = []
if which == 'graphed tasks':
# tasks used only in the graph
names = self.taskdefs.keys()
elif which == 'all namespaces':
# all namespaces
names = self.cfg['runtime'].keys()
elif which == 'all tasks':
for ns in self.cfg['runtime']:
if ns not in self.runtime['descendants']:
# tasks have no descendants
names.append(ns)
result = {}
for ns in names:
if 'title' in self.cfg['runtime'][ns]['meta']:
# the runtime dict is sparse at this stage.
result[ns] = self.cfg['runtime'][ns]['meta']['title']
else:
# no need to flesh out the full runtime just for title
result[ns] = "No title provided"
return result
def get_mro(self, ns):
try:
mro = self.runtime['linearized ancestors'][ns]
except KeyError:
mro = ["ERROR: no such namespace: " + ns]
return mro
def print_first_parent_tree(self, pretty=False, titles=False):
# find task namespaces (no descendants)
tasks = []
for ns in self.cfg['runtime']:
if ns not in self.runtime['descendants']:
tasks.append(ns)
pruned_ancestors = self.get_first_parent_ancestors(pruned=True)
tree = {}
self.define_inheritance_tree(tree, pruned_ancestors)
padding = ''
if titles:
self.add_tree_titles(tree)
# compute pre-title padding
maxlen = 0
for ns in pruned_ancestors:
items = copy(pruned_ancestors[ns])
items.reverse()
for i in range(len(items)):
tmp = 2 * i + 1 + len(items[i])
if i == 0:
tmp -= 1
if tmp > maxlen:
maxlen = tmp
padding = maxlen * ' '
print_tree(tree, padding=padding, use_unicode=pretty)
def process_directories(self):
os.environ['CYLC_SUITE_NAME'] = self.suite
os.environ['CYLC_SUITE_DEF_PATH'] = self.fdir
def check_tasks(self):
"""Call after all tasks are defined.
ONLY IF VALIDATING THE SUITE
because checking conditional triggers below may be slow for
huge suites (several thousand tasks).
Note:
(a) self.cfg['runtime'][name]
contains the task definition sections of the suite.rc file.
(b) self.taskdefs[name]
contains tasks that will be used, defined by the graph.
Tasks (a) may be defined but not used (e.g. commented out of the
graph)
Tasks (b) may not be defined in (a), in which case they are dummied
out.
"""
for taskdef in self.taskdefs.values():
try:
taskdef.check_for_explicit_cycling()
except TaskDefError as exc:
raise SuiteConfigError(str(exc))
# Check use of ksh in "[job]shell" setting
job_shell = taskdef.rtconfig['job']['shell']
if job_shell and 'ksh' in os.path.basename(job_shell):
ERR.warning(
('deprecated: [runtime][%s][job]shell=%s: '
'use of ksh to run cylc task job file') %
(taskdef.name, job_shell))
if cylc.flags.verbose:
OUT.info("Checking for defined tasks not used in the graph")
for name in self.cfg['runtime']:
if name not in self.taskdefs:
if name not in self.runtime['descendants']:
# Family triggers have been replaced with members.
ERR.warning(
'task "%s" not used in the graph.' % (name))
# Check declared special tasks are valid.
for task_type in self.cfg['scheduling']['special tasks']:
for name in self.cfg['scheduling']['special tasks'][task_type]:
if task_type in ['clock-trigger', 'clock-expire',
'external-trigger']:
name = name.split('(', 1)[0]
if not TaskID.is_valid_name(name):
raise SuiteConfigError(
'ERROR: Illegal %s task name: %s' % (task_type, name))
if (name not in self.taskdefs and
name not in self.cfg['runtime']):
msg = '%s task "%s" is not defined.' % (task_type, name)
if self.strict:
raise SuiteConfigError("ERROR: " + msg)
else:
ERR.warning(msg)
def get_task_name_list(self):
# return a list of all tasks used in the dependency graph
return self.taskdefs.keys()
def generate_edges(self, lexpr, orig_lexpr, left_nodes, right, seq,
suicide=False):
"""Generate edges.
Add nodes from this graph section to the abstract graph edges
structure.
"""
conditional = False
if '|' in lexpr:
# plot conditional triggers differently
conditional = True
if seq not in self.edges:
self.edges[seq] = set()
if not left_nodes:
# Right is a lone node.
self.edges[seq].add((right, None, suicide, conditional))
for left in left_nodes:
# if left is None:
# continue
# TODO - RIGHT CANNOT BE NONE NOW?
# if right is not None:
# Check for self-edges.
if left == right or left.startswith(right + ':'):
# (This passes inter-cycle offsets: left[-P1D] => left)
# (TODO - but not explicit null offsets like [-P0D]!)
if suicide:
continue
if orig_lexpr != lexpr:
ERR.error("%s => %s" % (orig_lexpr, right))
raise SuiteConfigError(
"ERROR, self-edge detected: %s => %s" % (
left, right))
self.edges[seq].add((left, right, suicide, conditional))
def generate_taskdefs(self, orig_expr, left_nodes, right, seq):
"""Generate task definitions for all nodes in orig_expr."""
for node in left_nodes + [right]:
if not node:
# if right is None, lefts are lone nodes
# for which we still define the taskdefs
continue
try:
name, offset_is_from_icp, _, offset, _ = (
GraphNodeParser.get_inst().parse(node))
except GraphNodeError as exc:
ERR.error(orig_expr)
raise SuiteConfigError(str(exc))
if name not in self.cfg['runtime']:
# naked dummy task, implicit inheritance from root
self.naked_dummy_tasks.append(name)
# These can't just be a reference to root runtime as we have to
# make some items task-specific: e.g. subst task name in URLs.
self.cfg['runtime'][name] = OrderedDictWithDefaults()
replicate(self.cfg['runtime'][name],
self.cfg['runtime']['root'])
if 'root' not in self.runtime['descendants']:
# (happens when no runtimes are defined in the suite.rc)
self.runtime['descendants']['root'] = []
if 'root' not in self.runtime['first-parent descendants']:
# (happens when no runtimes are defined in the suite.rc)
self.runtime['first-parent descendants']['root'] = []
self.runtime['parents'][name] = ['root']
self.runtime['linearized ancestors'][name] = [name, 'root']
self.runtime['first-parent ancestors'][name] = [name, 'root']
self.runtime['descendants']['root'].append(name)
self.runtime['first-parent descendants']['root'].append(name)
self.ns_defn_order.append(name)
# check task name legality and create the taskdef
taskdef = self.get_taskdef(name, orig_expr)
if name in self.suite_polling_tasks:
taskdef.suite_polling_cfg = {
'suite': self.suite_polling_tasks[name][0],
'task': self.suite_polling_tasks[name][1],
'status': self.suite_polling_tasks[name][2]}
if not offset_is_from_icp:
if offset:
taskdef.used_in_offset_trigger = True
else:
taskdef.add_sequence(seq)
# Record custom message outputs.
for item in self.cfg['runtime'][name]['outputs'].items():
if item not in taskdef.outputs:
taskdef.outputs.append(item)
# Check for obsolete task message offsets.
if BCOMPAT_MSG_RE_C6.match(item[1]):
raise SuiteConfigError(
'ERROR: Message trigger offsets are obsolete.')
def generate_triggers(self, lexpression, left_nodes, right, seq,
suicide, task_triggers):
"""Create Dependency and TaskTrigger objects.
Register dependency with the relevant TaskDef object.
"""
if not right or not left_nodes:
# Lone nodes have no triggers.
return
# Convert expression to a (nested) list.
try:
expr_list = ConditionalSimplifier.listify(lexpression)
except SyntaxError:
raise SuiteConfigError('Error in expression "%s"' % lexpression)
triggers = {}
for left in left_nodes:
# (GraphNodeError checked above)
name, offset_is_from_icp, offset_is_irregular, offset, output = (
GraphNodeParser.get_inst().parse(left))
ltaskdef = self.taskdefs[name]
# Determine intercycle offsets.
abs_cycle_point = None
cycle_point_offset = None
if offset_is_from_icp:
first_point = get_point_relative(offset, self.initial_point)
last_point = seq.get_stop_point()
abs_cycle_point = first_point
if last_point is None:
# This dependency persists for the whole suite run.
ltaskdef.intercycle_offsets.add((None, seq))
else:
ltaskdef.intercycle_offsets.add(
(str(first_point - last_point), seq))
elif offset:
if offset_is_irregular:
offset_tuple = (offset, seq)
else:
offset_tuple = (offset, None)
ltaskdef.intercycle_offsets.add(offset_tuple)
cycle_point_offset = offset
# Qualifier.
outputs = self.cfg['runtime'][name]['outputs']
if outputs and output in outputs:
# Qualifier is a task message.
qualifier = outputs[output]
elif output:
# Qualifier specified => standardise.
qualifier = TaskTrigger.get_trigger_name(output)
else:
# No qualifier specified => use "succeeded".
qualifier = TASK_OUTPUT_SUCCEEDED
# Generate TaskTrigger if not already done.
key = (name, abs_cycle_point, cycle_point_offset, qualifier)
try:
task_trigger = task_triggers[key]
except KeyError:
task_trigger = TaskTrigger(*key)
task_triggers[key] = task_trigger
triggers[left] = task_trigger
# Walk down "expr_list" depth first, and replace any items matching a
# key in "triggers" ("left" values) with the trigger.
stack = [expr_list]
while stack:
item_list = stack.pop()
for i, item in enumerate(item_list):
if isinstance(item, list):
stack.append(item)
elif item in triggers:
item_list[i] = triggers[item]
dependency = Dependency(expr_list, set(triggers.values()), suicide)
self.taskdefs[right].add_dependency(dependency, seq)
def get_actual_first_point(self, start_point):
"""Get actual first cycle point for the suite
Get all sequences to adjust the putative start time upward.
"""
if (self._start_point_for_actual_first_point is not None and
self._start_point_for_actual_first_point == start_point and
self.actual_first_point is not None):
return self.actual_first_point
self._start_point_for_actual_first_point = start_point
adjusted = []
for seq in self.sequences:
point = seq.get_first_point(start_point)
if point:
adjusted.append(point)
if len(adjusted) > 0:
adjusted.sort()
self.actual_first_point = adjusted[0]
else:
self.actual_first_point = start_point
return self.actual_first_point
def get_graph_raw(self, start_point_string, stop_point_string,
group_nodes=None, ungroup_nodes=None,
ungroup_recursive=False, group_all=False,
ungroup_all=False, is_validate=False):
"""Convert the abstract graph edges (self.edges, etc) to actual edges
Actual edges have concrete ranges of cycle points.
In validate mode, set ungroup_all to True, and only return non-suicide
edges with left and right nodes.
"""
if is_validate:
ungroup_all = True
if group_nodes is None:
group_nodes = []
if ungroup_nodes is None:
ungroup_nodes = []
if self.first_graph:
self.first_graph = False
if not self.collapsed_families_rc and not ungroup_all:
# initially default to collapsing all families if
# "[visualization]collapsed families" not defined
group_all = True
first_parent_descendants = self.runtime['first-parent descendants']
if group_all:
# Group all family nodes
if self.collapsed_families_rc:
self.closed_families = copy(self.collapsed_families_rc)
else:
for fam in first_parent_descendants:
if fam != 'root':
if fam not in self.closed_families:
self.closed_families.append(fam)
elif ungroup_all:
# Ungroup all family nodes
self.closed_families = []
elif group_nodes:
# Group chosen family nodes
first_parent_ancestors = self.runtime['first-parent ancestors']
for node in group_nodes:
parent = first_parent_ancestors[node][1]
if parent not in self.closed_families and parent != 'root':
self.closed_families.append(parent)
elif ungroup_nodes:
# Ungroup chosen family nodes
for node in ungroup_nodes:
if node not in self.runtime['descendants']:
# not a family node
continue
if node in self.closed_families:
self.closed_families.remove(node)
if ungroup_recursive:
for fam in copy(self.closed_families):
if fam in first_parent_descendants[node]:
self.closed_families.remove(fam)
n_points = self.cfg['visualization']['number of cycle points']
graph_raw_id = (
start_point_string, stop_point_string, tuple(group_nodes),
tuple(ungroup_nodes), ungroup_recursive, group_all,
ungroup_all, tuple(self.closed_families),
tuple((seq, sorted(val))
for seq, val in sorted(self.edges.items())),
n_points)
if graph_raw_id == self._last_graph_raw_id:
return self._last_graph_raw_edges
# Now define the concrete graph edges (pairs of nodes) for plotting.
start_point = get_point(start_point_string)
actual_first_point = self.get_actual_first_point(start_point)
suite_final_point = get_point(
self.cfg['scheduling']['final cycle point'])
# For the computed stop point, we store n_points of each sequence,
# and then cull later to the first n_points over all sequences.
if stop_point_string is not None:
stop_point = get_point(stop_point_string)
else:
stop_point = None
# For nested families, only consider the outermost one
clf_map = {}
for name in self.closed_families:
if all(name not in first_parent_descendants[i]
for i in self.closed_families):
clf_map[name] = first_parent_descendants[name]
gr_edges = {}
start_point_offset_cache = {}
point_offset_cache = None
for sequence, edges in self.edges.items():
# Get initial cycle point for this sequence
point = sequence.get_first_point(start_point)
new_points = []
while point is not None:
if point not in new_points:
new_points.append(point)
if stop_point is not None and point > stop_point:
# Beyond requested final cycle point.
break
if suite_final_point is not None and point > suite_final_point:
# Beyond suite final cycle point.
break
if stop_point is None and len(new_points) > n_points:
# Take n_points cycles from each sequence.
break
point_offset_cache = {}
for left, right, suicide, cond in edges:
if is_validate and (not right or suicide):
continue
if right:
r_id = (right, point)
else:
r_id = None
name, offset_is_from_icp, _, offset, _ = (
GraphNodeParser.get_inst().parse(left))
if offset:
if offset_is_from_icp:
cache = start_point_offset_cache
rel_point = start_point
else:
cache = point_offset_cache
rel_point = point
try:
l_point = cache[offset]
except KeyError:
l_point = get_point_relative(offset, rel_point)
cache[offset] = l_point
else:
l_point = point
l_id = (name, l_point)
if l_id is None and r_id is None:
continue
if l_id is not None and actual_first_point > l_id[1]:
# Check that l_id is not earlier than start time.
# NOTE BUG GITHUB #919
# sct = start_point
if (r_id is None or r_id[1] < actual_first_point or
is_validate):
continue
# Pre-initial dependency;
# keep right hand node.
l_id = r_id
r_id = None
if point not in gr_edges:
gr_edges[point] = []
if is_validate:
gr_edges[point].append((l_id, r_id))
else:
lstr, rstr = self._close_families(l_id, r_id, clf_map)
gr_edges[point].append(
(lstr, rstr, None, suicide, cond))
# Increment the cycle point.
point = sequence.get_next_point_on_sequence(point)
del clf_map
del start_point_offset_cache
del point_offset_cache
GraphNodeParser.get_inst().clear()
self._last_graph_raw_id = graph_raw_id
if stop_point is None:
# Prune to n_points points in total.
graph_raw_edges = []
for point in sorted(gr_edges)[:n_points]:
graph_raw_edges.extend(gr_edges[point])
else:
# Flatten nested list.
graph_raw_edges = (
[i for sublist in gr_edges.values() for i in sublist])
graph_raw_edges.sort()
self._last_graph_raw_edges = graph_raw_edges
return graph_raw_edges
def get_node_labels(self, start_point_string, stop_point_string=None):
"""Return dependency graph node labels."""
stop_point = None
if stop_point_string is None:
vfcp = self.cfg['visualization']['final cycle point']
if vfcp:
try:
stop_point = get_point_relative(
vfcp, get_point(start_point_string)).standardise()
except ValueError:
stop_point = get_point(vfcp).standardise()
if stop_point is not None:
if stop_point < get_point(start_point_string):
# Avoid a null graph.
stop_point_string = start_point_string
else:
stop_point_string = str(stop_point)
ret = set()
for edge in self.get_graph_raw(
start_point_string, stop_point_string, ungroup_all=True):
left, right = edge[0:2]
if left:
ret.add(left)
if right:
ret.add(right)
return ret
@staticmethod
def _close_families(l_id, r_id, clf_map):
"""Turn (name, point) to 'name.point' for edge.
Replace close family members with family nodes if relevant.
"""
lret = None
lname, lpoint = None, None
if l_id:
lname, lpoint = l_id
lret = TaskID.get(lname, lpoint)
rret = None
rname, rpoint = None, None
if r_id:
rname, rpoint = r_id
rret = TaskID.get(rname, rpoint)
for fam_name, fam_members in clf_map.items():
if lname in fam_members and rname in fam_members:
# l and r are both members
lret = TaskID.get(fam_name, lpoint)
rret = TaskID.get(fam_name, rpoint)
break
elif lname in fam_members:
# l is a member
lret = TaskID.get(fam_name, lpoint)
elif rname in fam_members:
# r is a member
rret = TaskID.get(fam_name, rpoint)
return lret, rret
def load_graph(self):
"""Parse and load dependency graph."""
if cylc.flags.verbose:
OUT.info("Parsing the dependency graph")
# Generate a map of *task* members of each family.
# Note we could exclude 'root' from this and disallow use of 'root' in
# the graph (which would probably be quite reasonable).
family_map = {}
runtime_families = self.runtime['descendants'].keys()
runtime_tasks = [
t for t in self.runtime['parents'].keys()
if t not in runtime_families]
for fam in runtime_families:
desc = self.runtime['descendants'][fam]
family_map[fam] = [t for t in desc if t in runtime_tasks]
# Move a cylc-5 non-cycling graph to an R1 section.
non_cycling_graph = self.cfg['scheduling']['dependencies']['graph']
if non_cycling_graph:
section = get_sequence_cls().get_async_expr()
self.cfg['scheduling']['dependencies'][section] = (
OrderedDictWithDefaults())
self.cfg['scheduling']['dependencies'][section]['graph'] = (
non_cycling_graph)
del self.cfg['scheduling']['dependencies']['graph']
icp = self.cfg['scheduling']['initial cycle point']
fcp = self.cfg['scheduling']['final cycle point']
# Make a stack of sections and graphs [(sec1, graph1), ...]
sections = []
for section, sec_map in self.cfg['scheduling']['dependencies'].items():
# Substitute initial and final cycle points.
if not sec_map['graph']:
# Empty section.
continue
if icp:
section = section.replace("^", icp)
elif "^" in section:
raise SuiteConfigError("ERROR: Initial cycle point referenced"
" (^) but not defined.")
if fcp:
section = section.replace("$", fcp)
elif "$" in section:
raise SuiteConfigError("ERROR: Final cycle point referenced"
" ($) but not defined.")
# If the section consists of more than one sequence, split it up.
new_sections = RE_SEC_MULTI_SEQ.split(section)
if len(new_sections) > 1:
for new_section in new_sections:
sections.append((new_section.strip(), sec_map['graph']))
else:
sections.append((section, sec_map['graph']))
# Parse and process each graph section.
task_triggers = {}
for section, graph in sections:
try:
seq = get_sequence(section, icp, fcp)
except (AttributeError, TypeError, ValueError, CylcError) as exc:
if cylc.flags.debug:
traceback.print_exc()
msg = 'ERROR: Cannot process recurrence %s' % section
msg += ' (initial cycle point=%s)' % icp
msg += ' (final cycle point=%s)' % fcp
if isinstance(exc, CylcError):
msg += ' %s' % str(exc)
raise SuiteConfigError(msg)
self.sequences.append(seq)
parser = GraphParser(family_map, self.parameters)
parser.parse_graph(graph)
self.suite_polling_tasks.update(parser.suite_state_polling_tasks)
self._proc_triggers(
parser.triggers, parser.original, seq, task_triggers)
def _proc_triggers(self, triggers, original, seq, task_triggers):
"""Define graph edges, taskdefs, and triggers, from graph sections."""
for right, val in triggers.items():
for expr, trigs in val.items():
lefts, suicide = trigs
orig = original[right][expr]
self.generate_edges(expr, orig, lefts, right, seq, suicide)
self.generate_taskdefs(orig, lefts, right, seq)
self.generate_triggers(
expr, lefts, right, seq, suicide, task_triggers)
def find_taskdefs(self, name):
"""Find TaskDef objects in family "name" or matching "name".
Return a list of TaskDef objects which:
* have names that glob matches "name".
* are in a family that glob matches "name".
"""
ret = []
if name in self.taskdefs:
# Match a task name
ret.append(self.taskdefs[name])
else:
fams = self.get_first_parent_descendants()
# Match a family name
if name in fams:
for member in fams[name]:
if member in self.taskdefs:
ret.append(self.taskdefs[member])
else:
# Glob match task names
for key, taskdef in self.taskdefs.items():
if fnmatchcase(key, name):
ret.append(taskdef)
# Glob match family names
for key, members in fams.items():
if fnmatchcase(key, name):
for member in members:
if member in self.taskdefs:
ret.append(self.taskdefs[member])
return ret
def get_taskdef(self, name, orig_expr=None):
"""Return an instance of TaskDef for task name."""
if name not in self.taskdefs:
try:
self.taskdefs[name] = self._get_taskdef(name)
except TaskDefError as exc:
if orig_expr:
ERR.error(orig_expr)
raise SuiteConfigError(str(exc))
return self.taskdefs[name]
def _get_taskdef(self, name):
"""Get the dense task runtime."""
# (TaskDefError caught above)
try:
rtcfg = self.cfg['runtime'][name]
except KeyError:
raise SuiteConfigError("Task not defined: %s" % name)
# We may want to put in some handling for cases of changing the
# initial cycle via restart (accidentally or otherwise).
# Get the taskdef object for generating the task proxy class
taskd = TaskDef(
name, rtcfg, self.run_mode, self.start_point,
self.cfg['scheduling']['spawn to max active cycle points'])
# TODO - put all taskd.foo items in a single config dict
if name in self.clock_offsets:
taskd.clocktrigger_offset = self.clock_offsets[name]
if name in self.expiration_offsets:
taskd.expiration_offset = self.expiration_offsets[name]
if name in self.ext_triggers:
taskd.external_triggers.append(self.ext_triggers[name])
taskd.sequential = (
name in self.cfg['scheduling']['special tasks']['sequential'])
taskd.namespace_hierarchy = list(
reversed(self.runtime['linearized ancestors'][name]))
if name in self.task_param_vars:
taskd.param_var = self.task_param_vars[name]
return taskd
def describe(self, name):
"""Return title and description of the named task."""
return self.taskdefs[name].describe()
|