Skip to content

CLI: Fix --output=json list-refs emitting one object per retention property #4101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomron wants to merge 1 commit into
base: main
Choose a base branch
from
+63 −7
Open

CLI: Fix --output=json list-refs emitting one object per retention property #4101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions pyiceberg/cli/output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,10 +271,4 @@ def version(self, version: str) -> None:
self._out({"version": version})

def describe_refs(self, refs: list[tuple[str, SnapshotRefType, dict[str, str]]]) -> None:
self._out(
[
{"name": name, "type": type, detail_key: detail_val}
for name, type, detail in refs
for detail_key, detail_val in detail.items()
]
)
self._out([{"name": name, "type": type, **detail} for name, type, detail in refs])
62 changes: 62 additions & 0 deletions tests/cli/test_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,65 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import json

import pytest

from pyiceberg.cli.output import JsonOutput
from pyiceberg.table.refs import SnapshotRefType


def test_json_describe_refs_single_ref(capsys: pytest.CaptureFixture) -> None:
JsonOutput().describe_refs(
[
(
"main",
SnapshotRefType.BRANCH,
{
"min_snapshots_to_keep": "1",
"max_snapshot_age_ms": "432000000",
"max_ref_age_ms": "forever",
},
)
]
)

assert json.loads(capsys.readouterr().out) == [
{
"name": "main",
"type": "branch",
"min_snapshots_to_keep": "1",
"max_snapshot_age_ms": "432000000",
"max_ref_age_ms": "forever",
}
]


def test_json_describe_refs_multiple_refs(capsys: pytest.CaptureFixture) -> None:
JsonOutput().describe_refs(
[
(
"main",
SnapshotRefType.BRANCH,
{
"min_snapshots_to_keep": "1",
"max_snapshot_age_ms": "432000000",
"max_ref_age_ms": "forever",
},
),
("v1.0", SnapshotRefType.TAG, {"max_ref_age_ms": "forever"}),
("no-retention", SnapshotRefType.BRANCH, {}),
]
)

assert json.loads(capsys.readouterr().out) == [
{
"name": "main",
"type": "branch",
"min_snapshots_to_keep": "1",
"max_snapshot_age_ms": "432000000",
"max_ref_age_ms": "forever",
},
{"name": "v1.0", "type": "tag", "max_ref_age_ms": "forever"},
{"name": "no-retention", "type": "branch"},
]
Loading