Skip to content

Python: Add __version__ to the package #5315

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

Merged
rdblue merged 3 commits into from
Jul 21, 2022
Merged

Python: Add __version__ to the package #5315

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8467ea
Python: Add __version__ to the package
Fokko Jul 20, 2022
b3c8b2f
Set the version to 0.1.0.dev0
Fokko Jul 21, 2022
7ffa591
Improve the regex
Fokko Jul 21, 2022
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
3 changes: 3 additions & 0 deletions python/pyiceberg/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from importlib import metadata

__version__ = metadata.version(__package__)
2 changes: 1 addition & 1 deletion python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

[tool.poetry]
name = "pyiceberg"
version = "0.0.1rc1"
version = "0.14.0.dev0"

@dramaticlly dramaticlly Jul 20, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess using 0.14.0 means every time there's major/minor release from java library, there's need to bump up this to keep it in sync. However I feel there's still cognitive benefit so LGTM!

@samredai samredai Jul 20, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fokko how would this change for patch releases to the python client?

@rdblue rdblue Jul 21, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably set this to 0.1.0.dev0? I don't think that we want to tie Java and Python versions together, right?

@Fokko Fokko Jul 21, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks all for chiming in! 👍🏻 As I wrote in the initial post, this is up for discussion. I can see benefits on both sides.

The direct reason for adding the version to the Python code is to pass it as a header to the REST API. If we release Python and Java together, we can give some guarantee that they are compatible.
My biggest concern with tying them together is that the release process becomes more involved because we have to test both Java and Python. Especially since the Python codebase is still young, I would expect a faster release cadence until everything settles.

I've changed it to 0.1.0.dev0 for now.

readme = "README.md"
homepage = "https://iceberg.apache.org/"
repository = "https://github.com/apache/iceberg/"
Expand Down
24 changes: 24 additions & 0 deletions python/tests/test_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import re

from pyiceberg import __version__


def test_version_format():
# should be in the format of 0.14.0 or 0.14.0.dev0
assert re.search(r"\d+.\d+.\d+(.dev\d+)?", __version__)