Skip to content

[#698] move definition of IRODS_VERSION #784

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
d-w-moore wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[#698] move definition of IRODS_VERSION #784

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3963c67
[_698] move definition of IRODS_VERSION
d-w-moore Nov 25, 2025
b2c1e6a
Revert "[_698] move definition of IRODS_VERSION"
d-w-moore Jan 8, 2026
dbf5bd8
prefix underline to IRODS_VERSION symbol in irods.message namespace
d-w-moore Jan 8, 2026
1aed89d
comments to explain _IRODS_VERSION
d-w-moore Jan 8, 2026
bb05ba8
recreate _IRODS_VERSION as function returning server compatibility tuple
d-w-moore Jan 9, 2026
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
4 changes: 2 additions & 2 deletions irods/helpers/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import sys
from irods import env_filename_from_keyword_args
import irods.exception as ex
from irods.message import ET, XML_Parser_Type, IRODS_VERSION
Copy link
Contributor

@korydraughn korydraughn Jan 9, 2026

Choose a reason for hiding this comment

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

Can the removal of the IRODS_VERSION symbol break client code?

from irods.message import ET, XML_Parser_Type, _IRODS_VERSION
from irods.path import iRODSPath
from irods.session import iRODSSession

Expand Down Expand Up @@ -56,7 +56,7 @@ def make_session(test_server_version=False, **kwargs):
session = iRODSSession(irods_env_file=env_file, **kwargs)
if test_server_version:
connected_version = _get_server_version_for_test(session, curtail_length=3)
advertised_version = IRODS_VERSION[:3]
advertised_version = _IRODS_VERSION[:3]
if connected_version > advertised_version:
msg = (
"Connected server is {connected_version}, "
Expand Down
6 changes: 3 additions & 3 deletions irods/message/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def ET(xml_type=(), server_version=None):

logger = logging.getLogger(__name__)

IRODS_VERSION = (5, 0, 2, "d")
Copy link
Contributor

@korydraughn korydraughn Jan 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Noting here that we cannot remove symbols from the public interface until a major version bump.

Steps:

  • Restore the old symbol for backward compatibility
  • Introduce _IRODS_VERSION as a duplicate of IRODS_VERSION
  • Dependent code must then be updated to use the new symbol
  • Add a comment stating the old symbol is deprecated

_IRODS_VERSION = (5, 0, 2, "d")

UNICODE = str

Expand Down Expand Up @@ -473,8 +473,8 @@ def __init__(self, proxy_user, client_user, application_name=""):
self.connectCnt = 0
self.proxyUser, self.proxyRcatZone = proxy_user
self.clientUser, self.clientRcatZone = client_user
self.relVersion = "rods{}.{}.{}".format(*IRODS_VERSION)
self.apiVersion = "{3}".format(*IRODS_VERSION)
self.relVersion = "rods{}.{}.{}".format(*_IRODS_VERSION)
self.apiVersion = "{3}".format(*_IRODS_VERSION)
self.option = application_name

irodsProt = IntegerProperty()
Expand Down
2 changes: 1 addition & 1 deletion irods/test/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from irods.helpers import (
home_collection,
make_session as _irods_helpers_make_session)
from irods.message import iRODSMessage, IRODS_VERSION
Copy link
Contributor

@korydraughn korydraughn Jan 9, 2026

Choose a reason for hiding this comment

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

Can the removal of the IRODS_VERSION symbol break client code?

from irods.message import iRODSMessage
from irods.password_obfuscation import encode
import irods.rule
from irods.session import iRODSSession
Expand Down