GTK/Gobject unnecessary for cylc graph --reference (7.8.x)

[sadielbartholomew]

Describe the bug

The cylc graph utility generally is interactive & requires relevant GUI application modules, but the --reference option in itself does not. However, the logic is written such that running with the --reference option will go through the standard list of module imports, including of gtk & gobject, terminating if these are not imported successfully:

cylc-flow/bin/cylc-graph

Lines 194 to 202 in 8ac7ae3

	try:
	import gtk
	import gobject
	from xdot import DotWindow
	from cylc.cylc_xdot import (
	MyDotWindow, MyDotWindow2, get_reference_from_plain_format)
	except (ImportError, RuntimeError) as error:
	# Allow command help generation without a graphical environment.
	sys.exit('ERROR: no X environment? %s' % error)

So cylc graph --reference will fail in an environment without GTK, when it should according to inherent requirements work. Indeed, a user has expressed that it would be useful for them to use it without the need for GTK. Enabling it to do so requires only a minor restructure to the bin/cylc-graph code.

Release version(s) and/or repository branch(es) affected?

Not applicable for Cylc 8 & newer versions, where the graphing code has been replaced & GTK is not longer used in the codebase (:tada:).

Steps to reproduce the bug

1. Find or create an environment without either PyGTK (in Gnome-2) or PyGobject (Gnome-3) installed.

2. You should observe by running the relevant command for some 'example-suite':

   $ cylc graph --reference <suite-name>
   ERROR: no X environment? No module named gtk

   (or gobject instead of gtk).

Expected behavior

cylc graph --reference runs as standard in an environment without GTK or Gobject.

Pull requests welcome!
This is an Open Source project - please consider contributing a bug fix
yourself (please read CONTRIBUTING.md before starting any work though).

[hjoliver]

I just took a quick look at the code. Unfortunately it's not as simple as avoiding the import test above if --reference is specified, because the reference graph is still written out via graph.draw() in the underlying xdot gtk application, which also imports gtk. Probably not too difficult to disintengtangle this if we really needed to, but I'm not sure it's worth the effort (for the reasons you gave on Discourse @sadielbartholomew - cylc 8 etc. Plus I don't see a user need for reference graphs - unlike a graphical representation they are harder to interpret than the suite.rc graph syntax itself).

So maybe we keep this issue to acknowledge the problem, but close it as "won't fix"?

[oliver-sanders]

I re-implemented the --reference functionality for Cylc8 independent of pygtk. It's not too much code but really doesn't fit into the Cylc7 cylc-graph framework.

5b75c8c

Given the internal nature of the code and the timescale of Cylc8 can we punt this?

[hjoliver]

I re-implemented the --reference functionality for Cylc8 independent of pygtk. It's not too much code but really doesn't fit into the Cylc7 cylc-graph framework.

I had forgotten about this, and it only took a few minutes to back-port it to Cylc 7 as a new command, so I'll reopen this and put up a PR ... given that there is (at least some) user demand.

[sadielbartholomew]

😕 This should have closed automatically with the merge of #3349, but it hasn't. I'm not sure why not, since that PR uses the standard 'close' syntax, but I'll close this manually.

[hjoliver]

Thanks for closing this @sadielbartholomew - good spot 👍

Auto-close only works for PRs to master.