[Dashboard] Add utility functions for actor and memory APIs #11011
Conversation
…w and memory view APIs
…hot-reloading local dev environment.
dashboard/memory_utils.py
Outdated
| else: | ||
| return False | ||
|
|
||
| def __dict__(self): |
There was a problem hiding this comment.
Is it a Python's magic method? If not, it's better to rename it to as_dict.
There was a problem hiding this comment.
I think as_dict is also fine though.
There was a problem hiding this comment.
But, I can't find the official document for the __dict__ method. I know there is a __dict__ special attribute, it's not a method.
There was a problem hiding this comment.
Ah, you are right. I've searched about it, and it was not the magic method :o
I didn't know about this so far... We should change to as_dict. Thanks for caching this!
There was a problem hiding this comment.
Yeah, __dict__ returns the Python object's attributes as a dict. Good catch, I'll rename it.
dashboard/memory_utils.py
Outdated
| self.table.sort(key=lambda entry: entry.reference_type) | ||
| else: | ||
| raise ValueError( | ||
| "Give sorting type: {} is invalid.".format(sorting_type)) |
There was a problem hiding this comment.
It's better to use fstring.
dashboard/memory_utils.py
Outdated
| return self.call_site | ||
| else: | ||
| raise ValueError( | ||
| "group by type {} is invalid.".format(group_by_type)) |
There was a problem hiding this comment.
It's better to use fstring.
| This will sort entries first and gruop them after. | ||
| Sort order will be still kept. | ||
| """ | ||
| self._sort_by(sort_by_type)._group_by(group_by_type) |
There was a problem hiding this comment.
Is the self._sort_by(...)._group_by(...) equals with self._group_by(...)._sort_by(...)?
There was a problem hiding this comment.
It is not equal, which I agree is somewhat confusing. That said, it is sorted before grouped in all code paths.
dashboard/memory_utils.py
Outdated
| else: | ||
| return False | ||
|
|
||
| def __dict__(self): |
dashboard/memory_utils.py
Outdated
| else: | ||
| return False | ||
|
|
||
| def __dict__(self): |
There was a problem hiding this comment.
I think as_dict is also fine though.
| for actor in actors.values(): | ||
| actor_class = actor["actorClass"] | ||
| groups[actor_class].append(actor) | ||
| return dict(groups) |
There was a problem hiding this comment.
Isn't groups already dict?
There was a problem hiding this comment.
No groups is a defaultdict.
rkooo567
added
the
@author-action-required
|
@rkooo567 correct, this PR just adds some utility files that get used by the logical view and memory view in another PR. |
mfitton
removed
the
@author-action-required
Why are these changes needed?
There are several utility classes / functions leaned upon by the Memory and Logical View APIs. This introduces the utility modules.
Related issue number
Checks
scripts/format.shto lint the changes in this PR.Memory utils is unit tested. There are integration tests in the PR with the meat of the memory view / logical view logic.