-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3349 from hjoliver/ref-graph-no-gtk
Cylc 7 ref graphs without pygtk
- Loading branch information
Showing
7 changed files
with
291 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| #!/usr/bin/env python2 | ||
| # | ||
| # THIS FILE IS PART OF THE CYLC SUITE ENGINE. | ||
| # Copyright (C) 2008-2019 NIWA & British Crown (Met Office) & Contributors. | ||
| # | ||
| # This program is free software: you can redistribute it and/or modify | ||
| # it under the terms of the GNU General Public License as published by | ||
| # the Free Software Foundation, either version 3 of the License, or | ||
| # (at your option) any later version. | ||
| # | ||
| # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| # GNU General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU General Public License | ||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| """Usage: | ||
| cylc ref-graph SUITE [START] [STOP] | ||
| Implement the old ``cylc graph --reference command`` for producing a | ||
| text-format representation of a suite graph. | ||
| The `--reference` flag is optional here. | ||
| THIS IS A BACK-PORT OF the Python 3 bin/cylc-graph FOR CYLC 8, TO GENERATE | ||
| TEXT-FORMAT "REFERENCE GRAPHS" WITHOUT THE NEED FOR PYGTK TO BE INSTALLED.""" | ||
|
|
||
| from cylc.config import SuiteConfig | ||
| from cylc.cycling.loader import get_point | ||
| from cylc.option_parsers import CylcOptionParser as COP | ||
| from cylc.suite_srv_files_mgr import ( | ||
| SuiteSrvFilesManager, SuiteServiceFileError) | ||
| from cylc.templatevars import load_template_vars | ||
|
|
||
|
|
||
| def sort_integer_node(item): | ||
| """Return sort tokens for nodes with cyclepoints in integer format. | ||
| Example: | ||
| >>> sort_integer_node('foo.11') | ||
| ('foo', 11) | ||
| """ | ||
| name, point = item.split('.') | ||
| return (name, int(point)) | ||
|
|
||
|
|
||
| def sort_integer_edge(item): | ||
| """Return sort tokens for edges with cyclepoints in integer format. | ||
| Example: | ||
| >>> sort_integer_edge(('foo.11', 'foo.12', None)) | ||
| (('foo', 11), ('foo', 12)) | ||
| >>> sort_integer_edge(('foo.11', None , None)) | ||
| (('foo', 11), ('', 0)) | ||
| """ | ||
|
|
||
| return ( | ||
| sort_integer_node(item[0]), | ||
| sort_integer_node(item[1]) if item[1] else ('', 0) | ||
| ) | ||
|
|
||
|
|
||
| def sort_datetime_edge(item): | ||
| """Return sort tokens for edges with cyclepoints in ISO8601 format. | ||
| Example: | ||
| >>> sort_datetime_edge(('a', None, None)) | ||
| ('a', '') | ||
| """ | ||
| return (item[0], item[1] or '') | ||
|
|
||
|
|
||
| def get_cycling_bounds(config, start_point=None, stop_point=None): | ||
| """Determine the start and stop points for graphing a suite.""" | ||
| # default start and stop points to values in the visualization section | ||
| if not start_point: | ||
| start_point = config.cfg['visualization']['initial cycle point'] | ||
| if not stop_point: | ||
| viz_stop_point = config.cfg['visualization']['final cycle point'] | ||
| if viz_stop_point: | ||
| stop_point = viz_stop_point | ||
|
|
||
| # don't allow stop_point before start_point | ||
| if stop_point is not None: | ||
| if get_point(stop_point) < get_point(start_point): | ||
| # NOTE: we need to cast with get_point for this comparison due to | ||
| # ISO8061 extended datetime formats | ||
| stop_point = start_point | ||
|
|
||
| return start_point, stop_point | ||
|
|
||
|
|
||
| def graph_workflow(config, start_point=None, stop_point=None, ungrouped=False, | ||
| show_suicide=False): | ||
| """Implement ``cylc-graph --reference``.""" | ||
| # set sort keys based on cycling mode | ||
| if config.cfg['scheduling']['cycling mode'] == 'integer': | ||
| # integer sorting | ||
| node_sort = sort_integer_node | ||
| edge_sort = sort_integer_edge | ||
| else: | ||
| # datetime sorting | ||
| node_sort = None # lexicographically sortable | ||
| edge_sort = sort_datetime_edge | ||
|
|
||
| # get graph | ||
| start_point, stop_point = get_cycling_bounds( | ||
| config, start_point, stop_point) | ||
| graph = config.get_graph_raw( | ||
| start_point, stop_point, ungroup_all=ungrouped) | ||
| if not graph: | ||
| return | ||
|
|
||
| edges = ( | ||
| (left, right) | ||
| for left, right, _, suicide, _ in graph | ||
| if right | ||
| if show_suicide or not suicide | ||
| ) | ||
| for left, right in sorted(set(edges), key=edge_sort): | ||
| print('edge "%s" "%s"' % (left, right)) | ||
|
|
||
| print('graph') | ||
|
|
||
| # print nodes | ||
| nodes = ( | ||
| node | ||
| for left, right, _, suicide, _ in graph | ||
| for node in (left, right) | ||
| if node | ||
| if show_suicide or not suicide | ||
| ) | ||
| for node in sorted(set(nodes), key=node_sort): | ||
| print('node "%s" "%s"' % (node, node.replace('.', r'\n'))) | ||
|
|
||
| print('stop') | ||
|
|
||
|
|
||
| def graph_inheritance(config): | ||
| """Implement ``cylc-graph --reference --namespaces``.""" | ||
| edges = set() | ||
| nodes = set() | ||
| for namespace, tasks in config.get_parent_lists().items(): | ||
| for task in tasks: | ||
| edges.add((task, namespace)) | ||
| nodes.add(task) | ||
|
|
||
| for namespace in config.get_parent_lists(): | ||
| nodes.add(namespace) | ||
|
|
||
| for edge in sorted(edges): | ||
| print('edge %s %s' % edge) | ||
|
|
||
| print('graph') | ||
|
|
||
| for node in sorted(nodes): | ||
| print('node %s %s' % (node, node)) | ||
|
|
||
| print('stop') | ||
|
|
||
|
|
||
| def get_config(suite, opts, template_vars=None): | ||
| """Return a SuiteConfig object for the provided reg / path.""" | ||
| try: | ||
| suiterc = SuiteSrvFilesManager().get_suite_rc(suite) | ||
| except SuiteServiceFileError: | ||
| # could not find suite, assume we have been given a path instead | ||
| suiterc = suite | ||
| suite = 'test' | ||
| return SuiteConfig(suite, suiterc, opts, template_vars=template_vars) | ||
|
|
||
|
|
||
| def get_option_parser(): | ||
| """CLI.""" | ||
| parser = COP( | ||
| __doc__, jset=True, prep=True, | ||
| argdoc=[ | ||
| ('[SUITE]', 'Suite name or path'), | ||
| ('[START]', 'Initial cycle point ' | ||
| '(default: suite initial point)'), | ||
| ('[STOP]', 'Final cycle point ' | ||
| '(default: initial + 3 points)')]) | ||
|
|
||
| parser.add_option( | ||
| '-u', '--ungrouped', | ||
| help='Start with task families ungrouped (the default is grouped).', | ||
| action='store_true', default=False, dest='ungrouped') | ||
|
|
||
| parser.add_option( | ||
| '-n', '--namespaces', | ||
| help='Plot the suite namespace inheritance hierarchy ' | ||
| '(task run time properties).', | ||
| action='store_true', default=False, dest='namespaces') | ||
|
|
||
| parser.add_option( | ||
| '-r', '--reference', | ||
| help='Output in a sorted plain text format for comparison purposes.', | ||
| action='store_true', default=True, dest='reference') | ||
|
|
||
| parser.add_option( | ||
| '--show-suicide', | ||
| help='Show suicide triggers. They are not shown by default, unless ' | ||
| 'toggled on with the tool bar button.', | ||
| action='store_true', default=False, dest='show_suicide') | ||
|
|
||
| parser.add_option( | ||
| '--icp', action='store', default=None, metavar='CYCLE_POINT', help=( | ||
| 'Set initial cycle point. Required if not defined in suite.rc.')) | ||
|
|
||
| return parser | ||
|
|
||
|
|
||
| def main(opts, suite=None, start=None, stop=None): | ||
| """Implement ``cylc graph``.""" | ||
| if opts.ungrouped and opts.namespaces: | ||
| raise Exception('Cannot combine --ungrouped and --namespaces.') | ||
| if not opts.reference: | ||
| raise Exception('Only the --reference use cases are supported') | ||
|
|
||
| template_vars = load_template_vars( | ||
| opts.templatevars, opts.templatevars_file) | ||
|
|
||
| config = get_config(suite, opts, template_vars=template_vars) | ||
| if opts.namespaces: | ||
| graph_inheritance(config) | ||
| else: | ||
| graph_workflow(config, start, stop, ungrouped=opts.ungrouped, | ||
| show_suicide=opts.show_suicide) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| options, args = get_option_parser().parse_args() | ||
| suite, _ = SuiteSrvFilesManager().parse_suite_arg(options, args[0]) | ||
| main(options, suite) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters