extended FSWTabDict class by JimHofman · Pull Request #377 · NASA-AMMOS/AIT-Core

JimHofman · 2021-10-20T16:21:53Z

No description provided.

nttoole · 2021-10-20T16:27:12Z

@JimHofman Looks like you still need to declare your newCmd as an extension in the config.yaml

See: https://ait-core.readthedocs.io/en/master/extensions.html

Config yaml would contain an entry that looks like:

....
extensions:
    ait.core.cmd.Cmd: ait.core.newCmd.NewCmd

Would presumably need something similar for the table extension.

JimHofman · 2021-10-20T16:34:57Z

I'll check that out Nick. I was sure I had added those. Hmmm. Thanks Nick.

MJJoyce · 2021-10-20T20:19:46Z

Hey @JimHofman, replying here with regards to the issue(s) you're running into with the table extension support. Thanks for throwing this branch up so we have something to dig through.

It looks like you got the "general extension" stuff added and working correctly. That's why you can see log message indicating that the extension class has been added. However, it's not getting fully pulled in for a few reasons (I think).

def YAMLCtor_FSWColDefn(loader, node):  # noqa: N802
    fields = loader.construct_mapping(node, deep=True)
    return FSWColDefn(**fields)


def YAMLCtor_FSWTabDefn(loader, node):
    fields = loader.construct_mapping(node, deep=True)
    fields['fswheaderdefns'] = fields.pop('header', None)
    fields['coldefns'] = fields.pop('columns', None)
    return FSWTabDefn(**fields)

These functions are used by the custom YAML class handling stuff when processing the dictionary

yaml.add_constructor("!FSWTable", YAMLCtor_FSWTabDefn)
yaml.add_constructor("!FSWColumn", YAMLCtor_FSWColDefn)

So, if you import the table dictionary you'll see a message indicating that the extension was loaded but it's never going to actually load your class because the above functions (and others in the code) are calling explicit class names instead of the "extensions classes". These createXXX functions that should be used are (poorly) documented in the extension code:
https://github.com/NASA-AMMOS/AIT-Core/blob/master/ait/core/util.py#L112

Looking through the table code really quickly (so you should sanity check that I'm not missing something) I think you need to make the following modifications:

JimHofman · 2021-10-28T21:04:11Z

Table extensions now work. Created a newTable.py to override FSWTabDict.
newTable.py
from ait.core import table, log

class NewFSWTabDict(table.FSWTabDict):
def init(self, *args, **kwargs):
super().init(*args, **kwargs)

def load(self, fname):
    log.info('Starting the table load() from the extended 
    	     FSWTabDict class, using file: {}'.format(self.filename))
    return super(NewFSWTabDict, self).load(fname)

def custom():
    log.info('Test of a unique method defined in an extension.')

Used the following to instantiate and verify:

import ait.core.table as table

table_dict = table.getDefaultFSWTabDict()

jasonmlkang

Please see comments.

I think createFSWxxx methods should be auto generated during the extension process. Otherwise it would throw error when no extension is defined in the config.

Also the branch has conflicts with current master.

jasonmlkang · 2022-03-14T16:56:26Z

ait/core/cmd.py

    data = None
    with open(name,'r') as f:
-        data = yaml.load(f)
+        data = yaml.load(f, Loader=yaml.Loader)


Why is this necessary?

I took out loader=yaml.loader.
We might want to get rid of data=None and use a try/except around the open block.

jasonmlkang · 2022-03-14T16:58:03Z

ait/core/dtype.py

 import re

-from ait.core import cmd, dmc, log, util
+from ait.core import cmd, dmc, log, util, table


table is not reference in this module

jasonmlkang · 2022-03-14T17:02:53Z

ait/core/table.py

        defn = self.get(name, None)
        if defn:
-            tab = FSWTab(defn, *args)
+            tab = createFSWTab(defn, *args)


createFSWTab method not defined

jasonmlkang · 2022-03-14T17:03:20Z

ait/core/table.py

        if self.fswtabdict is None:
            if self.dirty():
-                self.fswtabdict = FSWTabDict(self.filename)
+                self.fswtabdict = createFSWTabDict(self.filename)


createFSWTabDict not defined

jasonmlkang · 2022-03-14T17:03:38Z

ait/core/table.py

    fields['fswheaderdefns'] = fields.pop('header', None)
    fields['coldefns'] = fields.pop('columns', None)
-    return FSWTabDefn(**fields)
+    return createFSWTabDefn(**fields)


createFSWTabDict not defined

jasonmlkang · 2022-03-14T17:11:22Z

config/config.yaml

+        ait.core.cmd.Cmd: ait.core.newCmd.NewCmd
+        ait.core.table.FSWTabDict: ait.core.newTable.NewFSWTabDict


These are testing codes?

Yes that is for testing. I took it out.

nttoole · 2022-03-14T17:26:27Z

Correct, the createXxx() methods are implicitly added here:

AIT-Core/ait/core/util.py

Line 148 in 5b9a247

def __init_extensions__(modname, modsyms): # noqa

jasonmlkang

Please see comment. Thanks!

jasonmlkang · 2022-03-15T00:07:25Z

ait/core/cmd.py

This overwrites previous definition of YAMLCtor_include. Is this done on purpose?

jasonmlkang · 2022-03-15T00:58:55Z

ait/core/table.py

Sorry, my comment from last review was incorrect. The createFSWxxx method gets created in run-time during the extension process (i.e. util.__init_extensions__). So it is okay to call createFSWxxx method here. Please revert back to before this commit.

jasonmlkang · 2022-03-15T00:59:06Z

ait/core/table.py

Sorry, my comment from last review was incorrect. The createFSWxxx method gets created in run-time during the extension process (i.e. util.__init_extensions__). So it is okay to call createFSWxxx method here. Please revert back to before this commit.

jasonmlkang · 2022-03-15T00:59:14Z

ait/core/table.py

        defn = self.get(name, None)
        if defn:
-            tab = createFSWTab(defn, *args)
+            tab = FSWTab(defn, *args)


Sorry, my comment from last review was incorrect. The createFSWxxx method gets created in run-time during the extension process (i.e. util.__init_extensions__). So it is okay to call createFSWxxx method here. Please revert back to before this commit.

jasonmlkang · 2022-03-15T00:59:26Z

ait/core/table.py

            if self.dirty():
-                self.fswtabdict = createFSWTabDict(self.filename)
+                self.fswtabdict = FSWTabDict(self.filename)
                self.update()


Sorry, my comment from last review was incorrect. The createFSWxxx method gets created in run-time during the extension process (i.e. util.__init_extensions__). So it is okay to call createFSWxxx method here. Please revert back to before this commit.

Ok, I made the changes back and update utll.py

extended FSWTabDict class

eacbb9f

JimHofman requested review from a team as code owners October 20, 2021 16:21

issue-376: update new branch

a6dd09c

item-376 extensions for table.py

9fbae8b

jasonmlkang requested changes Mar 14, 2022

View reviewed changes

modifications based on rewiew

763ce15

jasonmlkang requested changes Mar 15, 2022

View reviewed changes

JHofman728 and others added 3 commits March 24, 2022 13:57

reverts in table, and update util

7def8d4

conflict with a comment

b0daf40

Merge branch 'master' into issue-376

3ed3b43

		ait.core.cmd.Cmd: ait.core.newCmd.NewCmd
		ait.core.table.FSWTabDict: ait.core.newTable.NewFSWTabDict

Conversation

JimHofman commented Oct 20, 2021

Uh oh!

nttoole commented Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JimHofman commented Oct 20, 2021

Uh oh!

MJJoyce commented Oct 20, 2021

Uh oh!

JimHofman commented Oct 28, 2021

Uh oh!

jasonmlkang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JimHofman Mar 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nttoole commented Mar 14, 2022

Uh oh!

jasonmlkang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nttoole commented Oct 20, 2021 •

edited

Loading

jasonmlkang left a comment •

edited

Loading

JimHofman Mar 14, 2022 •

edited

Loading