From 9637452bfecbee3cb882f3441a4252e0d942fcab Mon Sep 17 00:00:00 2001 From: d-w-moore Date: Thu, 8 Jan 2026 01:32:51 -0500 Subject: [PATCH 1/4] prefix underline to IRODS_VERSION symbol in irods.message namespace --- irods/helpers/__init__.py | 4 ++-- irods/message/__init__.py | 6 +++--- irods/test/helpers.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/irods/helpers/__init__.py b/irods/helpers/__init__.py index 93823a110..0de7fd2c9 100644 --- a/irods/helpers/__init__.py +++ b/irods/helpers/__init__.py @@ -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 +from irods.message import ET, XML_Parser_Type, _IRODS_VERSION from irods.path import iRODSPath from irods.session import iRODSSession @@ -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}, " diff --git a/irods/message/__init__.py b/irods/message/__init__.py index 9b8e0ec80..89da492b2 100644 --- a/irods/message/__init__.py +++ b/irods/message/__init__.py @@ -181,7 +181,7 @@ def ET(xml_type=(), server_version=None): logger = logging.getLogger(__name__) -IRODS_VERSION = (5, 0, 2, "d") +_IRODS_VERSION = (5, 0, 2, "d") UNICODE = str @@ -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() diff --git a/irods/test/helpers.py b/irods/test/helpers.py index 8b92738fb..4cca53cdb 100644 --- a/irods/test/helpers.py +++ b/irods/test/helpers.py @@ -20,7 +20,7 @@ from irods.helpers import ( home_collection, make_session as _irods_helpers_make_session) -from irods.message import iRODSMessage, IRODS_VERSION +from irods.message import iRODSMessage from irods.password_obfuscation import encode import irods.rule from irods.session import iRODSSession From 6e5d6c21dee2d9d91c4f2118d07cdf612a6a1604 Mon Sep 17 00:00:00 2001 From: d-w-moore Date: Thu, 8 Jan 2026 02:14:05 -0500 Subject: [PATCH 2/4] comments to explain _IRODS_VERSION --- irods/helpers/__init__.py | 3 +++ irods/message/__init__.py | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/irods/helpers/__init__.py b/irods/helpers/__init__.py index 0de7fd2c9..8eb432cb1 100644 --- a/irods/helpers/__init__.py +++ b/irods/helpers/__init__.py @@ -54,6 +54,9 @@ def make_session(test_server_version=False, **kwargs): env_file = env_filename_from_keyword_args(kwargs) session = iRODSSession(irods_env_file=env_file, **kwargs) + # irods.test.helpers version of this function sets test_server_version True by default, so + # that sessions generated for the test methods will abort on connecting with a server that + # is too recent. This is a way to ensure that tests don't fail due to a server mismatch. if test_server_version: connected_version = _get_server_version_for_test(session, curtail_length=3) advertised_version = _IRODS_VERSION[:3] diff --git a/irods/message/__init__.py b/irods/message/__init__.py index 89da492b2..c0f9deb75 100644 --- a/irods/message/__init__.py +++ b/irods/message/__init__.py @@ -181,6 +181,10 @@ def ET(xml_type=(), server_version=None): logger = logging.getLogger(__name__) +# Advertised server version compatibility. More recent servers are not guaranteed to work. +# We avail ourselves of this macro in running tests to abort if the session has connected +# to a server that is too new. + _IRODS_VERSION = (5, 0, 2, "d") UNICODE = str From 579e66482e0b4105b94a94c75eebd6c5e0fb6130 Mon Sep 17 00:00:00 2001 From: d-w-moore Date: Fri, 20 Feb 2026 05:18:38 -0500 Subject: [PATCH 3/4] explanation - aliased symbol w/o underline --- irods/message/__init__.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/irods/message/__init__.py b/irods/message/__init__.py index c0f9deb75..cccf49f59 100644 --- a/irods/message/__init__.py +++ b/irods/message/__init__.py @@ -187,6 +187,10 @@ def ET(xml_type=(), server_version=None): _IRODS_VERSION = (5, 0, 2, "d") +# This alias exists as a backward-compatible duplicate, but it is slated for deprecation. +# The symbol is for internal use in testing only, so it should be prefixed with an underline. +IRODS_VERSION = _IRODS_VERSION + UNICODE = str _METADATA_FIELD_TYPES = {str, UNICODE, bytes} From 94631f9100f39ff6a9cdec9fb7e4168aa557f2b8 Mon Sep 17 00:00:00 2001 From: d-w-moore Date: Fri, 20 Feb 2026 05:30:43 -0500 Subject: [PATCH 4/4] trailing whitespace --- irods/message/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/irods/message/__init__.py b/irods/message/__init__.py index cccf49f59..b8d63798c 100644 --- a/irods/message/__init__.py +++ b/irods/message/__init__.py @@ -182,7 +182,7 @@ def ET(xml_type=(), server_version=None): logger = logging.getLogger(__name__) # Advertised server version compatibility. More recent servers are not guaranteed to work. -# We avail ourselves of this macro in running tests to abort if the session has connected +# We avail ourselves of this macro in running tests to abort if the session has connected # to a server that is too new. _IRODS_VERSION = (5, 0, 2, "d")