call_port method doesn't exist in kx.tick.GATEWAY class

[fabiogaiera]

Hi maintainers,

While reviewing the documentation at https://github.com/KxSystems/pykx/blob/main/docs/user-guide/advanced/streaming/gateways.md, I noticed a reference to the call_port method, both in the text and in the code examples.

However, it appears that the call_port method is not defined in the GATEWAY class. Could you please confirm whether the documentation needs updating?

Additionally, in the following snippet:

def gateway_function(table, symbol):
    rtp = gateway.call_port('rtp', table, symbol)
    try:
        hdb = gateway.call_port('hdb', table, symbol)
    except BaseException:
        print('Failed to retrieve data from HDB')
        hdb = 0
    return rtp + hdb

the function returns the sum of rtp and hdb. Is this behavior correct and intended?

Thanks in advance for your help.

Best regards,
Fabio

[fabiogaiera]

Hi! Any plans to introduce a fix for this?

Best,
Fabio

[rianoc-kx]

The function is defined from within a .q script which is why the automated documentation plugin in not finding it.
https://github.com/KxSystems/pykx/blob/main/src/pykx/extensions/gateway.q#L41
We'll review if we can tidy this up and have it documented where you would expect.

For rtp + hdb, yes it is supposed to be a sum.