Skip to content

Add public functions to generate parts of the data returned by clara.tools.inspect #286

Open
@WilliamParker

Description

@WilliamParker

Session inspection returns all of the different data sets discussed in this docstring. In a discussion at #283 (comment) we discussed creating a public function to retrieve each entry individually. In that PR the code to generate one of the entries was factored out so that it could be accessed by the fact-graph functionality, but made private so that we wouldn't have the inconsistency of having only one of the entries in inspect separated out that way. The fact-graph functionality then broke privacy via Var access to use the function.

There are several benefits of allowing this access pattern:

  • For large sessions, calling clara.tools.inspect/inspect can take nontrivial time. For some use cases this could be problematic, and not generating data that the consumer doesn't need is the low-hanging fruit for performance improvement here.
  • If one only cares about a particular entry it is slightly simpler to call a single function than to call two functions (inspect and a keyword lookup).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions