Feature/parents lookup #372

szvsw · 2022-08-09T23:07:39Z

So this implements the determination of parents at runtime using the new _CREATED_OBJECTS functionality.

The only thing that is a little off about it is that the wrapper objects don't have it implemented - e.g. MassRatios don't have parents (however the Material inside of a MassRatio will accurately find the Parents/ParentTemplates, same for a Material inside of a Layer finding the parent construction or a WeekSchedule inside of a WeekSchedulePart finding the parent YearSchedule).

Not a big deal IMO, since all UmiBase objects have it at least and it works properly.

There's a little bit of weirdness with the imports - rather than using from x import y we use import x as y in order to avoid circular imports. This is because we need to use the parent classes' _CREATED_OBJECTS in the children, so the children must import the parents, but... the parents are also already importing the children. A way to avoid this would be to go back to storing the _CREATED_OBJECTS in UmiBase, but using a key for each parent class. That way all the children don't need to import the parent classes...

szvsw · 2022-08-09T23:41:08Z

Hmm will take a look at the test errors in the morning and resolve

szvsw · 2022-08-10T14:56:07Z

@samuelduchesne I'm not sure why this test is failing

tests/test_schedules.py::TestSchedule::test_plot

It passes fine on my machine and as far as I can tell I have not done anything that would affect that module. Everything else seems to be passing though.

szvsw · 2022-08-11T11:50:49Z

Okay, refactored this so that the PR is significantly simpler/less messy:

_CREATED_OBJECTS lives in UmiBase again, but stores a dict with class names as keys
UmiBase has a CREATED_OBJECTS property which uses the calling object's clas to get the list of created objects of that class
UmiBase has a single Parents and ParentTemplates property which works for all classes
Each class just has to define which classes may be a parent and what keys it may be found at
Retains original import structure and all the arrow type returns

Comes with two tests:

One which tests that basic functionality is working
One which tests that every component in a library which has unique_components(keep_orphaned=False) called on it has at least one parent template from that library.

The only test that is failing is the test_schedules::TestSchedule::test_plot, with error report below

Really scratching my head on this one, as it passes fine on my machine when running it in isolation at least. Any ideas, @samuelduchesne ?

____________________________ TestSchedule.test_plot ____________________________
[gw1] linux -- Python 3.8.13 /opt/hostedtoolcache/Python/3.8.13/x64/bin/python

self = <tests.test_schedules.TestSchedule object at 0x7f1b54660190>
schedules_in_necb_specific = <archetypal.schedule.Schedule object at 0x7f1b5186efa0>

    def test_plot(self, schedules_in_necb_specific):
>       schedules_in_necb_specific.plot(drawstyle="steps-post")

tests/test_schedules.py:57: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
archetypal/schedule.py:1389: in plot
    return self.series.plot(**kwargs)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_core.py:972: in __call__
    return plot_backend.plot(data, kind=kind, **kwargs)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/__init__.py:71: in plot
    plot_obj.generate()
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/core.py:329: in generate
    self._make_plot()
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/core.py:1226: in _make_plot
    newlines = plotf(
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/core.py:1276: in _ts_plot
    lines = cls._plot(ax, data.index, data.values, style=style, **kwds)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/core.py:1256: in _plot
    lines = MPLPlot._plot(ax, x, y_values, style=style, **kwds)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/converter.py:91: in wrapper
    return func(*args, **kwargs)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/pandas/plotting/_matplotlib/core.py:755: in _plot
    return ax.plot(*args, **kwds)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/mpl_toolkits/mplot3d/axes3d.py:1502: in plot
    self.auto_scale_xyz(xs, ys, zs, had_data)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/mpl_toolkits/mplot3d/axes3d.py:652: in auto_scale_xyz
    self.xy_dataLim.update_from_data_xy(
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/matplotlib/transforms.py:967: in update_from_data_xy
    path = Path(xy)
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/matplotlib/path.py:129: in __init__
    vertices = _to_unmasked_float_array(vertices)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

x = array([[Period('2018-01-01 00:00', 'H'), 18],
       [Period('2018-01-01 01:00', 'H'), 18],
       [Period('2018-01-01..., 'H'), 18],
       [Period('2018-12-31 22:00', 'H'), 18],
       [Period('2018-12-31 23:00', 'H'), 18]], dtype=object)

    def _to_unmasked_float_array(x):
        """
        Convert a sequence to a float array; if input was a masked array, masked
        values are converted to nans.
        """
        if hasattr(x, 'mask'):
            return np.ma.asarray(x, float).filled(np.nan)
        else:
>           return np.asarray(x, float)
E           TypeError: float() argument must be a string or a number, not 'Period'

/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/matplotlib/cbook/__init__.py:1298: TypeError

samuelduchesne · 2022-08-12T02:05:40Z

Will try to take a look tomorrow!

samuelduchesne

Is there a new function to traverse the hierarchy that is not parent_key_child_traversal?

samuelduchesne · 2022-08-12T20:27:07Z

archetypal/template/umi_base.py

+        return cls._CREATED_OBJECTS[object_class.__name__ + "s"]
+
+    @property
+    def CREATED_OBJECTS(self):


Could this be a private property instead of a public one? Trying to keep it clean as much as possible

samuelduchesne · 2022-08-12T20:28:39Z

archetypal/template/umi_base.py

+        return templates
+
+    @classmethod
+    def CREATED_OBJECTS(cls, object_class):


This has the same name as the property bellow?

samuelduchesne · 2022-08-12T20:29:16Z

archetypal/template/umi_base.py

@@ -437,6 +457,57 @@ def get_unique(self):

        return obj

+    @property
+    def Parents(self):
+        """ Get the parents of an UmiBase Object"""


Stupid but can you remove the first space before each comment lol

szvsw · 2022-08-12T23:25:27Z

Not for this pr - the ParentTemplates method illustrates climbing up the tree from a given leaf though. I don't think it's of utility in a top down approach.

For me the idea for this PR is to just provide a simple and fairly minimal way to be able to determine ParentTemplates in the short term, so that we can then move to get feature/measures finished and merged.

The other aspect is that this can easily be upgraded if we build out the real-time edge tracking, since it essentially would just require updating the Parents property to use the data from the real-time graph rather than computing the parents - everything else should be able to stay the same though.

samuelduchesne and others added 8 commits August 9, 2022 12:03

Moves CREATED_OBJECTS to children of UmiBase

887caa3

Evaluate on nullity instead of existence

bd681ae

Don't validate object in recursive_replace()

8b06d65

Don't validate by default

ae2fcce

Fix category issue with OpaqueConstruction

88e288e

Implements significant figures

b860d0e

No Duplicates for GasMaterial, GlazingMaterial, OpaqueMaterial

615e8a8

enable parents and templates lookup

0cd0d75

szvsw requested a review from samuelduchesne August 9, 2022 23:07

Merge branch 'main' into feature/parents-lookup

37431e2

szvsw added 2 commits August 10, 2022 10:20

fix error in merge request

fbe17aa

change assertion in parent templates test

7045129

szvsw added 8 commits August 10, 2022 19:38

move created_objects to UmiBase

438d226

Merge branch 'main' into feature/parents-lookup

7e1d579

fix stale _CREATED_OBJECTS

bdc6aff

add umischedules to created_objects

849333b

add nomass to created objects

8688f43

change to ids for identity test

8f1f7d3

fix test_all_children test to only test templates in current lib

7e0ddf7

test that non-orphaned children have at least one parent

b5ea160

samuelduchesne requested changes Aug 12, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/parents lookup #372

Feature/parents lookup #372

szvsw commented Aug 9, 2022

szvsw commented Aug 9, 2022

szvsw commented Aug 10, 2022 •

edited

Loading

szvsw commented Aug 11, 2022

samuelduchesne commented Aug 12, 2022

samuelduchesne left a comment

samuelduchesne Aug 12, 2022

samuelduchesne Aug 12, 2022

samuelduchesne Aug 12, 2022

szvsw commented Aug 12, 2022

Feature/parents lookup #372

Are you sure you want to change the base?

Feature/parents lookup #372

Conversation

szvsw commented Aug 9, 2022

szvsw commented Aug 9, 2022

szvsw commented Aug 10, 2022 • edited Loading

szvsw commented Aug 11, 2022

samuelduchesne commented Aug 12, 2022

samuelduchesne left a comment

Choose a reason for hiding this comment

samuelduchesne Aug 12, 2022

Choose a reason for hiding this comment

samuelduchesne Aug 12, 2022

Choose a reason for hiding this comment

samuelduchesne Aug 12, 2022

Choose a reason for hiding this comment

szvsw commented Aug 12, 2022

szvsw commented Aug 10, 2022 •

edited

Loading