Create a Python extension

Pierre_20718

Hi,

I'm trying to create a Python extension for Hyperview (2024), with a button in the ribbon for an existing script.

I got this error:

Traceback (most recent call last):
File "S:/GitLab-Runner/builds/TqqBBs8CP/0/altairengineering/modvis/common/common/framework/win64/hwx/bin/win64/hwsigslot.py", line 1620, in _Emit
File "/users/altairbuilds6/gitlab-runner-dir/builds/qUzuQUGTh/1/altairengineering/modvis/hwx/hwdesktop/unity/scripts/python/hwx/xmlui/factory/ribbonfactory.py", line 1115, in _onCommand
File "/users/altairbuilds6/gitlab-runner-dir/builds/qUzuQUGTh/1/altairengineering/modvis/hwx/hwdesktop/unity/scripts/python/hwx/xmlui/utils.py", line 225, in execcallback
File "<string>", line 1
rescale(<generator object execcallback.<locals>.<genexpr> at 0x000001EE3EC14740>)
^
SyntaxError: invalid syntax

And my source files are :

extension.xml :

<section name="Extension">
	<! … some stuff with name, version, etc. —>
	<entry name="tclscript"			value="global-init.tcl" />
	<entry name="script"			value="global-init.py" />
	<section name="profile" value="HyperView">
		<entry name="ribbonxml" value="hv/hv-ribbon.xml" />
		<entry name="script" value="hv/hv-init.py" />
	</section>
</section>

Global-init.py and global-init.tcl are pretty empty (I start with a first button before to do more) :

import hw

from hw import hv

package require postquery

namespace eval ::MyExtension {

global env

variable workDir [file normalize [[::hwp::GetSession] GetSystemVariable CURRENTWORKINGDIR]]

}

hv/hv-ribbon.xml

<root>

	<actionlist>

		<action

			tag="Ext_Ribbon_HV_Action_rescale"

			text="Rescale legend"

			tooltip="Rescale the legend with an exponential scale"

			image="scale.png"

			command="py: rescale"

		/>
	</actionlist>
	
	<page tag="Ext_Ribbon_HV_Ribbon_testone" text="TEST ONE">
		<group tag="Ext_Ribbon_HV_Ribbon_testonegroupone" text="GROUP ONE">
			<action actiontag="Ext_Ribbon_HV_Action_rescale"/>
		</group>
	</page>
</root>

hv/hv-init.py :

import sys

import hw

from hw import hv



def rescale(*a, **kwargs):


    print("hello world!")

    #return _rescale()  # not working, so I try to only run a print…

    return 0

What's wrong ?

Thanks,

Pierre

Michael Herve

Hello @Pierre_20718 ,

The function rescale must belong to a module, and then () must be added to the end as a function call. The path to the modeul "themodulename" must be added to sys.path

command="py: rescale"

command="py: themodulename.rescale()"

Best Regards,

Michael

Michael Herve

Hello @Pierre_20718 ,

The function rescale must belong to a module, and then () must be added to the end as a function call. The path to the modeul "themodulename" must be added to sys.path

command="py: rescale"

command="py: themodulename.rescale()"

Best Regards,

Michael

Pierre_20718

Hello @Michael Herve,

Thanks !

(the "hv-init.py" doesn't work, but putting a module in the "global-init.py" works well, so it's good enough ;) )

If it can help someone in the future :

0/ Prerequires

• Have a look to https://help.altair.com/hwdesktop/hwx/topics/reference/extensions/extensions_r.htm
• Create a directory for the module (It will be the root of the paths, for non Linux users)

1/ Create a Python module :

./hv/moduleHV/__init__.py

from .fcts import rescale
__all__ = ["rescale",]

./hv/moduleHV/fcts.py

import sys

import hw

from hw import hv

def _rescale():
   """
   I like to keep my real function a little bit hidden
   """
   print("hello world!")
   return 0

def rescale(*a, **kwargs):

   return _rescale()

2/ Create a ./global-init.py

import os, sys
filepath = str(os.path.abspath(file))

filedir = os.path.dirname(filepath)

path_module = os.path.join(filedir, "hv")

if not path_module in sys.path:
    sys.path.append(path_module)
#

from moduleHV import *

sys.stdout.write("global-init.py of extension-altair laoded\n")

and add

	<entry name="script"			value="global-init.py" />

to the ./extension.xml after the

<entry name="tclscript"			value="global-init.tcl" />

3/ Edit ./hv/hv-ribbon.xml

<root>


	<actionlist>


		<action


			tag="Ext_Ribbon_HV_Action_rescale"


			text="Rescale legend"


			tooltip="Rescale the legend with an exponential scale"


			image="scale.png"


			command="py: moduleHV.rescale()"


		/>

	</actionlist>


	<page tag="Ext_Ribbon_HV_Ribbon_testone" text="TEST ONE">

		<group tag="Ext_Ribbon_HV_Ribbon_testonegroupone" text="GROUP ONE">

			<action actiontag="Ext_Ribbon_HV_Action_rescale"/>

		</group>

	</page>

</root>

4/ Create a pretty pict (scale.png) like this ^^ (2 and 6 seems to be the usefull ones for the ribbon), and put it in the ./images

5/ Load this extension ;)