[SCHEMATIC-30, SCHEMATIC-200] Add version to click cli / use pathlib.Path module for checking cache size

[thomasyu888]

Problem

• It was not easy to surface the version of the cli or library used
• we were using du -h system to check for cache size which isn't accurate AND may fail on windows

solution

Add version to cli

schematic -h
Usage: schematic [OPTIONS] COMMAND [ARGS]...

  Command line interface to the `schematic` backend services.

Options:
  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  --version            Show the version and exit.
  -h, --help           Show this message and exit.

Commands:
  manifest  Sub-commands with Manifest Generation utilities/methods.
  model     Sub-commands for Metadata Model related utilities/methods.
  schema    Sub-commands for Schema related utilities/methods.
  viz       Sub-commands for Visualization methods.

schematic --version
schematic, version 24.12.1

import schematic
schematic.__version__
Out[5]: '24.12.1'

This confirms that it will pull from the pyproject.toml, so that needs to be updated

docker build . -t test
docker run test schematic --version
schematic, version 24.12.1

[thomasyu888]

There may be some minor discrepancies between how this would operate on windows, mac, and ubuntu

[BryanFauble]

This doesn't work on WSL2 ubunutu:

Traceback (most recent call last):
  File "/home/bfauble/BryansGreatWorkspace/schematic/junk.py", line 7, in <module>
    print(check_synapse_cache_size())
  File "/home/bfauble/BryansGreatWorkspace/schematic/schematic/utils/general.py", line 141, in check_synapse_cache_size
    total_size = sum(
  File "/home/bfauble/BryansGreatWorkspace/schematic/schematic/utils/general.py", line 141, in <genexpr>
    total_size = sum(
  File "/home/bfauble/.pyenv/versions/3.10.14/lib/python3.10/pathlib.py", line 1047, in rglob
    for p in selector.select_from(self):
  File "/home/bfauble/.pyenv/versions/3.10.14/lib/python3.10/pathlib.py", line 405, in select_from
    if not is_dir(parent_path):
  File "/home/bfauble/.pyenv/versions/3.10.14/lib/python3.10/pathlib.py", line 1305, in is_dir
    return S_ISDIR(self.stat().st_mode)
  File "/home/bfauble/.pyenv/versions/3.10.14/lib/python3.10/pathlib.py", line 1097, in stat
    return self._accessor.stat(self, follow_symlinks=follow_symlinks)
PermissionError: [Errno 13] Permission denied: '/root/.synapseCache'

from schematic.utils.general import check_synapse_cache_size

print(check_synapse_cache_size())

[BryanFauble]

I guess before it probably wouldn't have either since the default is to use /root. It does work though with how it's implemented in code:

from schematic.store.synapse import SynapseStorage
from schematic.utils.general import check_synapse_cache_size

synapse_store = SynapseStorage()

print(check_synapse_cache_size(synapse_store.root_synapse_cache))

[thomasyu888]

Ya, I think the default being root is an issue here, it should work if you set it to any other folder you had access to...

That said, I think there was a reason why the default was set to /root/.synapseCache

[thomasyu888]

du -h was not completely accurate as it would also potentially gather the bytes that a 'folder' takes up which we don't necessarily care too much about.

This change also ensures the results are the same on github actions

[thomasyu888]

There are separate tests in the test_utils.py, should I move them here?

[BryanFauble]

Yes please, those under class TestGeneral: look like good candidates to move over here

[BryanFauble]

Double check that this works in a docker container. I ran into issues using __version__ where on my local machine it worked fine, but in docker it would crash because the package was not found.

Related to 778bf54#diff-cf3cc0451d73d8b13adca0706b2ee953089f7fe25000b03615bf14dd2a7220ca - I ended up removing the code to grab the version out of this because of the error.

[BryanFauble]

For this I had just used docker build . and did a docker run on the built image. If it starts up we would just want to confirm that we could print the version to console.

I had tried the same things you did here:

a096639

2e3b3cf

b718f85

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud