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 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559
|
########################################################################################
# #
# Author: Bertrand Neron, #
# Organization:'Biological Software and Databases' Group, Institut Pasteur, Paris. #
# Distributed under GPLv2 Licence. Please refer to the COPYING.LIB document. #
# #
########################################################################################
from logging import getLogger
b_log = getLogger('Mobyle.builder')
s_log = getLogger( __name__ )
import types
import os
import copy
from Mobyle.MobyleError import MobyleError , ServiceError , UnDefAttrError , ParameterError , UserValueError
from Mobyle.Evaluation import Evaluation
from Mobyle.ConfigManager import Config
_cfg = Config()
__extra_epydoc_fields__ = [('call', 'Called by','Called by')]
###############################################################
# #
# Class Program #
# #
###############################################################
class Program(object):
"""
a Program object is the Python representation of the xml program definition
and had methods to manage the data
"""
_paramError = " this program doesn't content parameter named : "
def __init__(self, evaluator = None , ):
"""
this object is the python representation of program describe in xml
@call: indirectly in L{MobyleJob._makeProgram}
@call: indirectly in L{RunnerChild} main
"""
self._debug = None #set to cfg.debug( ProgramName ) by setName()
if evaluator is None:
self._evaluator = Evaluation()
else:
self._evaluator = evaluator
self.cfg = Config()
self.header = None
self._parameters = Parameters()
def _getAllParameter(self):
"""
@return: all L{Parameter}'s instance in a list
@rtype: list of Parameter
@call: L{getAllParameterNameByArgpos}
@call: L{getCommandParameterName}
"""
return self._parameters.getAllParameter()
def getAllParameterByArgpos(self):
"""
@return: a list of all L{parameter's <Parameter>} sorted by their argpos.
@rtype: list of L{parameter's <Parameter>}
"""
paramList = self._getAllParameter()
paramList.sort(self.cmpPara)
return paramList
def getAllParameterNameByArgpos(self):
"""
@return: a list of all L{parameter's <Parameter>} name sorted by their argpos.
@rtype: list of string
@call: L{CGIJob.form2Dict} L{MobyleJob.__init__} L{MobyleJob._fillEvaluator} L{MobyleJob._validateParameters}
@call: L{getAllHiddenParameter}, L{getAllSimpleParameter}, L{getAllMandatoryParameter}
"""
paramList = self._getAllParameter()
paramList.sort(self.cmpPara)
return [ p.getName() for p in paramList ]
def getUserInputParameterByArgpos( self ):
paramList = self._getAllParameter()
paramList.sort( self.cmpPara )
result = []
for param in paramList:
if not param.isout() and not param.isstdout() and not param.ishidden():
result.append( param.getName() )
return result
def getUserOutputParameters( self ):
paramList = self._getAllParameter()
result = []
for param in paramList:
if param.isout() or param.isstdout():
result.append( param.getName() )
return result
def getAllParagraphNameByArgpos(self):
"""
@return: a list of all L{Paragraph}'s name sorted by their argpos.
@rtype: list of string
"""
paragList = self._getAllParagraph()
paragList.sort(self.cmpPara)
result = []
for parag in paragList:
result.append( parag.getName() )
return result
def cmpPara(self ,para1 , para2 ):
"""
compare two L{parameter <Parameter>} or L{paragraph <Paragraph>} according to their argpos.
@rtype: int
@return:
- negative number if para1 > para2
- 0 if para1 and para2 are equal
- positive number otherwise
@call: L{getAllParameterNameByArgpos}, L{getAllParagraphNameByOrder}
"""
argpos1 = para1.getArgpos()
argpos2 = para2.getArgpos()
return argpos1 - argpos2
def getDebug(self):
return self.cfg.debug( self.header.getName() )
def getAllHiddenParameter(self):
"""
@return: a list of all hidden parameter's name sorted by their argpos.
@rtype: list of strings.
"""
result = []
for paramName in self.getAllParameterNameByArgpos():
if self.ishidden(paramName):
result.append( paramName )
return result
def getAllSimpleParameter(self):
"""
@return: A list of all simple parameter's name sorted by their argpos.
@rtype: list of strings.
"""
result = []
for paramName in self.getAllParameterNameByArgpos():
if self.issimple(paramName):
result.append( paramName )
return result
def getAllMandatoryParameter(self):
"""
@return: A list of all mandatory parameter's name sorted by their argpos.
@rtype: list of strings.
"""
result = []
for paramName in self.getAllParameterNameByArgpos():
if self.ismandatory(paramName):
result.append( paramName )
return result
def getAllOutParameter(self):
"""
@return: A list of all out parameter's name sorted by their argpos.
@rtype: list of strings.
"""
result = []
for paramName in self.getAllParameterNameByArgpos():
if self.isout( paramName ) or self.isstdout( paramName ):
result.append( paramName )
return result
def getAllOutFileParameter(self):
"""
@return: A list of all out parameter
@rtype: list of Parameter instances.
"""
result = []
for param in self._getAllParameter():
if param.isOutfile() :
result.append( param )
return result
def getAllInFileParameter(self):
"""
@return: A list of all in parameter.
@rtype: list of Parameter instances.
"""
result = []
for param in self._getAllParameter():
if param.isInfile() :
result.append( param )
return result
def getCommandParameterName(self):
"""
@return: The name of the first parameter with attribute iscommand= True.
( it should be have only one parameter with iscommand = True per Program).
If doesn't find any parameter with iscommand = True, return None.
@rtype: a not empty string or None.
@call: L{CommandBuilder.buildLocalCommand<CommandBuilder>}
"""
for param in self._getAllParameter():
if param.iscommand():
return param.getName()
return None
def addheader(self , header ):
CommandParameterName = self.getCommandParameterName()
if CommandParameterName :
msg = "try to add a header with a command but \"%s\" parameter is already used as command" % CommandParameterName
s_log.error( msg )
raise ServiceError , msg
self.header = header
self.debug = self.cfg.debug( header.getName() )
def addParameter(self, parameter):
"""
Add a L{parameter <Parameter>} instance or a sequence of L{parameter <Parameter>} instances at the Program top level.
@param parameter: the parameter to add
@type parameter: a -L{Parameter} instance
"""
if type(parameter) == type([]) or type(parameter) == type( () ):
for param in parameter:
self._parameters.addParameter(param)
param.setFather(self)
param.setEvaluator(self._evaluator)
else:
self._parameters.addParameter(parameter)
parameter.setFather(self)
parameter.setEvaluator(self._evaluator)
def getParameter(self, paramName):
"""
@return: the L{Parameter} instance which have the name paramName. if no parmeter found return None
@rtype: a L{Parameter} instance or None
@call: by all Sevice methods which are delegated to parameter
"""
return self._parameters.getParameter( paramName )
def _getAllParagraph(self):
"""
@return: all L{Paragraph} instances from all levels
@rtype: a list of L{Paragraph} instances
@call: L{getAllParagraphNameByOrder}
"""
return self._parameters.getAllParagraph()
def _getParagraph(self, paragName):
"""
@param paragName: the name of the paragraph
@type paragName: String
@return: the L{Paragraph} instance which have the name paragName. If no pragraph with name paragName was found, return None.
@rtype: a L{Paragraph} instance
@call: L{getInfo}
"""
return self._parameters.getParagraph( paragName)
def addParagraph(self, paragraph):
"""
Add a L{Paragraph} or a sequence of Paragraph instance at the Program top level
@param paragraph: the paragraph to add
@type paragraph: L{Paragraph} instance.
"""
if type(paragraph) == type([]) or type(paragraph) == type( () ):
for parag in paragraph:
self._parameters.addParagraph(parag)
parag.setFather(self)
parag.setEvaluator(self._evaluator)
else:
self._parameters.addParagraph(paragraph)
paragraph.setFather(self)
paragraph.setEvaluator( self._evaluator)
def getPath(self, name):
"""
@param name: a name of the L{Paragraph} or L{Parameter}
@type name: String
@return: a string corresponding to the path of the paragraph or parameter name. each name is separated by a /
@rtype: string
@call: L{Parameters.getPath} , L{Program.getPath}
"""
return self._parameters.getPath(self, name)
def _getPara(self, name):
"""
@param name: the name of a Parameter or a Paragraph
@type name: String
@return: an instance of the L{Parameter} or the L{Paragraph} which have the name name. this method is used by methods which could call either with a parameter or a paragraph as argument eg get/setArgpos()
@rtype: an object of L{Para} type. Para is an abstract class thus in fact a L{Parameter} or the L{Paragraph} instance.
@call: by all Program methods delegated to the Para L{Para.getPrompt} , L{Para.promptLangs}, L{Para.promptHas_lang}, L{Para.setPrompt}, L{Para.hasFormat}, L{Para.getFormat}, L{Para.formatHas_proglang}, L{Para.formatProglangs}, L{Para.setFormat}, L{Para.getPrecond}, L{Para.precondHas_proglang}, L{Para.precondProglangs}.
"""
result = self.getParameter(name)
if result :
return result
else:
return self._getParagraph(name)
def addInfo(self, content, proglang = None , lang = None , href = False):
"""
Set an info on this Program
Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
@param content: an info on the Program or a href toward an info
@type content: String
@param proglang: the programming language of the info code
@type proglang: String
@param lang: is the symbol of a language in iso639-1 (ex:english= 'en',french= 'fr')
@type lang: String
@param href: True if the content is a href, False otherwise
@type href: Boolean
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "an info couldn't be a text and a code or href in the same time"
if proglang:
self._parameters.addInfo( content , proglang = proglang)
elif lang:
self._parameters.addInfo( content , lang = lang)
elif href:
self._parameters.addInfo( content )
else :
raise ServiceError, "invalid argument for info : " + str(proglang) + str(lang) + str(href)
def getInfo(self, paragraphName=None, proglang =None ,lang= None, href = False):
"""
Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
@param paragraphName: the name of a paragraph, if paragraphName = None the method return the info of the Program. if paragraphName couldn't be found a ServiceError will be raised
@type paragraphName: String
@param proglang: The programming language of the info code
@type proglang: String
@param lang: is the symbol of a language in iso639-1 (ex: 'en', 'fr') for a text info
@type lang: String
@param href: True if the info is a href, False otherwise
@type href: Boolean
@return: the info corresponding to the specified lang, proglang or href.
@rtype: string.
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "an info couldn't be a text and a code or a href in the same time "
if paragraphName:
paragraph = self._getParagraph(paragraphName)
if paragraph:
if proglang:
return paragraph.getInfo( proglang = proglang)
elif lang:
return paragraph.getInfo( lang = lang)
elif href:
return paragraph.getInfo( )
else :
raise ServiceError, "invalid argument for info : " +str(lang)+" , "+str(proglang)+" , "+str(href)
else:
raise ServiceError, "the paragraph with name "+str(paragraphName)+" doesn't exist"
else:
if proglang:
return self._parameters.getInfo( proglang = proglang)
elif lang:
return self._parameters.getInfo( lang = lang)
elif href:
return self._parameters.getInfo( )
else :
raise ServiceError, "invalid argument for info : " +str(lang)+" , "+str(proglang)+" , "+str(href)
def infoProglangs(self):
"""
@return: the list of programming languages used by the info codes.
@rtype: list of string.
"""
return self._parameters.infoProglangs()
def infoHas_lang(self, lang='en'):
"""
@param lang: the symbol of a language in iso639-1 (ex: 'en', 'fr')
@type lang: String
@return: True if the info has a text written in lang. False otherwise.
@rtype: boolean.
"""
return self._parameters.infoHas_lang( lang= lang)
def infoLangs(self):
"""
@return: the list of languages used by the info texts
@rtype: a list of string.
"""
return self._parameters.infoLangs()
def infoHas_href(self):
"""
@return: True if the info has a 'href', False otherwise.
@rtype: boolean.
"""
return self._parameters.infoHas_href()
##############################################
# #
# delegated methods to the header #
# #
##############################################
def getUrl(self):
"""
@return: the url of the definition of this Program
@rtype: string
"""
return self.header.getUrl()
def getPackageTitle(self):
"""
@return: a String representing the Package title
@rtype: string
"""
return self.header.getPackageTitle()
def getTitle(self):
"""
@return: a String representing the L{Program} title
@rtype: string
"""
return self.header.getTitle()
def getPackageName(self):
"""
@return: a String resprenting the name of the Package.
@rtype: string
"""
return self.header.getPackageName()
def getName(self):
"""
@return: a String resprenting the name of the L{Program}.
@rtype: string
"""
return self.header.getName()
def getPackageVersion(self):
"""
@return: a String representing the version of the Package
@rtype: string
"""
return self.header.getPackageVersion()
def getVersion(self):
"""
@return: a String representing the version of the program
@rtype: string
"""
return self.header.getVersion()
def getPackageDoclinks(self):
"""
@return: a list of Strings. Each String represent a documentation link
"""
return self.header.getPackageDoclinks()
def getDoclinks(self):
"""
@return: a list of Strings. Each String represent a documentation link
"""
return self.header.getDoclinks()
def getPackageCategories(self):
"""
@return: the list of String, each string representing
a category in which the Package is classified.
@rtype: a list of String
"""
return self.header.getPackageCategories()
def getCategories(self):
"""
@return: the list of String, each string representing
a category in which the Program is classified.
@rtype: a list of String
"""
return self.header.getCategories()
# def getHelp(self, lang = None, proglang =None , href = False):
# """
# Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
# @param proglang: The programming language of the help code
# @type proglang: String
# @param lang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text
# @type lang: String
# @param href: True if the content is a href false otherwise
# @type href: boolean
# @return: the help corresponding to the specified lang or proglang or href
# @rtype: string.
# """
# self.header.getHelp(lang = lang, proglang =proglang , href = href )
#
#
# def helpHas_proglang(self, proglang = 'python'):
# """
# @param proglang: the programming language that encode the help
# @type proglang: String
# @return: True if a code written in proglang is used for the help,
# False otherwise.
# @rtype: boolean.
# """
# return self.header.helpHas_proglang( proglang = proglang)
#
# def helpProglangs(self):
# """
# @return: the list of proglangs used for the code help.
# @rtype: list of string.
# """
# return self.header.helpProglangs()
#
# def helpHas_lang(self, lang='en'):
# """
# @return: True if the help has a text written in lang. False otherwise
# @rtype: boolean.
# """
# return self.header.helpHas_lang( lang= lang)
#
#
# def helpLangs(self):
# """
# @return: the list of langs used for the help texts.
# @rtype: a list of string
# """
# return self.header.helpLangs()
#
#
# def helpHas_href(self):
# """
# @return: True if the help has a 'href', False otherwise.
# @rtype: boolean
# """
# return self.header.helpHas_href()
#
#
# def helpHrefs(self):
# """
# @return: The list of href for the help.
# @rtype: list of string
# """
# return self.header.helpHrefs()
def getCommand(self):
"""
@return: (name, type , path)
1. for local program:
- name is the name of the program
- type is 'local' (by default)
- path is the path where is the program (by default the $PATH variable)
2. for cgi:
- name is the name of the cgi
- type is the method to call the cgi ( GET | POST | POSTM )
- path is the url where is the script 'http://www.myDomain.org'
3. for web Program:
- name is the name of the method
- type is the protocol to call the ws (soap | xml-rpc | ... )
- path is the url of the wsdl
@rtype: tuple of 3 string (name, type, path).
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.header.getCommand()
def getEnv(self, varName):
"""
@param varName: the name of the environment variable.
@type varName: String
@return: the value of the environment variable, if there is no environment variable return None.
@rtype: string or None
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.header.getEnv(varName )
def envHas_var(self, var):
"""
@param var: the name of the environment variable
@type var: String
@return: True the variable var is specified, False otherwise.
@rtype: boolean.
"""
return self.header.envHas_var(var)
def envVars(self):
"""
@return: the names of all environment variables.
@rtype: string
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.header.envVars()
##############################################
# #
# delegated methods to the parameter #
# #
##############################################
def setValue(self, paramName, value):
"""
Set the current value for this parameter.
@param paramName: a parameter name
@type paramName: String
@param value: the value to set for this parameter
@type value: any
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call: L{MobyleJob}._fillEvaluator()
"""
param = self.getParameter( paramName )
if param :
param.setValue( value )
else:
raise ServiceError ,self._paramError + str( paramName )
def getValue(self, paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: The current value of the parameter. if the value is not defined return None
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}, L{doCtrls}
"""
param = self.getParameter( paramName)
if param :
return param.getValue()
else:
raise ServiceError , self._paramError + str( paramName )
def setValueAsVdef( self , paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call:
"""
param = self.getParameter( paramName )
if param :
param.setValueAsVdef()
else:
raise ServiceError ,self._paramError + str( paramName )
def reset( self , paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call:
"""
param = self.getParameter( paramName )
if param :
return param.reset()
else:
raise ServiceError ,self._paramError + str( paramName )
def resetAllParam( self ):
"""
@param paramName: a parameter name
@type paramName: String
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call:
"""
params ={}
for param in self._getAllParameter():
params[ param.getName() ] = param.reset()
return params
def validate(self, paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if the value is valid. otherwise a UserValueError is raised.
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@raise UserValueError: a L{UserValueError} is raised if the value can't be validate.
@call: L{MobyleJob}
"""
param = self.getParameter( paramName)
if param :
param.validate()
else:
raise ServiceError , self._paramError + str( paramName )
def convert(self, paramName , value , acceptedMobyleType ):
"""
@param paramName: a parameter name
@type paramName: String
@param value: the value to convert
@type value: any
@return: the value cast in the right type
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@raise :
@call: L{MobyleJob , CommnadBuilder}
"""
param = self.getParameter( paramName)
if param :
return param.convert( value , acceptedMobyleType )
else:
raise ServiceError , self._paramError + str( paramName )
def getType(self , paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@return: a mobyle Type of this parameter.
@rtype: L{MobyleType} instance
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getType()
else:
raise ServiceError , self._paramError + str( paramName )
def getDataType(self , paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@return: the data type of this parameter.
@rtype: ( string class , string superclass | None )
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getDataType()
else:
raise ServiceError , self._paramError + str( paramName )
def getBioTypes( self , paramName):
param = self.getParameter( paramName)
if param :
return param.getBioTypes()
else:
raise ServiceError , self._paramError + str( paramName )
def getAcceptedDataFormats( self , paramName):
param = self.getParameter( paramName)
if param :
return param.getAcceptedDataFormats()
else:
raise ServiceError , self._paramError + str( paramName )
def forceReformating( self , paramName):
param = self.getParameter( paramName)
if param :
return param.forceReformating()
else:
raise ServiceError , self._paramError + str( paramName )
def getDataFormat( self , paramName):
param = self.getParameter( paramName)
if param :
return param.getDataFormat()
else:
raise ServiceError , self._paramError + str( paramName )
def hasVdef(self,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if the parameter has a defined vdef, False otherwise.
@rtype: boolean.
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
if param.vdefKeys():
return True
else:
return False
else:
raise ServiceError , self._paramError + str( paramName )
def getVdef( self , paramName ):
"""
If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@param paramName: a parameter name
@type paramName: String
@return: the default value for the parameter.it could be a code or a list of value
@rtype: String or list (it's depends of the parameter type).
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getVdef()
else:
raise ServiceError , self._paramError + str( paramName )
def ismandatory(self, paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter must be specify by the user, False otherwise.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call: by L{Job.__init__()}
"""
param = self.getParameter( paramName )
if param :
return param.ismandatory()
else:
raise ServiceError , self._paramError + str( paramName )
def ishidden(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter is hidden in html interface, False otherwise.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.ishidden()
else:
raise ServiceError , self._paramError + str( paramName )
def iscommand(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter is the command, False otherwise.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@call: by L{CommandBuilder.buildLocalCommand()<CommandBuilder>}
"""
param = self.getParameter( paramName)
if param :
return param.iscommand()
else:
raise ServiceError , self._paramError + str( paramName )
def issimple(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter appear in the simple interface,
False otherwise
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.issimple()
else:
raise ServiceError , self._paramError + str( paramName )
def isout(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter is an output of the program, False otherwise.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.isout()
else:
raise ServiceError , self._paramError + str( paramName )
def isstdout( self ,paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter is the standard output of the program, False otherwise.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.isstdout()
else:
raise ServiceError , self._paramError + str( paramName )
def isInfile(self , paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if this parameter should be transform in file (the parameter type is a Sequence or Text and isout is false).
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.isInfile()
else:
raise ServiceError , self._paramError + str( paramName )
def isOutfile(self , paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if the value of this parameter is a file(s) name (the parameter type is a Sequence or Text and isout is True).
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.isOutfile()
else:
raise ServiceError , self._paramError + str( paramName )
def ismaininput(self , paramName ):
"""
@param paramName: a parameter name
@type paramName: String
@return: True if the value of this parameter is a main input data.
@rtype: boolean
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.ismaininput()
else:
raise ServiceError , self._paramError + str( paramName )
def getMainInputs( self ):
"""
@return: the list of main input parameter names
@rtype: list of strings
"""
params = self._getAllParameter()
mainInputs = [ param.getName() for param in params ]
return mainInputs
def getFormfield(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: how the parameter will appear in the interface. ex in web interface formfield could be : checkbox, select ...
@rtype: string
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
param =self.getParameter( paramName)
if param :
return param.getFormfield()
else:
raise ServiceError , self._paramError + str( paramName )
def getBioMoby(self ,paramName):
"""
@param paramName: a parameter name
@type paramName: String
@return: the name of the corresponding object in the BioMoby-S ontology.
@raise ServiceError: If the paramName doesn't match with any parameter
name a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getBioMoby()
else:
raise ServiceError , self._paramError + str( paramName )
def getPrompt(self , name, lang= None ):
"""
@param name: a parameter or paragraph name
@type name: String
@param lang: the language of the prompt
@type lang: should be String according to MNtoken iso639-1 (english='en' , french= 'fr ...)
@return: the Prompt of the paragraph or the parameter. if there is no prompt for this parameter return None.
@rtype: string or None
@call: L{MobyleError.UserValueError}
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.getPrompt( lang )
else :
raise ServiceError, "this program does not containt neither parameter nor paragraph named: " + str(name)
def promptLangs(self, name):
"""
@param name: a parameter or paragraph name
@type name: String
@return: the list of language in which the prompt is written.
@rtype: list of strings
@call: L{Job}
@call: L{MobyleError.UserValueError<UserValueError>}
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.promptLangs()
else :
raise ServiceError, "this program does not containt neither parameter nor paragraph named: " + str(name)
def promptHas_lang(self, name, lang):
"""
@param name: a parameter or paragraph name
@type name: String
@param lang: the language in which is written the prompt
@type lang: String
@return: True if the prompt is written in lang, False otherwise.
@rtype: boolean.
@call: L{Job}
@call: L{MobyleError.UserValueError<UserValueError>}
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.promptHas_lang( lang )
else :
raise ServiceError, "this program does not containt neither parameter nor paragraph named: " + str(name)
def setPrompt(self, name, prompt , lang='en'):
"""
set the Prompt for the paragraph or the parameter
@param name: a parameter or paragraph name
@type name: String
@param prompt: the paragraph or parameter prompt
@type prompt: String
@param lang: the language of the prompt
@type lang: should be String according to MNtoken iso639-1 (english='en' ,french= 'fr ...).
@raise ServiceError: If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
"""
## n'est pas appele le parser appel directement les fonctions du paragraph ou du parameter
para =self._getPara(name)
if para :
para.setPrompt( prompt, lang)
else:
raise ServiceError , "this program does not containt neither parameter nor paragraph named: " + str(name)
def hasFormat(self, paramName):
"""
@return: True if the L{Parameter} has a format, False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
"""
para =self._getPara(paramName)
if para :
para.hasFormat( )
else:
raise ServiceError , "this program does not containt neither parameter nor paragraph named: " + str(paramName)
def getFormat(self ,name, proglang):
"""
If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
@param name: a parameter or paragraph name
@type name: String
@param proglang: the programming language in which the code is written
@type proglang: string
@return: the format
@rtype: string
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.getFormat(proglang)
else:
return None
def formatHas_proglang(self, name, proglang='python'):
"""
@param name: a parameter or paragraph name
@type name: String
@param proglang: the name of a programming language.
@type proglang: string.
@return: True if a format written in proglang exist, False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.formatHas_proglang( proglang )
else :
raise ServiceError, "this program does not containt neither parameter nor paragraph named: " + str(name)
def formatProglangs(self, name):
"""
@param name: a parameter or paragraph name
@type name: String
@return: A list containing the proglang used to encode the format.
@rtype: list of strings.
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.formatProglangs()
else :
raise ServiceError, "this program does not containt neither parameter nor paragraph named: " + str(name)
def setFormat(self, name, format , proglang="python"):
"""
set the Format for the paragraph or the parameter according to the name
@param name: a parameter or paragraph name
@type name: String
@param format: the paragraph or parameter format
@type format: String
@param proglang:
@type proglang: String
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
para =self._getPara(name)
if para :
para.setFormat( format, proglang)
else:
raise ServiceError , "this program does not containt neither parameter nor paragraph named: "+str(name)
def getPreconds(self , name, proglang='python'):
"""
@param name: a parameter or paragraph name
@type name: String
@param proglang:
@type proglang: String
@return: a list of string representing the preconds of the parameter or paragraph and
all preconds of parents paragraph in reverse order.
if no precond could be found return []
@rtype: list of strings .
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@call: by L{Mobyle.CommandBuilder.buildLocalCommand}
"""
para = self._getPara(name)
if para :
return para.getPreconds(proglang)
else:
return ServiceError , "this program does not containt neither parameter nor paragraph named: "+str(name)
def precondHas_proglang(self, name, proglang):
"""
@param name: a parameter or paragraph name
@type name: String
@param proglang: the programming language
@type proglang: String
@return: True if the precond is encoded in this programming language, False othewise
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.precondHas_proglang(proglang)
else:
return ServiceError , "this program does not containt neither parameter nor paragraph named: "+str(name)
def precondProglangs(self , name):
"""
If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
@param name: a parameter or paragraph name
@type name: String
@return: a list of programming laguage in which the precond is encoded.
@rtype: list of strings.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para :
return para.precondProglangs()
else:
return ServiceError , "this program does not containt neither parameter nor paragraph named: "+str(name)
def getVlist(self ,paramName,label):
"""
@param paramName: the name of the parameter
@type paramName: A String
@param label: a label of the vlist
@type label: a String
@return: the String representing value associated to this label.
@rtype: string.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getVlist(label)
else:
raise ServiceError , self._paramError + str( paramName )
def vlistLabels(self,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: a list of String representing all the labels .
@rtype: a list of strings.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.vlistLabels()
else:
raise ServiceError , self._paramError + str( paramName )
def vlistHas_label(self, paramName,label):
"""
@param paramName: the name of the parameter
@type paramName: a String
@return: True if the parameter with name paramName has a label == label
False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.vlistHas_label(label)
else:
raise ServiceError , self._paramError + str( paramName )
def hasVlist(self, paramName):
"""
@param paramName: the name of the parameter
@type paramName: a String
@return: Return True if the parameter has a vlist, False othewise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.hasVlist()
else:
raise ServiceError , self._paramError + str( paramName )
def hasFlist(self, paramName):
"""
@param paramName: the name of the parameter
@type paramName: a String
@return: True if the Parameter has a flist, False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.hasFlist()
else:
raise ServiceError , self._paramError + str( paramName )
def flistValues(self, paramName):
"""
@param paramName: the name of the parameter
@type paramName: a String.
@return: a list of all values of the vlist
@rtype: list of string.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.flistValues()
else:
raise ServiceError , self._paramError + str( paramName )
def flistHas_value(self,paramName, value):
"""
@param paramName: the name of the parameter
@type paramName: a String
@param value: the value to link the code to the label vlist
@type value: integer
@return: True if the the flist has a value == value, False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@raise UnDefAttrError: if the parameter hasn't flist a UnDefAttrError is raised
"""
param = self.getParameter( paramName)
if param :
return param.flistHas_value( value )
else:
raise ServiceError , self._paramError + str( paramName )
def flistProglangs(self,paramName, value):
"""
@param paramName: the name of the parameter
@type paramName: a String
@param value:
@type value:
@return: the list of proglang available for a given value.
@rtype: a list of strings.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@raise UnDefAttrError: if the parameter hasn't flist a L{UnDefAttrError} is raised
"""
param = self.getParameter( paramName)
if param :
return param.flistProglangs( value )
else:
raise ServiceError, self._paramError + str( paramName )
def flistHas_proglang(self,paramName , value , proglang):
"""
@param paramName: the name of the parameter
@type paramName: a String
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: Boolean, True if the flist has the value and a code written in proglang associated with, False otherwise.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@raise UnDefAttrError: if the parameter hasn't flist a UnDefAttrError is rais
"""
param = self.getParameter( paramName)
if param :
return param.flistHas_proglang( value , proglang )
else:
raise ServiceError , self._paramError + str( paramName )
def getFlistCode(self ,paramName, value, proglang):
"""
@param paramName: the name of the parameter
@type paramName: a String
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: the code associated with the value and written in proglang. if there isn't this value or this proglang an Error is raised.
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
@raise L{ ServiceError}: if there isn't this value or this proglang an L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getFlistCode(value, proglang)
else:
raise ServiceError , self._paramError + str( paramName )
def getArgpos(self ,name):
"""
If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
@param name: a parameter or paragraph name
@type name: String
@return: an int representing the argpos of a parameter or a paragraph
if argpos isn't defined, return the argpos of the upper paragraph and so on.
if no argpos could be found return 1
@rtype: integer.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para:
return para.getArgpos()
else:
raise ServiceError , self._paramError + str( name )
def setArgpos(self, name,value):
"""
set the argpos to value for the paragraph or the parameter
@param name: A parameter or paragraph name.
@type name: String.
@param value: The argpos.
@type value: Integer.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
para = self._getPara(name)
if para:
para.setArgpos(value)
else:
raise ServiceError, "this program does not containt neither parameter nor paragraph named: "+str(name)
def has_ctrl(self,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: True if the parameter has L{Ctrl}, False otherwise.
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.has_ctrl()
else:
raise ServiceError , self._paramError + str( paramName )
def getCtrls(self ,paramName):
"""
If the paramName doesn't match with any parameter name a L{ServiceError} is raised.
@param paramName: the name of a parameter
@type paramName: String
@return: a list of L{Ctrl} instances for the parameter.
@rtype: [ L{Ctrl} instances,...]
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getCtrls()
else:
raise ServiceError , self._paramError + str( paramName )
def doCtrls(self , paramName):
"""
do the controls specific to the parameter paramName
@return: if the control are Ok return True other wise a UserValueError is raised.
@rtype ???: a determiner doit retourner false ou lever une erreur ????
@raise ServiceError: If the name neither match with a parameter name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.doCtrls()
else:
raise ServiceError , self._paramError + str( paramName )
def hasParamfile(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: True if the parameter should be specified in a file
instead the command line, False otherwise
@rtype: boolean.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.hasParamfile()
else:
raise ServiceError , self._paramError + str( paramName )
def getParamfile(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: the name of the parameter file. if the parameter must be
specified in a file instead on the command line.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@raise UnDefAttrErrorError: If the parameter haven't a paramfile an L{UnDefAttrErrorError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getParamfile()
else:
raise ServiceError , self._paramError + str( paramName )
def getAllFileNames(self, proglang = 'python'):
"""
@param proglang: the programming language used to defined the filenames
@type proglang: string
@return: The unix mask ( *.dnd ) which permit to retrieve the results files.
@rtype: list of strings. If there isn't any fileName return an empty list
"""
outParameters = self.getAllOutParameter()
result=[]
for parameter in outParameters:
try:
filenames = self.getFilenames(parameter, proglang = 'python')
for filename in filenames:
if filename not in result:
result.append( filename )
except UnDefAttrError:
continue
return result
def getFilenames(self ,paramName, proglang = 'python'):
"""
@param paramName: the name of the parameter
@type paraName: String
@param proglang: the programming language used to defined the filenames
@type proglang: string
@return: The unix mask ( *.dnd ) which permit to retrieve the results files.
@rtype: string.
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
@call: RunnerFather to fill the 4Child.dump structure
@call: Core in validate method of all "file" parameter
"""
param = self.getParameter( paramName)
if param :
return param.getFilenames( proglang )
else:
raise ServiceError , self._paramError + str( paramName )
def hasScale( self , paramName , proglang = 'python' ):
"""
@return: True if the param has a scale with code in proglang or with value, False otherwise.
@rtype: boolean
"""
param = self.getParameter( paramName)
if param :
return param.hasScale( proglang= proglang )
else:
raise ServiceError , self._paramError + str( paramName )
def isInScale( self , paramName , proglang = 'python'):
"""
@return: True if the value is in range(min, max), false otherwise
@rtype: boolean
"""
param = self.getParameter( paramName)
if param :
return param.isInScale( proglang= proglang )
else:
raise ServiceError , self._paramError + str( paramName )
def getScale(self , paramName , proglang= None):
"""
@param paramName: the name of the parameter
@type paramName: String
@param proglang: the programming language if the scale is defined by codes. if proglang = None, it mean that the scale is defined by values .
@type proglang: String
@return: a tuple (min,max,inc)
-min is either a value if proglang =None or a code if proglang is specified
-max is either a value if proglang =None or a code if proglang is specified
-inc is a value
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getScale(proglang= proglang)
else:
raise ServiceError , self._paramError + str( paramName )
def getSeparator(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: the string used to separate the differents values of a mutipleChoice vlist.
@rtype: string
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getSeparator()
else:
raise ServiceError , self._paramError + str( paramName )
def getWidth(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: the width of the widget.
@rtype: integer
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getWidth()
else:
raise ServiceError , self._paramError + str( paramName )
def getHeight(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: The height of the widget.
@rtype: integer
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getHeight()
else:
raise ServiceError , self._paramError + str( paramName )
def getExemple(self ,paramName):
"""
@param paramName: the name of the parameter
@type paramName: String
@return: A typical value for this parameter
@rtype: string
@raise ServiceError: If the name neither match with a parameter
name nor a paragraph name, a L{ServiceError} is raised.
"""
param = self.getParameter( paramName)
if param :
return param.getExemple()
else:
raise ServiceError , self._paramError + str( paramName )
def getEvaluator(self):
"""
@return: a reference toward the L{Evaluation} instance link to this program.
@rtype: L{Evaluation object}
"""
return self._evaluator
def setEvaluator(self, evaluator):
"""
"""
self._evaluator = evaluator
paras = self._parameters.getAllParagraph()
paras += self._parameters.getAllParameter()
for para in paras:
para.setEvaluator( evaluator)
def isProgram(self):
"""
@return: True
"""
return True
def getFather(self):
"""
@return: None. A program have no father
it's used as stopping condition when a child want to retrieve the program
"""
return None
#############################################################
# #
# Class Parameters #
# #
#############################################################
class Parameters(object):
"""the parameters objects are mainly used to managed the
parameter and paragraph"""
def __init__(self):
self._paragraphList= []
self._parameterList= []
self._info = Text()
def addParagraph(self, paragraph):
"""
add a paragraph instance into this parameters
@param paragraph: the pargraph to add
@type paragraph: a Paragraph object
"""
self._paragraphList.append( paragraph )
def addParameter(self, parameter):
"""
add a parameter instance into this parameters
@param parameter: the parameter to add
@type parameter: a Parameter object
"""
self._parameterList.append( parameter )
def getParagraph(self, paragraphName):
"""
@param paragraphName: the name of a paragraph to retrieve
@type paragraphName: String
@return: the instance of the L{Paragraph} which has the name paragraphName. if no pragraph is found, return None.
@rtype: L{Paragraph} object or None
"""
result = None
for paragraph in self._paragraphList:
if paragraph.getName() == paragraphName:
return paragraph
else:
result = paragraph.getParagraph(paragraphName)
if result:
return result
return None
def getParameter(self, parameterName):
"""
@param parameterName: the name of a parameter to retrieve
@type parameterName: String
@return: the instance of the L{Parameter} which has the name parameterName. if no parameter is found, return None.
@rtype: L{Parameter} object or None
"""
for parameter in self._parameterList:
if parameter.getName() == parameterName :
return parameter
result = None
for paragraph in self._paragraphList:
result = paragraph.getParameter(parameterName)
if result:
return result
return None
def getAllParagraph(self):
"""
@return: all paragraphs instances in a list.
@rtype: list of L{paragraphs <Paragraph>} object.
"""
allParagraph = self._paragraphList[:]
for paragraph in self._paragraphList:
allParagraph += paragraph.getAllParagraph()
return allParagraph
def getAllParameter(self):
"""
@return: all L{parameter <Parameter>} instances in a flat list.
@rtype: list of parameter object.
"""
allParameter = self._parameterList[:]
for paragraph in self._paragraphList:
allParameter += paragraph.getAllParameter()
return allParameter
#getPath ne devrait pas etre appelee directement mais par
#l'intermedaire de getPath du program ou du paragraph
def getPath(self,parent, name):
"""
@param parent: the parent of the paragraph or the program
@type parent: a L{Paragraph} instance or a L{Program} instance
@param name: the name of the paragraph or parameter
@type name: String
@return: the path each name is separated by '/'
@rtype: string
"""
for para in self._thisLevel():
if para.getName() == name :
return parent.getName()+"/"+ name
result = None
for paragraph in self._paragraphList:
result = paragraph.getPath(name)
if result:
return parent.getName()+"/"+ result
return None
def addInfo(self, content, proglang = None , lang = None , href = False):
"""
Set an help on this program
@param content: an help on the program or a href toward an help
@type content: String
@param proglang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text or 'href' for the link
@type proglang: String
@param href: True if the content is a href false otherwise
@type href: boolean
@raise ServiceError: if more than one argument among proglang, lang, href is specified a L{ServiceError} is raised
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "an info couldn't be a text and a code or href at the sametime"
if proglang:
self._info.addCode( content , proglang= proglang)
elif lang:
self._info.addText( content , lang = lang)
elif href:
self._info.addHref( content)
else :
raise ServiceError, "invalid argument for info : " + proglang + lang + href
def getInfo(self, proglang =None, lang = None , href = False):
"""
@param lang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text or 'href' for the link
@type lang: String
@param proglang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text or 'href' for the link
@type proglang: String
@param href: True if the content is a href false otherwise
@type href: Boolean
@return: the info corresponding to the specified lang or proglang or href.
@rtype: string
@raise ServiceError: if more than one argument among proglang, lang, href is be specified a L{ServiceError} is raised
@raise MobyleError: a L{MobyleError} is propagated if there isn't any code written in proglang or text in lang or if href is true and it's not a href
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "the info couldn't be a text and a code or a href at the same time"
if proglang:
return self._info.getCode( proglang)
elif lang:
return self._info.getText( lang)
elif href:
return self._info.hrefs( )
else :
raise ServiceError, "invalid argument for info : " +str(lang)+" , "+str(proglang)+" , "+str(href)
def infoHas_proglang(self, proglang = 'python'):
"""
@return: True if the info is encoded in the programming language proglang, False otherwise.
@rtype: boolean.
"""
return self._info.has_code( proglang)
def infoProglangs(self):
"""
@return: the list of programming languages used for the info codes
@rtype: list of string.
"""
return self._info.proglangs()
def infoHas_lang(self, lang='en'):
"""
@return: True if the info has a text written in lang. False otherwise.
@rtype: boolean.
"""
return self._info.has_lang(lang)
def infoLangs(self):
"""
@return: the list of langs used for the info texts.
@rtype: list of strings
"""
return self._info.langs()
def infoHas_href(self):
"""
@return: True if the info has a 'href', False otherwise.
@rtype: boolean
"""
return self._info.has_href()
def _thisLevel(self):
"""
@return: all paragraph and parameter of this level in a list
@rtype: list of L{Para} instances
"""
return self._parameterList[:]+ self._paragraphList[:]
# def isProgram(self):
# return False
############################################################
# #
# Class header #
# #
############################################################
class Package(object):
def __init__(self):
self.name = None
self.version = None
self.doclinks = []
self.categories = []
def setTitle(self, value):
"""
set the title of the Program
@param value: the Program title
@type value: String
"""
try:
value + "a"
self.title = value
except TypeError:
raise ServiceError , "the title must be a String"
def setName(self, value):
"""
set the name of the L{Program} to value
@param value: the L{Program} name
@type value: String
"""
try:
value + "a"
self.name = value
except TypeError:
raise ServiceError , "the name must be a String"
def setVersion(self, value):
"""
set the version of the program
@param value: the version of the program
@type value: String
"""
self.version = value
def addDoclink(self, values):
"""
Add a link toward a documentation
@param values:
@type values: a list or a tuple of Strings
"""
if type(values) == type([]) or type(values) == type( () ):
self.doclinks += values
else:
self.doclinks.append( values )
def addCategories(self, values):
"""
add a category or sequence of categories in categories
@param values: a category or a sequence of categories.
@type values: String or Strings sequence.
"""
#if values is a list or a tuple of categories
if type(values) == type([]) or type(values) == type( () ):
self.categories += values
else:
self.categories.append(values)
class ProgramHeader(Package):
def __init__(self):
super(ProgramHeader, self).__init__()
self.command = ('' , '' , '') #will be a tuple like (name, type, path)
self.env = {}
def setUrl(self , url ):
"""
@param url: the url of this Program definition
@type url: string
"""
self.url = url
def setCommand(self, name, type='local', path=None):
"""
set the name, the type and the path of the command
@param name:
1. for local program: is the name of the program
2. for cgi: is the name of the cgi
3. for web Program: is the name of the method
@type name: String
@param type:
1. for local program: is 'local' (by default)
2. for cgi: is the method to call the cgi ( GET | POST | POSTM )
3. for web Program: is the protocol to call the ws (soap | xml-rpc | ... )
@type type: String
@param path:
1. for local program: is the path where is the program (by default the $PATH variable)
2. for cgi: is the url where is the script 'http://www.myDomain.org'
3. for web Program: is the url of the wsdl
@type path: String
"""
self.command = ( name, type, path )
def addEnv(self, var, value):
"""
add an variable environment need to run the programm
@param var: the name of the variable
@type var: String
@param value: the value of the environment variable
@type value: String
"""
self.env[ var ] = value
def getEnv(self, varName):
"""
@param varName: the name of the environment variable.
@type varName: String
@return: the value of the environment variable, if there is no environment variable return None.
@rtype: string or None
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
if self.env:
try:
return self.env[ varName ]
except KeyError:
return None
else:
return None
def envHas_var(self, var):
"""
@param var: the name of the environment variable
@type var: String
@return: True the variable var is specified, False otherwise.
@rtype: boolean.
"""
return var in self.env
def envVars(self):
"""
@return: the names of all environment variables.
@rtype: string
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.env.keys()
class Header(object):
def __init__(self , package , program_header ):
self.package_header = package
self.prog_header = program_header
def setUrl(self, serviceUrl):
"""
to keep backward compliance
"""
self.prog_header.setUrl(serviceUrl)
def getUrl(self):
"""
@return: the url of the definition of this Program
@rtype: string
"""
return self.prog_header.url
def getPackageTitle(self):
"""
@return: a String representing the Package title
@rtype: string
"""
try:
return self.package_header.title
except AttributeError:
return self.prog_header.title
def getTitle(self):
"""
@return: a String representing the L{Program} title
@rtype: string
"""
return self.prog_header.title
def getPackageName(self):
"""
@return: a String resprenting the name of the package.
@rtype: string
"""
try:
return self.package_header.name
except AttributeError:
return self.prog_header.name
def getName(self):
"""
@return: a String resprenting the name of the L{Program}.
@rtype: string
"""
return self.prog_header.name
def getPackageVersion(self):
"""
@return: a String representing the version of the Package
@rtype: string
"""
try:
return self.package_header.version
except AttributeError:
return self.prog_header.version
def getVersion(self):
"""
@return: a String representing the version of the program
@rtype: string
"""
try:
return self.prog_header.version
except AttributeError:
return self.package_header.version
def getPackageDoclinks(self):
"""
@return: a list of Strings. Each String represent a documentation link
"""
try:
return self.package_header.doclinks
except AttributeError:
return self.prog_header.doclinks
def getDoclinks(self):
"""
@return: a list of Strings. Each String represent a documentation link
"""
return self.prog_header.doclinks
def getPackageCategories(self):
"""
@return: the list of String, each string representing
a category in which the Package is classified.
@rtype: a list of String
"""
try:
return self.package_header.doclinks
except AttributeError:
return self.prog_header.categories
def getCategories(self):
"""
@return: the list of String, each string representing
a category in which the Program is classified.
@rtype: a list of String
"""
return self.prog_header.categories
def getCommand(self):
"""
@return: (name, type , path)
1. for local program:
- name is the name of the program
- type is 'local' (by default)
- path is the path where is the program (by default the $PATH variable)
2. for cgi:
- name is the name of the cgi
- type is the method to call the cgi ( GET | POST | POSTM )
- path is the url where is the script 'http://www.myDomain.org'
3. for web Program:
- name is the name of the method
- type is the protocol to call the ws (soap | xml-rpc | ... )
- path is the url of the wsdl
@rtype: tuple of 3 string (name, type, path).
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.prog_header.command
def getEnv(self, varName):
"""
@param varName: the name of the environment variable.
@type varName: String
@return: the value of the environment variable, if there is no environment variable return None.
@rtype: string or None
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.prog_header.getEnv(varName)
def envHas_var(self, var):
"""
@param var: the name of the environment variable
@type var: String
@return: True the variable var is specified, False otherwise.
@rtype: boolean.
"""
return self.prog_header.envHas_var(var)
def envVars(self):
"""
@return: the names of all environment variables.
@rtype: string
@call: L{CommandBuilder.BuildLocalCommand<CommandBuilder>}
"""
return self.prog_header.envVars()
# def addHelp(self, content, proglang = None , lang = None , href = False):
# """
# Set an help on this Program. Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
# @param content: an help on the Program or a href toward an help
# @type content: String
# @param proglang: The programming language of the help code
# @type proglang: String
# @param lang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text
# @type lang: String
# @param href: True if the content is a href false otherwise
# @type href: boolean
# """
#
# if ( (proglang and lang) or (proglang and href) or (lang and href) ):
# raise ServiceError, "an help couldn't be a text and a code or href at the same time"
# if proglang:
# self._help.addCode( content , proglang)
# elif lang:
# self._help.addText( content , lang)
# elif href:
# self._help.addHref( content)
# else :
# raise ServiceError, "invalid argument for help : " + proglang + lang + href
#
#
#
# def getHelp(self, lang = None, proglang =None , href = False):
# """
# Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
# @param proglang: The programming language of the help code
# @type proglang: String
# @param lang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text
# @type lang: String
# @param href: True if the content is a href false otherwise
# @type href: boolean
# @return: the help corresponding to the specified lang or proglang or href
# @rtype: string.
# """
#
# if ( (proglang and lang) or (proglang and href) or (lang and href) ):
# raise ServiceError, "an help couldn't be a text and a code or href in the same time "
# if proglang:
# return self._help.getCode( proglang)
# elif lang:
# return self._help.getText( lang)
# elif href:
# return self._help.hrefs( )
# else :
# raise ServiceError, "invalid argument for help : " +str(lang)+" , "+str(proglang)+" , "+str(href)
#
#
#
# def helpHas_proglang(self, proglang = 'python'):
# """
# @param proglang: the programming language that encode the help
# @type proglang: String
# @return: True if a code written in proglang is used for the help,
# False otherwise.
# @rtype: boolean.
# """
# return self._help.has_proglang( proglang)
#
# def helpProglangs(self):
# """
# @return: the list of proglangs used for the code help.
# @rtype: list of string.
# """
# return self._help.proglangs()
#
# def helpHas_lang(self, lang='en'):
# """
# @return: True if the help has a text written in lang. False otherwise
# @rtype: boolean.
# """
# return self._help.has_lang(lang)
#
#
# def helpLangs(self):
# """
# @return: the list of langs used for the help texts.
# @rtype: a list of string
# """
# return self._help.langs()
#
#
# def helpHas_href(self):
# """
# @return: True if the help has a 'href', False otherwise.
# @rtype: boolean
# """
# return self._help.has_href()
#
#
# def helpHrefs(self):
# """
# @return: The list of href for the help.
# @rtype: list of string
# """
# return self._help.hrefs()
############################################################
# #
# abstract Class Para #
# #
############################################################
class Para(object):
"""
This class is abstract thus it should never be instanciate.
The class Para is used to group the attributes and
shared methods by parameters and paragraph together.
"""
def __init__(self, evaluator ):
self._debug = None
self._father = None
self._evaluator = evaluator
self._name = None
self._argpos = None
self._prompt = {}
self._precond = {}
self._format = {}
def __str__(self):
if self._name:
return self._name
else:
return repr( self )
def setName(self, value):
"""
set the name of the paragraph or parameter to value.
Two paragraphs or parameter can't have the same name
@param value: the name of the paragraph or parameter
@type value: String
"""
self._name = value
def getName(self):
"""
@return: The name of this para(graph or meter)
@rtype: string
"""
return self._name
def getArgpos(self ):
"""
@return: the argpos for the paragraph or parameter
- if argpos isn't defined, return the argpos of the upper paragraph and so on.
- if no argpos could be found, return 1
@rtype: number
"""
if self._argpos != None :
return self._argpos
else:
if self._father.isProgram():
return 1
else:
return self._father.getArgpos()
def getDebug(self ):
"""
@return: the debug level
@rtype: int
"""
if self._debug is None :
debug = self._father.getDebug()
if debug is None:
debug = 0
self._debug = debug
return self._debug
def setArgpos(self, value):
"""
set the argpos to value for this paragraph or parameter
@param value: the argpos value
@type value: Integer
"""
try:
value + 3
self._argpos = value
except TypeError:
raise ServiceError , "argpos must be a number"
def addPrompt(self, value, lang="en"):
"""
add a prompt to this parameter or paragraph
@param value: the prompt to add
@type value: String
@param lang: the laguage encoding the prompt: it should be iso639-1 compliant
@type lang: String
"""
self._prompt[ lang ] = value
def getPrompt(self, lang = None):
"""
@param lang: the laguage encoding the prompt: it should be iso639-1 compliant
@type lang: String
@return: The prompt. if there is no prompt , return None
@rtype: string
"""
if not lang:
lang =_cfg.lang()
try:
return self._prompt[ lang ]
except KeyError:
return None
def promptLangs(self):
"""
@return: the list of language in which the prompt is written.
@rtype: string
"""
return self._prompt.keys()
def promptHas_lang(self,lang):
"""
@param lang: the language in which is written the prompt
@type lang: String
@return: True if the prompt is written in lang, False otherwise.
@rtype: boolean.
"""
return self._prompt.has_key( lang )
def getPreconds(self , proglang= 'python' ):
"""
@param proglang: the programming language which encode the precond
@type proglang: String
@return: the list of precond in reverse order. If no precond could be found return [].
@rtype: list of string
"""
preconds = []
father = self.getFather()
if not father.isProgram():
prec = father.getPreconds( proglang = proglang )
preconds += prec
if self._precond:
pc = self._precond[proglang]
if pc:
preconds += pc
return preconds
def addPrecond(self, precond, proglang='python'):
"""
add a precond for this paragraph or parameter. Be carful if a precond with the same prolang already exist it will be replace by this one
@param precond: the precond to add
@type precond: String
@param proglang: the encoding language for the precond
@type proglang: String
"""
precond = precond.strip()
if self._precond.has_key( proglang ):
self._precond[ proglang ].append( precond )
else:
self._precond[ proglang ]= [ precond ]
def precondHas_proglang(self, proglang):
"""
@param proglang: the programming language
@type proglang: String
@return: True if the precond is encoded in this programming language, False othewise.
@rtype: boolean.
"""
if self._precond:
return self._precond.has_key(proglang)
else:
if self._father.isProgram():
return None
else:
return self._father.precondHas_proglang( proglang )
def precondProglangs(self):
"""
@return: a list of programming laguage in which the precond is encoded.
@rtype: list of string.
"""
if self._precond:
return self._precond.keys()
else:
if self._father.isProgram():
return None
else:
return self._father.precondProglangs()
def hasFormat(self):
"""
@return: True if the L{Parameter} has a format, False otherwise
@rtype: boolean
"""
if self._format:
return True
else:
return False
def getFormat(self , proglang):
"""
@param proglang: the programming language which encode the format
@type proglang: String.
@return: the format
@rtype: string
"""
try:
return self._format[proglang]
except KeyError:
raise ServiceError, "no format for this proglang: "+proglang
def formatProglangs(self):
"""
@return: a list of programming languages.
@rtype: string
"""
return self._format.keys()
def formatHas_proglang(self, proglang='python'):
"""
@param proglang: the name of a programming language.
@type proglang: string.
@return: True if a format written in proglang exist, False otherwise.
@rtype: boolean
"""
return self._format.has_key(proglang)
def addFormat(self, format, proglang):
"""
add a format to this parameter or paragraph
@param format: the format to add
@type format: String
@param proglang: the programming language that encode the format
@type proglang: String
"""
self._format[proglang] = format.strip()
def isProgram(self):
"""
@return: False.
@rtype boolean
"""
return False
def setFather(self,father):
"""
set the father of this paragraph or the paragraph or program at the upper level
@param father: is a reference to the instance of the paragraph or program at the upper level
@type father: a L{Program} or L{Paragraph} instance"""
self._father = father
def getFather(self):
"""
@return: a reference toward the instance of the paragraph or program at the upper level
@rtype: a L{Paragraph} or a L{Program} object
"""
return self._father
def getProgram(self):
program = self.getFather()
while program is not None and not program.isProgram():
program = program.getFather()
return program
def setEvaluator(self, evaluator):
"""
set the evaluator of this paragraph. it's a reference toward the program's evaluator.
@param evaluator: is a reference to the instance of the paragraph or program at the upper level
@type evaluator: a L{Evaluation} instance
"""
self._evaluator = evaluator
def getEvaluator(self):
"""
@return: a reference toward the instance of the L{Evaluation} instance of the program.
@rtype: L{Evaluation} object.
"""
return self._evaluator
############################################################
# #
# Class Paragraph #
# #
############################################################
class Paragraph(Para):
def __init__( self , evaluator ):
Para.__init__(self , evaluator )
self._layout = []
self._parameters = Parameters()
def getParameters(self):
"""
@return: the -L{Parameters} instance
@rtype: Parameters object
"""
return self._parameters
def getParagraph(self, paragraphName):
"""
@param paragraphName: the name of the paragraph to retrieve
@type paragraphName: String
@return: the instance of L{Paragraph} in this paragraph or
in lower paragraph and which have the name parameterName.
@rtype: Paragraph object or None.
"""
return self._parameters.getParagraph(paragraphName)
def addParameter(self, parameter):
"""
add a parameter to this paragraph. The added parameter
will be at a lower level
@param parameter: the parameter to add
@type parameter: A Parameter Instance
"""
self._parameters.addParameter(parameter)
parameter.setFather(self)
parameter.setEvaluator(self._evaluator)
def addParagraph(self, paragraph):
"""
add a paragraph to this paragraph the added paragraph
will be at a lower level
@param paragraph: the paragraph to add
@type paragraph: A Paragraph instance
"""
self._parameters.addParagraph(paragraph)
paragraph.setFather(self)
paragraph.setEvaluator(self._evaluator)
def getParameter(self, parameterName):
"""
@param parameterName: the name of the parameter to retrieve
@type parameterName: String
@return: the instance of L{Parameter} in this paragraph
or in lower paragraph and which have the name parameterName
@rtype: L{Parameter} object or None
"""
return self._parameters.getParameter(parameterName)
def getAllParagraph(self):
"""
@return: all L{Paragraph} instances in this paragraph
@rtype: list of L{Paragraph} instances
"""
return self._parameters.getAllParagraph()
def getAllParameter(self):
"""
@return: all L{Parameter} instances in this paragraph.
@rtype: list of L{Parameter} instances
"""
return self._parameters.getAllParameter()
def getPath(self,name):
"""
@param name: the name of a parameter or paragraph
@type name: String
@return: the path of this paragraph
it have the form program/paragraph1/paragraph2/...[parameter]
@rtype: string
"""
return self._parameters.getPath(self,name)
def addInfo(self, content, proglang = None , lang = None , href = False):
"""
Set an info on this paragraph
Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{PargraphError} is raised.
@param content: an info on the program or a href toward an info
@type content: String
@param proglang: the programming language of the info code
@type proglang: String
@param lang: is the symbol of a language in iso639-1 (ex:english= 'en',french= 'fr')
@type lang: String
@param href: True if the content is a href, False otherwise
@type href: Boolean
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "an info couldn't be a text and a code or href in the same time"
if proglang:
self._parameters.addInfo( content , proglang = proglang)
elif lang:
self._parameters.addInfo( content , lang = lang)
elif href:
self._parameters.addInfo( content )
else :
raise ServiceError, "invalid argument for info : " + proglang + lang + href
def getInfo(self, proglang =None ,lang= None, href = False):
"""
Only one of the arguments proglang, lang or href must be specified. If more than one arguments among these are specified, a L{ServiceError} is raised.
@param proglang: The programming language of the info code
@type proglang: String
@param lang: is the symbol of a language in iso639-1 (ex: 'en', 'fr') for a text info
@type lang: String
@param href: True if the info is a href, False otherwise
@type href: Boolean
@return: the info corresponding to the specified lang, proglang or href
@rtype: string
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise ServiceError, "an info couldn't be a text and a code or a href in the same time "
if proglang:
return self._parameters.getInfo( proglang = proglang)
elif lang:
return self._parameters.getInfo( lang = lang)
elif href:
return self._parameters.getInfo( )
else :
raise ServiceError, "invalid argument for info : " +str(lang)+" , "+str(proglang)+" , "+str(href)
def infoProglangs(self):
"""
@return: the list of programming languages used by the info codes.
@rtype: string.
"""
return self._parameters.infoProglangs()
def infoHas_lang(self, lang='en'):
"""
@param lang: the symbol of a language in iso639-1 (ex: 'en', 'fr')
@type lang: String
@return: True if the info has a text written in lang, False otherwise.
@rtype: boolean
"""
return self._parameters.infoHas_lang( lang= lang)
def infoLangs(self):
"""
@return: the list of languages used by the info texts.
@rtype: list of string.
"""
return self._parameters.infoLangs()
def infoHas_href(self):
"""
@return: True if the info has a 'href', False otherwise.
@rtype: boolean
"""
return self._parameters.infoHas_href()
############################################################
# #
# Class Parameter #
# #
############################################################
class Parameter( Para ):
"""
Parameter is an abstract class which contains all the attributes
and methods common to all parameter subclass
while the class in core.py are the subclass and provide the specific
methods
"""
def __init__(self, mobyleType , evaluator = None , name = None , value=None ):
self._mobyleType = mobyleType
if evaluator is None:
evaluator =Evaluation()
self.cfg = Config()
Para.__init__(self, evaluator )
self._name = name
self._ismandatory = False
self._ishidden = False
self._iscommand = False
self._isstdout = False
self._issimple = False # encore d'actualite ??
self._formfield = ""
self._isout = False
self._ismaininput = False
self._width = None
self._height = None
self._separator = None
self._filenames = {} #the keys are programming language, the values are list of strings
self._paramfile = ""
self._scalemin = {} #the keys is 'value' or a proglang
self._scalemax = {} #the values will be a value or a code
self._scaleinc = None
self._vlist = {} #????????????????????
self._flist = {} #with value as key
self._undefValue = None
self._ctrls = [] # a ctrl list
self._vdef = None
if value is not None:
if self._name is not None:
self.setValue( value )
else:
raise MobyleError , "if value is specified name must be specified"
def clone(self , dt ):
"""does not make realy a clone rather a copy without father cfg and with a new datatype
"""
newMT = self._mobyleType.clone( dt )
newEvaluator = Evaluation( dict = self.getEvaluator()._2dict_() )
newParam = Parameter( newMT , evaluator = newEvaluator )
for attr in self.__dict__.keys() :
if attr not in [ "__builtins__" , "_evaluator" , "_mobyleType" , "cfg" , "_father"]:
setattr(newParam , attr, copy.deepcopy( getattr( self , attr )) )
return newParam
def ancestors( self ):
#1 exclude the parameter self.__class__.__name__ itself
#-3 exclude "Parameter" , "Para" , and "object"
return [ k.__name__ for k in self.__class__.mro()][1:-3]
def getValue( self ):
"""
@return: the current value for this parameter.
If value is not defined return None
@rtype: any
@call: Program.getValue
"""
evaluator = self.getEvaluator()
return evaluator.getVar( self.getName() )
def setValue( self , value ) :
"""
set the current value for this parameter and put it in the evaluation pace.
if the value doesn't match with the parameter's class a UserValueError is
thrown
the SequenceParameter can throws an UnsupportedFormatError if the output
format is nos supported or a MobyleError if something goe's wrong during
the conversion
@param value: the value of this parameter
@type value: any builtin classes (in core.py) or an instance of a class defined by user in ../Classes
@call: Program.setValue
"""
if self.ishidden():
raise MobyleError , "the parameter %s is hidden, it's value cannot be changed" % self.getName()
elif self.isout():
raise MobyleError , "the parameter %s is out, it's value cannot be changed" % self.getName()
else:
if value is not None:
if self._separator is not None:
#if separator is not None the Datatype is a MultipleDataType.
#the argument value is a list
#the value in the evaluator must be the final string
#value = self._separator.join( value )
pass
self.getEvaluator().setVar( self.getName() , value )
else:
self.getEvaluator().setVar( self.getName() , None )
ev = self.getEvaluator()
def setValueAsVdef( self ):
"""
get the vdef and setValue with it
"""
if self.isInfile():
raise MobyleError , "an infile parameter can't have vdef"
vdef = self.getVdef()
if vdef is None :
self.getEvaluator().setVar( self.getName() , None )
else:
convertedVdef , mt = self.convert( vdef )
self.getEvaluator().setVar( self.getName() , convertedVdef )
def renameFile( self, workdir , oldName , newName ):
"""
rename a parameter File, rename the file on the filesystem and chage the value in Evaluator
@param workdir: the absolute path to the job directory (where to find the file
@type workdir: string
@param newName:the file name to rename in the workdir
@type newName: string
"""
if self.isInfile():
try:
os.rename( os.path.join( workdir , oldName ) , os.path.join( workdir , newName ) )
except IOError , err:
raise MobyleError , 'Cannot rename the file corresponding to %s parameter :%s'%( self.getName(),
err)
else:
s_log.error( 'the parameter %s is not an Infile. Cannot rename it\'s file' % self.getName() )
raise MobyleError , 'Internal Mobyle Error'
def reset( self ):
vdef = self.getVdef()
if vdef is not None:
convertedVdef , mt = self.convert( vdef , self.getType() )
if self.getDataType().getName() == 'MultipleChoice':
if convertedVdef is not None:
sep = self.getSeparator()
convertedVdef = sep.join( convertedVdef )
self.getEvaluator().setVar( self.getName() , convertedVdef )
return convertedVdef
else:
self.getEvaluator().setVar( self.getName() , None )
return None
def getVdef( self ):
"""
return: the vdef
@rtype: string or list of string
"""
return self._vdef
def setVdef(self, value ):
"""
set the vdef for this parameter. the vdef is either a value(s) or a code(s).if vdef is a value this one is converted
@param value: the vdef .
@type value :is a value, a code or a list of value or a list of code
- a value = val1
- a list of value = [val1 , val2, ...]
@raise ServiceError: if try to set a vdef and a vdef already exists raise a L{ServiceError}.
"""
if self._vdef:
raise ServiceError, "a vdef is already specify"
else:
value_type = type( value )
if value_type == types.ListType:
if len( value ) == 1 :
self._vdef = value[0]
else:
self._vdef = value
else:
self._vdef = value[0]
def convert( self , value , acceptedMobyleType ):
if self._paramfile:
return self.getDataType().convert( value , acceptedMobyleType , detectedMobyleType = self , paramFile = True )
else:
dt = self.getDataType()
if dt.getName() == 'MultipleChoice':
return dt.convert( value , acceptedMobyleType , detectedMobyleType = self, separator= self.getSeparator())
else:
return dt.convert( value , acceptedMobyleType , detectedMobyleType = self)
def validate(self):
return self.getDataType().validate( self )
def getType( self ):
return self._mobyleType
def getDataType( self ) :
return self._mobyleType.getDataType()
def setDataType(self, dt):
self._mobyleType.dataType= dt
def getBioTypes( self ):
return self._mobyleType.getBioTypes()
def getAcceptedDataFormats( self ):
return self._mobyleType.getAcceptedFormats()
def forceReformating( self ):
return self._mobyleType.forceReformating()
def getDataFormat( self ):
return self._mobyleType.dataFormat
def setDataFormat( self , format ):
self._dataFormat = format
def ismaininput(self):
"""
@return: True if the parameter is mandatory, False otherwise.
@rtype: boolean
@call: called by L{Program.ismandatory}
"""
return self._ismaininput
def setMaininput(self, value):
"""
set if this parameter is mandatory or not
@param value: Boolean
"""
self._ismaininput = value
def ismandatory(self):
"""
@return: True if the parameter is mandatory, False otherwise.
@rtype: boolean
@call: called by L{Program.ismandatory}
"""
return self._ismandatory
def setMandatory(self, value):
"""
set if this parameter is mandatory or not
@param value: Boolean
"""
self._ismandatory = value
def ishidden(self ):
"""
@return: True if this parameter is hidden, False otherwise.
@rtype: boolean
@call: called by L{Program.ishidden}
"""
return self._ishidden
def setHidden(self, value):
"""
set if this parameter is appear in the web interface or not
@param value: Boolean
"""
self._ishidden = value
def getArgpos(self):
"""
"""
if self.iscommand() and not self._argpos :
return 0
else:
return super( Parameter , self ).getArgpos()
def iscommand(self ):
"""
@return: True if this parameter is the command, False otherwise.
@rtype: boolean
@call: called by L{Program.iscommand}
"""
return self._iscommand
def setCommand(self, value):
"""
@param value:
@type value:
"""
program = self.getProgram()
if program:
command = program.getCommand()[0]
if command:
msg = "try to set the parmeter \"%s\" as command but the program as already a command" % self.getName()
s_log.error( msg )
raise ServiceError , msg
commandParameterName = program.getCommandParameterName()
if commandParameterName:
msg = "try to set parameter \"%s\" as command but the parameter \"%s\" is already set as command" %( self.getName() ,
commandParameterName()
)
s_log.error( msg )
raise ServiceError , msg
self._iscommand = value
def issimple(self ):
"""
@return: True if this parameter is simple, False otherwise
@rtype: boolean
@call: called by L{Program.issimple}
"""
return self._issimple
def setSimple(self, simple):
"""
set if the parameter appear in the simple web interface or not
@param simple:
@type simple: Boolean
"""
self._issimple = simple
def isout(self ):
"""
@return: True if this parameter is produce by the program (an output), False otherwise.
@rtype: boolean
@call: called by L{Program.isout()}
"""
return self._isout or self._isstdout
def setOut( self , out ):
"""
defined if the parameter is an output of the program or not
@param out:
@type out: boolean
"""
self._isout = out
if out :
self._ishidden = True
def isstdout( self ):
"""
@return: True if this parameter is produce by the program (an output), False otherwise.
@rtype: boolean
@call: called by L{Program.isstdout()}
"""
return self._isstdout
def setStdout( self , stdout ):
"""
defined if the parameter is an output of the program or not
@param stdout:
@type stdout: boolean
"""
self._isstdout = stdout
self.setOut( stdout )
def isInfile(self ):
"""
@return True if parameter is an input file, False otherwise.
@rtype: boolean
@call: called by L{Program.isInfile()}
"""
dt = self.getDataType()
if dt.isFile():
return not self.isout()
else:
return False
def isMultiple(self ):
"""
@return: @return True if parameter is a Multiple File parameter, False otherwise.
@rtype: boolean
@call: called by L{Program.isInfile()}
"""
return self.getDataType().isMultiple()
def isOutfile(self ):
"""
be careful this method is overriden in the parameter which could be
Outfile ( TextParameter , BinaryParameter ,...)
@return: False
@rtype: boolean
@call: called by L{Program.isOutfile()}
"""
dt = self.getDataType()
if dt.isFile():
return self.isout()
else:
return False
def head( self , data ):
"""
param data:
type data:
return: return the head of the data
rtype:
"""
return self.getDataType().head( data )
def cleanData( self , data ):
"""
param data:
type data:
return: clean data prior to write it on disk
rtype:
"""
return self.getDataType().cleanData( data )
def getFormfield(self ):
"""
@return: the formfield of the parameter if it exist.
@rtype: string or None
"""
if self._formfield == "":
return None
else:
return self._formfield
def setFormfield(self , formfield):
"""
set the formfield of this parameter
@param formfield: the formfield
@type a String representing the formfield
"""
self._formfield = formfield
def getBioMoby(self ):
"""
@return: the BioMoby Class corresponding to this parameter
@rtype: string or None
"""
return self._mobyleType.getBioMoby()
def addElemInVlist (self, label, value):
"""
add the couple label,value in a vlist the labels are the keys to retrieve the values
@param label: the label
@type label: String
@param value: the value
@type value: String
@raise ValueError: a ValueError if the vlist has already a label label.
"""
if self.vlistHas_label( label ):
raise ValueError , "this label : %s already exist" %label
else:
if label:
label = str( label )
else:
label = ''
if value:
value = str( value )
else:
value = ''
self._vlist[ label ] = value
if not hasattr( self._mobyleType , '_vlist' ):
self._mobyleType._vlist = {}
self._mobyleType._vlist[ label ] = value
def delElemInVlist (self,label):
"""
retrieve the value associated to the label and delete the couple label, value
@param label: the label
@type label: String
@raise UnDefAttrError: a L{UnDefAttrError} if the parameter hasn't any vlist.
@raise ValueError: a ValueError if the vlist hasn't a label label.
"""
if not self._vlist:
raise UnDefAttrError, "no vlist for this Parameter"
try:
if not label:
label = ''
del self._vlist[label]
del self._mobyleType._vlist[ label ]
except KeyError:
raise ValueError, " no label %s in this vlist" %label
def getVlist(self ,label):
"""
@param label: a label in the vlist
@type label: String
@return: return the value associated to this label in the vlist
@rtype: string
@raise UnDefAttrError: if this parameter haven't vlist raise an L{UnDefAttrError}
@raise ValueError: if the label doesn't match with any labels in vlist raise a ValueError
@todo: revoir le type des erreurs levees
"""
if not self._vlist:
raise UnDefAttrError , "this parameter haven't vlist"
try:
return self._vlist[label]
except KeyError:
raise ValueError , " no label " + str(label)+" in this vlist"
def vlistLabels(self):
"""
@return: a list of labels in the vlist
@rtype: list of string
"""
return self._vlist.keys()
def hasVlist(self):
"""
@return: True if the parameter has a vlist, False otherwise.
@rtype: boolean
"""
if self._vlist :
return True
else :
return False
def vlistHas_label (self,label):
"""
@param label: the label to search in vlist
@type label: String
@return: True if label match with a label in vlist, false otherwise.
@rtype: boolean
"""
return self._vlist.has_key( label )
def getVlistValues(self):
"""
@return: a list of all values (not converted) in vlist.
@rtype: list of string
@call: by L{ChoiceParameter} and L{MultipleChoiceParameter}.validate
"""
return self._vlist.values()
def addElemInFlist(self , value , label , codes):
"""
@param value:
@type value: string
@param label:
@type label: string
@param codes:
@type codes: dictionary
"""
#print "parameter :" , self.getName()
#print "addElemInFlist value =", value ," label = ", label ," codes = ",codes
self._flist[ value ] = ( label , codes )
if not hasattr( self._mobyleType , '_flist' ):
self._mobyleType._flist ={}
else:
self._mobyleType._flist[ label ] = value
def getFlistValues(self):
"""
@return: the keys of a flist.
@rtype: list of strings
@call: by L{Program}.flistValues
"""
return self._flist.keys()
def flistHas_value(self, value):
"""
@param value: the value associated to the codes
@type value: any
@return: True if the flist has a value == value, False otherwise.
@rtype: boolean
@raise UnDefAttrError: if the parameter hasn't flist a L{UnDefAttrError}
is raised
( called by Parameter.flistProglangs )
"""
return self._flist.has_key(value)
def flistLabels(self):
"""
@return: a list of labels in the flist
@rtype: list of string
"""
return self._flist.keys()
def flistProglangs(self, value = None):
"""
@param value: the value associated to the codes
@type value: any
@return: the list of proglang available for a given value.
@raise UnDefAttrError: if the parameter hasn't flist a L{UnDefAttrError} is raised
"""
proglangs = []
if value is None :
values = self._flist.keys()
else:
if self._flist.flistHas_value( value ):
values = [ value ]
else:
raise MobyleError , "this parameter has no value:" +str( value )+" in it's flist"
for value in values :
newValues = self._flist[ value ][1].keys()
for newValue in newValues:
if newValue not in proglangs:
proglangs.append( newValue )
return proglangs
def flistHas_proglang(self,value,proglang):
"""
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: Boolean, True if the flist has the value and a code written in proglang associated with, False otherwise.
@rtype: boolean
"""
if self.flistHas_value(value):
return self._flist[value][1].has_key( proglang )
else:
return False
#raise ValueError, self.getName()+" : the value " + str(value) + " doesn't exist for this flist"
def getFlistCode(self , value , proglang):
"""
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: the code associated with the value and written in proglang.
@rtype: string
@raise ParamaterError: if there isn't this value or this proglang an L{ParamaterError} is raised
"""
try:
return self._flist[value][1][proglang]
except KeyError:
raise ParameterError, "%s : the proglang %s is not defined for the flist " %( self.getName(),
proglang
)
def hasFlist(self):
"""
@return: True if the Parameter has a flist, False otherwise.
@rtype: boolean
"""
if self._flist:
return True
else:
return False
def getListUndefValue( self ):
"""
@return:
@rtype: string
"""
return self._undefValue
def setListUndefValue(self , value ):
"""
@param value:
@type value: string
"""
self._undefValue = value
self._mobyleType._undefValue = value
def has_ctrl(self):
"""
@return: True if the parameter has L{Ctrl}, False otherwise.
@rtype:boolean
"""
if self._ctrls:
return True
else :
return False
def getCtrls(self):
"""
@return: the list of Ctrl instances.
@rtype: list of Ctrl objects.
@raise UnDefAttrError: if the parameter haven't a Ctrl, raise an L{UnDefAttrError}
"""
if self._ctrls:
return self._ctrls
else:
raise UnDefAttrError,"no ctrl for this parameter"
def addCtrl(self, ctrl):
"""
@param ctrl: is a tuple made with a list of messages and a list of codes
@type ctrl: ([(String content , String proglang , String lang , Boolean href)],[(String proglang, String code)])
"""
myCtrl = Ctrl()
for message in ctrl[0]:
if ( (message[1] and message[2]) or (message[1] and message[3]) or (message[2] and message[3]) ):
raise ServiceError
if message[1]:
myCtrl.addMessage(message[0] ,proglang =message[1] )
elif message[2]:
myCtrl.addMessage(message[0] ,lang = message[2])
elif message[3]:
myCtrl.addMessage(message[0] ,href = message[3] )
for code in ctrl[1]:
myCtrl.addCode(code[0] , code[1])
self._ctrls.append( myCtrl )
def hasParamfile(self):
"""
@return: True if the parameter should be specified in a file instead
the command line, False otehwise
@rtype: boolean
"""
if self._paramfile:
return True
else:
return False
def getParamfile(self):
"""
@return: the name of the file parameter when they must be specipfied
in a file instead on command line.
@rtype: string.
@raise UnDefAttrError: if the parameter haven't a paramfile an L{UnDefAttrError} is raised.
"""
if self._paramfile:
return self._paramfile
else:
raise UnDefAttrError,"no paramfile for this parameter"
def setParamfile(self, fileName):
"""
set the paramfile
@param fileName: the name of the paramfile
@type fileName: String
"""
#on pourrait des maintenant eliminer les espaces du nom de fichier
fileName.replace(' ','')
self._paramfile = fileName
def getFilenames(self, proglang = 'python' ):
"""
@param proglang: the programming language used to defined the filenames
@type proglang: string
@return: the UNIX MASK which permit to retrieve the results files.
@rtype: a list of string
@raise UnDefAttrError: if the parameter haven't a filenames , raise an L{UnDefAttrError}
@call: L{Program.getFileNames}( parameterName )
@todo: si ca doit etre evaluer alors il faut considerer ca come du code car la syntaxe va etre differente en perl ,et en python donc je propose de modifier la dtd <!ELEMENT filenames (code)+> et en python maVariable+".*.aln" chaque mask etant separer par un espace
"""
if not self.isout():
raise MobyleError, self.getName() + " : only out parameter could have filenames"
if self._filenames:
try:
filenames= self._filenames[ proglang ]
except KeyError:
program = self.getProgram()
if program:
programName = program.getName()
else:
programName = "without_program"
s_log.warning( "%s.%s have filenames in %s proglangs but not in python" %( programName , self.getName() , self._filenames.keys() ) )
return []
#each mask could contain a variable, thus they must be evaluated in evaluator
result = []
for mask in filenames:
try:
evaluatedMask = self.getEvaluator().eval( mask )
if evaluatedMask is None:
# a mask could be a variable therefore it could be None !!
continue
result.append( evaluatedMask )
except Exception ,err :
raise MobyleError, "error in filenames code evaluation ( " + mask + " ) : " + str( err )
return result
else:
raise UnDefAttrError,"no filenames for this parameter"
def setFilenames(self , fileNames , proglang = 'python' ):
"""
@param fileNames: a unix mask to retrieve the results files (ex: *.aln,*.dnd,...)
@type fileNames: String
@param proglang: the programming language used to defined the filenames
@type proglang: string
"""
if self._filenames.has_key( proglang ):
self._filenames[ proglang ].append( fileNames)
else:
self._filenames[proglang] = [ fileNames ]
def hasScale( self , proglang = 'python' ):
"""
@retrun: True if the param has a scale with code in proglang or with value, False otherwise.
@rtype: boolean
"""
try:
_ = self._scalemin[ proglang ]
except KeyError:
try:
_ = self._scalemin['value']
except KeyError:
return False
try:
_ = self._scalemin[ proglang ]
except KeyError:
try:
_ = self._scalemin[ 'value' ]
except KeyError:
return False
return True
def isInScale( self , proglang = 'python' ):
"""
@return: True if the value is in range(min, max), false otherwise
@rtype: boolean
"""
evaluator = self.getEvaluator()
try:
smin = self._scalemin[ proglang ]
except KeyError:
try:
smin = self._scalemin[ 'value' ]
except KeyError:
raise MobyleError, "no value nor code in %s for this scale min" % proglang
try:
smin = evaluator.eval( smin )
except Exception , err :
s_log.error( "error during scale min evaluation : %s. Check %s.%s definition" %( err ,
self.getProgram().getName() ,
self.getName()))
raise MobyleError( "Internal Server Error" )
try:
smax = self._scalemax[ proglang ]
except KeyError:
try:
smax = self._scalemax[ 'value' ]
except KeyError:
raise MobyleError ,"no value nor code in %s for this scale max" % proglang
try:
smax = evaluator.eval( smax )
except Exception , err :
s_log.error( "error during scale max evaluation : %s. Check %s.%s definition" %( err,
self.getProgram().getName() ,
self.getName()))
raise MobyleError( "Internal Server Error" )
value = self.getValue()
if value is not None:
if value >= smin and value <= smax :
return True
else:
return False
else:
raise ValueError , "undefined value"
def getScale(self , proglang = 'python' ):
"""
@param proglang: the programming language
@type proglang: String
@return: a tuple ( min , max , inc )
- min
- max
- incr is a value
@rtype: tuple ( , , )
@raise
"""
try:
smin = self._scalemin[ proglang ]
evaluator = self.getEvaluator()
min = evaluator.eval( smin )
except KeyError:
try:
smin = self._scalemin[ 'value' ]
except KeyError:
raise MobyleError , "no value nor code in %s for this scale min" % proglang
try:
smax = self._scalemin[ proglang ]
evaluator = self.getEvaluator()
smax = evaluator.eval( smax )
except KeyError:
try:
smax = self._scalemax[ 'value' ]
except KeyError:
raise MobyleError , "no value nor code in %s for this scale max" % proglang
return ( smin , smax , self._scaleinc )
def setScale(self, min , max , inc = None , proglang = None):
"""
@param min: specify the minimum of the scale
@type min: could either a value or String representing a code
@param max: specify the maximum of the scale
@type max: could either a value or String representing a code
@param inc: specify the incrementation of the scale
@type inc: a number
@parameter proglang: if min, max are code, proglang should be specified and it's the programming language.
@type proglang: a String
@todo: faire des tests sur inc le convertir?
"""
if proglang:
self._scalemin[ proglang ] = min
self._scalemax[ proglang ] = max
else:
self._scalemin[ 'value' ] = min
self._scalemax[ 'value' ] = max
if inc:
self._scaleinc= inc
def getSeparator( self ):
"""
@return: a character used to split the values of a MultipleChoice,( default value : '')
@rtype: string
"""
return self._separator
def setSeparator( self , separator ):
"""
@param separator: a character used to split the values of a MultipleChoice
@type separator: String
"""
self._separator = separator
def getWidth( self ):
"""
@return: an Integer, representing the width of the widget.
@rtype: number
@raise UnDefAttrError: if the parameter haven't a width , raise an L{UnDefAttrError}
"""
if self._width:
return self._width
else:
raise UnDefAttrError,"no width for this parameter"
def setWidth( self , width ):
"""
@param width: the width of the widget in pixels,en pourcentage ???
@type width: number int float
"""
try:
width + 3
self._width = width
except TypeError:
raise ServiceError , "width must be a number"
def getHeight(self ):
"""
@return: return the height of the widget in pixels, en pourcentage????
@rtype: number
@raise UnDefAttrError: if the parameter haven't a height , raise an L{UnDefAttrError}
"""
if self._height:
return self._height
else:
raise UnDefAttrError,"no height for this parameter"
def setHeight(self, height):
"""
@param height: the height of the widget in pixels,en pourcentage ???
@type:number int float??
"""
try:
height + 3
self._height = height
except TypeError:
raise ValueError, "height must be a number"
def setExemple(self, value):
"""
set an exemple value
@param value: a typical value for this parameter
@type value: string
"""
self._exemple = value
def getExemple(self ):
"""
@return: a typical value for this parameter.
@rtype: string
@raise UnDefAttrError: if the parameter haven't an exemple value, raise an L{UnDefAttrError}
"""
if self._exemple:
return self._exemple
else:
raise UnDefAttrError,"no exemple for this parameter"
def doCtrls(self):
"""
do the controls specific to this parameter
@raise L{UserValueError}: if a control failed a L{UserValueError} is raised, otherwise return True
@todo: gerer les message de type href, discuter du proto de la fonction doit retourner False ou lever une erreur??
@todo: gerer la langue dans la fonction d'erreur
"""
if self.has_ctrl():
evaluator = self.getEvaluator()
myName = self.getName()
for ctrl in self.getCtrls():
if ctrl.has_proglang( 'python' ):
rawVdef = self.getVdef()
if rawVdef is None:
evaluator.setVar( 'vdef' , None )
convertedVdef = None
else:
convertedVdef , mt = self.convert( rawVdef , self.getType() )
evaluator.setVar( 'vdef' , convertedVdef )
if evaluator.getVar( myName ) is not None:
value = evaluator.getVar( myName )
evaluator.setVar( 'value' , value )
else:
value = convertedVdef
evaluator.setVar( 'value' , convertedVdef )
try:
code = ctrl.getCode( proglang= 'python' )
eval_result = evaluator.eval( code )
if self.getDebug() > 1 :
b_log.debug( "convertedVdef = " + str(convertedVdef) + " value = " + str( value) )
b_log.debug( "eval( " + code + " ) = " + str( eval_result ) )
except Exception ,err:
msg = self.getName() + ": error during evaluation of \"" + code +"\" : " + str( err )
s_log.error( msg )
raise ServiceError , msg
if eval_result :
continue
else:
messType = ctrl.whatIsIt()
LANG = _cfg.lang()
if messType == 'text':
if ctrl.messageHas_lang( LANG ):
msg = myName +" : "+ ctrl.getMessage( LANG )
else:
if ctrl.messageLangs():
msg = myName +" :"+ ctrl.getMessage( ctrl.messageLangs()[0] )
else:
msg = "this value"+ str(self.getValue())+" is not allowed for parameter named " + myName
elif messType == 'code':
if ctrl.messageHas_proglang('python'):
msg= myName + " : " + evaluator.eval( ctrl.getMessage( proglang='python' ) )
else:
msg = "this value" + str( self.getValue() ) + " is not allowed for parameter named " + myName
elif messType == 'href':
#### TODO ####
raise NotImplementedError, "href are not implemented in message Ctrls : todo"
else:
msg = "this value" + str( self.getValue() ) + " is not allowed for parameter named " + myName
#s_log.error( self.getName() + " xml ctrl failed : " + msg )
raise UserValueError( parameter = self, msg = msg )
else:
if self.getDebug() > 1:
if ctrl.has_proglang( 'perl' ):
b_log.debug( "############## WARNING #####################" )
b_log.debug( "had a control code in Perl but not in Python" )
b_log.debug( "############################################" )
return True
def _isNumber(self, value):
"""
test if the value is a number.
@param value: any value to test
@type value: any
@return: True if value is a number, False othewise
@rtype: boolean
"""
try:
value + 3
return True
except TypeError:
return False
########################
# #
# class text #
# #
########################
class Text(object):
"""
is used to handle a (text)+ in the mobyle dtd.
a text in dtd could be either a
- text
- code
- or a href
and have the attributes
- lang associated with the text
- proglang associated with code
- href for href
"""
def __init__(self):
self._lang = {}
self._code = {}
self._href = []
def has_lang(self, lang ):
"""
@param lang: the language in which the text is written
@type lang: a String should be conformed to the iso630-1 code
(ex 'en', 'fr').
@return: True if this Text have a code in this programming language,
False otherwise
@rtype: boolean
"""
if self._lang:
return self._lang.has_key( lang )
else:
return False
def langs(self):
"""
@return: the languages of this Text.
@rtype: list of strings
"""
return self._lang.keys()
def addText(self, text, lang ='en'):
"""
Set a text for this Text
@param text: the text
@type text: String
@param lang: the language in which the text is written
@type lang: a String should be conformed tothe iso630-1 code
(ex 'en', 'fr')
"""
self._lang[ lang ] = text
def getText(self, lang='en'):
"""
get the text associatde with the lang for this Text
@param lang: the language of the text
@type lang:the language in which the text is written
@type lang: a String should be conformed tothe iso630-1 code
(ex 'en', 'fr')
@return: the text
@rtype: string
@raise MobyleError: a{MobyleError} is raised if the text has no lang = 'lang'
"""
try:
return self._lang[lang]
except KeyError:
raise MobyleError, "no lang = "+str(lang)+" in this Text"
def has_proglang(self, proglang):
"""
@param proglang: the programming language ('python', 'perl' ...)
@type proglang: string
@return: True if this Text have a code int his programming language,
False otherwise.
@rtype: boolean
"""
return proglang in self._code
def proglangs(self):
"""
@return: a list of string encoding the programming languages of this Text
@rtype: list of strings
"""
return self._code.keys()
def addCode(self, code, proglang='python'):
"""
Set a code for this Text
@param code: the code
@type code: String
@param proglang: the programming language of the text
@type proglang: String
"""
self._code[ proglang ]= code
def getCode(self,proglang = 'python'):
"""
Get the code associated with the lang for this Text
@param proglang: the programming language of the code
@type proglang:the programming language in which the code is written ('perl, 'python')
@type proglang: a String
@return: the code
@rtype: string
@raise MobyleError: a L{MobyleError} is raised if there isn't any code written in proglang
"""
try:
return self._code[ proglang ]
except KeyError:
raise MobyleError, "no proglang = "+ str( proglang )+ " in this Text"
def has_code(self , proglang = 'python'):
if proglang in self._code:
return bool( self._code[ proglang ] )
else:
return False
def has_href(self):
"""
@return: True if the Text has a href, False otherwise.
@rtype: boolean
"""
if self._href:
return True
else:
return False
def hrefs(self):
"""
@return: a list of string encoding the href.
@rtype: list of string
"""
return self._href
def addHref(self, href):
"""
set a href for this Text
@param href: the href it could be a String or a set (liste or tuple) of Strings
@type href: String
"""
if type(href) == type([]) or type(href) == type( () ):
self._href += href
else:
self._href.append(href)
def whatIsIt(self):
"""
@return: 'text', 'code' if 'href' the Text is a text a code or a href or None if text is empty.
@rtype: string
@call: by L{Parameter.doCtrls() <Parameter>}
"""
if self._lang:
return 'text'
elif self._code:
return 'code'
elif self._href:
return 'href'
else:
return None
def __str__(self):
return str(self._lang ) + str(self._code) + str (self._href)
######################
# #
# class Ctrl #
# #
######################
class Ctrl(object):
"""
is used to handle a ctrl in the mobyle dtd.
a ctrl is a message associated with one or more code
"""
def __init__(self):
self._code = {}
self._message = Text()
def getMessage(self, lang = None, proglang= None, href= False):
"""
@param lang: is the symbol of a lang in iso639-1 (ex: 'en', 'fr') for the text or 'href' for the link
@type lang: String
@param proglang: the programming language
@type proglang: String
@param href: if the message is a link toward an external page
@type href: Boolean
@return: The message corresponding to the specified lang or proglang or href
@rtype: string
@raise MobyleError: if more than one parameter is specified a L{MobyleError} is raised
"""
if ( (proglang and lang) or (proglang and href) or (lang and href) ):
raise MobyleError, "invalid argument for getMessage"
if proglang:
return self._message.getCode( proglang)
elif lang:
return self._message.getText( lang)
elif href:
return self._message.hrefs( )
else :
raise MobyleError, "invalid argument for message : "+str(lang)+" , "+str(proglang)+" , "+str(href)
def getCode(self,proglang = 'python'):
"""
@param proglang: the programming language
@type proglang: String
@return: The code
@rtype: string
@raise MobyleError: if there is no code written in proglang raise L{MobyleError}
"""
try:
return self._code[proglang]
except KeyError:
raise MobyleError, "no code in "+str(proglang)+" for this control"
def proglangs(self):
"""
@return: the list of programming langage of the code associated to this Ctrl.
@rtype: list of string
"""
return self._code.keys()
def has_proglang(self, proglang = 'python'):
"""
@param proglang: the programming language
@type proglang: String
@return: True if False otherwise.
@rtype: boolean
"""
return self._code.has_key(proglang)
def messageHas_lang(self, lang = 'en'):
"""
@param lang: the language of the text, according to the iso639-1
@type lang: String
@return: True if lang is used to encode the message, False otherwise
@rtype: boolean
"""
return self._message.has_lang( lang )
def messageLangs(self):
"""
@return: the list of the langs used to encode the message
@rtype: list of string
"""
return self._message.langs()
def messageHas_proglang(self, proglang = 'python'):
"""
@param proglang:
@type proglang: String
@return: True if the proglang is used to encode the message, False otherwise
@rtype: boolean
"""
return self._message.has_proglang(proglang)
def messageProglangs(self):
"""
@return: the list of the programming languages to encoding the message
@rtype: list of string
"""
return self._message.proglangs()
def messageHrefs(self):
"""
@return: the list of href
@rtype: list of strings
"""
return self._message.hrefs()
def addMessage(self, content ,lang = None, proglang= None, href= False):
"""
@param content: it must be a text if lang is specified, a code if proglang is specified or a href if href is true
@type content: String
@param lang: the language if the content is a text (2 letters code)
@type lang: String
@param proglang: the programming language if the content is a code
@type proglang: String
@param href: true if the content is a href
@type href: Boolean
"""
if ( (lang and proglang) or (lang and href) or (proglang and href) ):
raise MobyleError
else:
if lang:
self._message.addText(content,lang= lang)
elif proglang:
self._message.addCode(content, proglang= proglang)
elif href:
self._message.addHref(content)
def whatIsIt(self):
"""
@return: 'text', 'code' or 'href' if the message is a text a
code or a href or None if the message is empty.
@rtype: string
"""
return self._message.whatIsIt()
def addCode(self, code ,proglang ):
"""
@param proglang:
@type proglang: String
@param code:
@type code: String
"""
self._code[ proglang ] = code
class flist(object):
def __init__( self ):
self._flist = {}
def addElemInFlist(self , value , label , codes):
"""
@param value:
@type value: string
@param label:
@type label: string
@param codes:
@type codes: dictionary
"""
self._flist[ value ] = ( label , codes )
def flistValues(self):
"""
@return: the keys of a flist.
@rtype: list of strings
@call: by L{Program}.flistValues
"""
return self._flist.keys()
def flistHas_value(self, value):
"""
@param value: the value associated to the codes
@type value: any
@return: True if the flist has a value == value, False otherwise.
@rtype: boolean
@raise UnDefAttrError: if the parameter hasn't flist a L{UnDefAttrError}
is raised
( called by Parameter.flistProglangs )
"""
return self._flist.has_key(value)
def flistProglangs(self, value):
"""
@param value: the value associated to the codes
@type value: any
@return: the list of proglang available for a given value.
@raise UnDefAttrError: if the parameter hasn't flist a L{UnDefAttrError} is raised
"""
proglangs = []
for value in self._flist.keys():
newValues = self._flist[ value ][1].keys()
for newValue in newValues:
if newValue not in proglangs:
proglangs.append( newValue )
return proglangs
def flistHas_proglang(self,value,proglang):
"""
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: Boolean, True if the flist has the value and a code written in proglang associated with, False otherwise.
@rtype: boolean
"""
if self.flistHas_value(value):
return self._flist[value][1].has_key( proglang )
else:
return False
def getFlistCode(self , value , proglang):
"""
@param value: the value associated to the codes
@type value: any
@param proglang: the programming language of the code
@type proglang: String
@return: the code associated with the value and written in proglang.
@rtype: string
@raise ParamaterError: if there isn't this value or this proglang an L{ParamaterError} is raised
"""
try:
return self._flist[value][1][proglang]
except KeyError:
raise ParameterError, "the proglang %s is not defined for the flist " % proglang
class MobyleType(object):
def __init__( self , dataType ,
bioTypes = [] ,
dataFormat = None ,
item_nb = None ,
format_program = None ,
acceptedFormats = [] ,
card = ( 1 , 1 ) ,
biomoby = None):
"""
@param bioType: ADN Protein
@type bioType: a list of strings
@param dataType: Sequence , Structure , ...
@type dataType: a DataType instance
@param format: the real format of the data
@type format: string
@param acceptedFormats: the format that are allowed for this data and forceformat.
forceformat implied the reformatting of the data either the format match one acceptedFormats.
@type acceptedFormats: [ ( string format , boolean force ) , ... ]
@param card: min max. min and max could be an integer or n
@type card: ( int , int ) or (int , string n)
"""
if type( bioTypes ) == types.StringType:
self.bioTypes = [ bioTypes ]
else:
self.bioTypes = bioTypes
self.dataType = dataType
if dataFormat is not None and acceptedFormats:
raise MobyleError( "you cannot set acceptedFormat and format for the same MobyleType object" )
self.acceptedFormats = acceptedFormats
self.dataFormat = dataFormat
self.item_nb = item_nb
self.format_program = format_program
if len( card ) != 2:
raise MobyleError( "the cardinality must be a tuple ( min , max )" )
self.card = card
self.biomoby = biomoby
def __str__(self):
s = 'dataType : '+str( self.dataType )
for attr in ( 'bioTypes' , 'dataFormat' , 'item_nb' , 'format_program' ,
'acceptedFormats' , 'card' ,'biomoby' ):
s =" %s , %s : %s " %( s , attr , getattr( self , attr ) )
return s
def __eq__(self , other ):
if isinstance( self, other.__class__ ):
other_acceptedFormats = [ f for f in other.acceptedFormats ]
other_acceptedFormats.sort()
self_acceptedFormats = [ f for f in self.acceptedFormats ]
self_acceptedFormats.sort()
if other.bioTypes == self.bioTypes \
and other.dataType == self.dataType \
and other_acceptedFormats == self_acceptedFormats \
and other.dataFormat == self.dataFormat \
and other.card == self.card \
and other.biomoby == self.biomoby:
return True
return False
def clone(self , dt ):
newMT = MobyleType( dt )
for attr in self.__dict__.keys() :
if attr not in [ "__builtins__" , "dataType" ]:
setattr(newMT , attr , copy.deepcopy( getattr( self , attr ) ) )
return newMT
def toDom( self ):
from lxml import etree
typeNode = etree.Element( "type" )
if self.bioTypes :
for biotype in self.bioTypes :
bioTypeNode = etree.Element( "biotype" )
bioTypeNode.text = biotype
typeNode.append( bioTypeNode )
dataTypeNode = self.dataType.toDom()
typeNode.append( dataTypeNode )
if self.acceptedFormats:
for format , force in self.acceptedFormats :
if force:
formatNode = etree.Element( "dataFormat" , force = "1")
else:
formatNode = etree.Element( "dataFormat" )
formatNode.text = format
typeNode.append( formatNode )
elif self.dataFormat:
formatNode = etree.Element( "dataFormat" )
formatNode.text = self.dataFormat
typeNode.append( formatNode )
#ajouter le format_program et item_nb ?
if self.card != ( 1 , 1 ):
min , max = self.card
cardText= "%s,%s"%( min , max )
cardNode = etree.Element( "card" )
cardNode.text = cardText
typeNode.append( cardNode )
elif self.item_nb :
cardNode = etree.Element( "card" )
cardNode.text = str( self.item_nb )
typeNode.append( cardNode )
if self.biomoby:
biomobyNode = etree.Element( "biomoby" )
biomobyNode.text = str( self.biomoby )
typeNode.append( biomobyNode )
return typeNode
def getBioTypes( self ):
return self.bioTypes
def getDataType( self ):
return self.dataType
def convert(self , value , acceptedMobyleType , paramFile= False, separator = None ):
"""
convert the sequence contain in the file fileName in the rigth format
throws an UnsupportedFormatError if the output format is not supported
or a MobyleError if something goes wrong during the conversion.
@param value: is a tuple ( src , srcFileName)
- srcfilename is the name of the file to convert in the src
- src must be a L{Job} instance the conversion are perform only by jobs (not session) .
@type value: ( L{Job} instance dest, L{Job} instance, src)
@return: the fileName ( basename ) of the sequence file and the effective MobyleType associated to this
value
@rtype: ( string fileName , MobyleType instance )
@raise UnSupportedFormatError: if the data cannot be converted in any suitable format
"""
if separator is not None:
outFileName , converted_mt = self.dataType.convert(value , acceptedMobyleType , detectedMobyleType = self , paramFile = paramFile, separator= separator)
else:
outFileName , converted_mt = self.dataType.convert(value , acceptedMobyleType , detectedMobyleType = self , paramFile = paramFile)
if self.bioTypes and converted_mt:
converted_mt.bioTypes = [ b for b in self.bioTypes ]
return outFileName , converted_mt
def detect( self , value ):
"""
detects the format of the sequence(s) contained in fileName
@param value: the src object and the filename in the src of the data to detect
@type value: tuple ( session/Job/MobyleJob instance , string filename )
@return: a tuple of the detection run information:
- the detected format,
- the detected items number,
- program name used for the detection.
"""
detected_mt = self.dataType.detect( value )
if self.bioTypes :
detected_mt.bioTypes = [ b for b in self.bioTypes ]
if self.dataFormat and not detected_mt.dataFormat: #I trust the format provided by Job ...
detected_mt.dataFormat = self.dataFormat
return detected_mt
def getAcceptedFormats( self ):
return self.acceptedFormats
def setAcceptedFormats( self , acceptedDataFormats ):
if self.dataFormat:
raise MobyleError("you cannot set acceptedFormat and format for the same MobyleType object" )
self.acceptedFormats = acceptedDataFormats
def getDataFormat( self ):
return self.dataFormat
def setDataFormat(self , format):
if self.acceptedFormats:
raise MobyleError("you cannot set acceptedFormat and format for the same MobyleType object" )
self.dataFormat = format
def getItemNumber( self ):
return self.item_nb
def setItemNumber( self , nb ):
self.item_nb = nb
def getFormatProgram( self ):
return self.format_program
def getCard( self ):
return self.card
def getBioMoby( self ):
return self.biomoby
def isPipeableTo( self , inputMT ):
"""
@param inputMT: The "target" input parameter type
@type inputMT: MobyleType
@return: True if the data that have this type can be piped to a program input with a MobyleType defined as inputMT
@rtype: boolean
"""
if self._isBioTypePipeable( inputMT.getBioTypes() ) and self.dataType.isPipableToDataType( inputMT.getDataType() ) and self._isCardPipeable( inputMT.getCard() ):
return True
else:
return False
def _isBioTypePipeable(self , inputBioTypes ):
"""
@param inputBioTypes: The "target" input parameter biotype
@type inputBioTypes: List
@return: True if the data that have this biotype can be piped to a program input with a biotype defined as inputBioTypes
@rtype: boolean
"""
for bioType in inputBioTypes:
if bioType in self.bioTypes:
return True
return False
def _isCardPipeable( self , inputCard ):
"""
@param inputCard: The "target" input parameter cardinality
@type inputCard: tuple
@return: True if the data that have this cardinality can be piped to a program input with a cardinality defined as inputCard
@rtype: boolean
"""
inputMin , inputMax = inputCard
if inputMax == 'n':
return True
else:
if type( self.card[1] ) == types.IntType and inputMax < self.card[1]:
return True
return False
def isFile(self):
"""
@return: True if the datatype corespond to a file , false otherwise
@rtype: boolean
"""
return self.dataType.isFile()
def isMultiple(self):
"""
@return: True if the datatype corespond to a Multiple input , false otherwise
@rtype: boolean
"""
return self.dataType.isMultiple()
def toFile(self , data , dest , destFileName , src , srcFileName ):
if self.dataType.isFile():
return self.dataType.toFile( data , dest , destFileName , src , srcFileName )
else:
raise MobyleError( "this data is not a file" )
|