You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After showing the Inspect API and specifically the Inspector class functionality to members of other teams, it became apparent that accessing Inspector is currently a bit messy. The import process goes through several levels of the package structure, which assumes the user has good knowledge of csvcubed and its file structure. At the moment, importing the Inspector class looks something like this:
Obviously this is not a problem to us but this is something that would be done frequently by users trying to use the Inspect API in their code, so we should try to make it as simple as possible.
It could look something like this:
fromcsvcubed.inspectorimportInspector
Investigate the best way for the Inspect package to enable imports to work like so. The Inspector class is located in the file inspectortable.py so moving this file or the class is the main objective.
The easiest way would likely be to simply move the file inspectortable.py one level higher. I personally suggest renaming the file to "inspector" if this is done.
That would achieve the result we want, but we should probably be apprehensive towards having files in the top level like that, so there may be a better way.
Once a decision has been made, make the changes to the file structure.
Check the imports and resolve any broken dependencies caused by the changes. One potential import that could be broken that I found from a brief investigation was in test_browsers.py where Inspector functionality is tested. Please also rename this test file file to something more suitable, as this file's name still follows the outdated "Browser" label for what is now the "Inspector" group of classes.
The text was updated successfully, but these errors were encountered:
After showing the Inspect API and specifically the
Inspector
class functionality to members of other teams, it became apparent that accessingInspector
is currently a bit messy. The import process goes through several levels of the package structure, which assumes the user has good knowledge of csvcubed and its file structure. At the moment, importing theInspector
class looks something like this:Obviously this is not a problem to us but this is something that would be done frequently by users trying to use the Inspect API in their code, so we should try to make it as simple as possible.
It could look something like this:
inspectortable.py
so moving this file or the class is the main objective.test_browsers.py
where Inspector functionality is tested. Please also rename this test file file to something more suitable, as this file's name still follows the outdated "Browser" label for what is now the "Inspector" group of classes.The text was updated successfully, but these errors were encountered: