Skip to content

Commit

Permalink
Return List[str] when load_metadata is false
Browse files Browse the repository at this point in the history
  • Loading branch information
muhammadhamzasajjad committed Apr 26, 2024
1 parent a007cad commit 1983a1b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
10 changes: 6 additions & 4 deletions python/arcticdb/version_store/library.py
Original file line number Diff line number Diff line change
Expand Up @@ -1452,7 +1452,7 @@ def has_symbol(self, symbol: str, as_of: Optional[AsOf] = None) -> bool:
"""
return self._nvs.has_symbol(symbol, as_of=as_of)

def list_snapshots(self, load_metadata: Optional[bool] = True) -> Dict[str, Any]:
def list_snapshots(self, load_metadata: Optional[bool] = True) -> Union[List[str], Dict[str, Any]]:
"""
List the snapshots in the library.
Expand All @@ -1463,10 +1463,12 @@ def list_snapshots(self, load_metadata: Optional[bool] = True) -> Dict[str, Any]
Returns
-------
Dict[str, Any]
Snapshots in the library. Keys are snapshot names, values are metadata associated with that snapshot.
Union[List[str], Dict[str, Any]]
Snapshots in the library. Returns a list of snapshot names if load_metadata is False, otherwise returns a
dictionary where keys are snapshot names and values are metadata associated with that snapshot.
"""
return self._nvs.list_snapshots(load_metadata)
result = self._nvs.list_snapshots(load_metadata)
return result if load_metadata else list(result.keys())

def list_versions(
self,
Expand Down
5 changes: 4 additions & 1 deletion python/tests/integration/arcticdb/test_arctic.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import pandas as pd
import numpy as np
from datetime import datetime, timezone
from typing import List
from enum import Enum
import platform

Expand Down Expand Up @@ -218,7 +219,9 @@ def test_list_snapshots_no_metadata(arctic_library):
lib.write(symbol2, df)
lib.snapshot(snap2)

assert lib.list_snapshots(False) == {snap1: None, snap2: None}
snaps_list = lib.list_snapshots(False)
assert isinstance(snaps_list, List)
assert set(snaps_list) == {snap1, snap2}

def test_delete_non_existent_snapshot(arctic_library):
lib = arctic_library
Expand Down

0 comments on commit 1983a1b

Please sign in to comment.