python-irodsclient icon indicating copy to clipboard operation
python-irodsclient copied to clipboard

Remove deprecated symbols: iRODSUserGroup, UserGroup, UserGroupDoesNotExist, UserGroupManager, user_groups

Open paulborgermans opened this issue 2 years ago • 8 comments

I am not against doing the BC break, but I think there should be a clear warning in the docs there is a BC break ... or a deprecation notice and still keep (iRODS)UserGroup a reference to (iRODS)Group (which I am using right now to deal with different PRC versions).

paulborgermans avatar Mar 26 '23 21:03 paulborgermans

Is this already broken?

Did we miss considering this during https://github.com/irods/python-irodsclient/issues/429?

trel avatar Mar 27 '23 14:03 trel

@paulborgermans - The name change shouldn't be a BC as iRODSUserGroup is now an alias for iRODSGroup. Please inform us if we've missed something, however.

We'll make sure there's a deprecation notice in the release notes. No sense in confusing people unnecessarily!

d-w-moore avatar Mar 27 '23 14:03 d-w-moore

I don't think this breaks existing code unless it depends on double underscore values?

d-w-moore avatar Mar 27 '23 14:03 d-w-moore

I don't think this breaks existing code unless it depends on double underscore values?

Or representation strings, possibly. @paulborgermans - Is there some specific code you could point us to, that displays the breaking change?

d-w-moore avatar Mar 27 '23 15:03 d-w-moore

Ah, I think I see. The request at the heart of this issue is that we keep the iRODSUserGroup alias around to avoid breaking existing code in the future.

(@paulborgermans - Please correct me if mistaken.)

d-w-moore avatar Mar 27 '23 19:03 d-w-moore

Yes, so existing code can still work until we get through the proper 'deprecation' and then 'removal' stages...

trel avatar Mar 27 '23 19:03 trel

Ah, I think I see. The request at the heart of this issue is that we keep the iRODSUserGroup alias around to avoid breaking existing code in the future.

(@paulborgermans - Please correct me if mistaken.)

Yes exactly. And also UserGroup (using the model in a few queries).

Btw I install currently python-irodsclient directly from github, hence I encountered this early before the official 1.1.7 release

its quite stable so far, frozen at the commit that was latest during the we…. Gonna take it to production by Thursday unless 1.1.7 is cut by then

paulborgermans avatar Mar 27 '23 20:03 paulborgermans

We understand the currently defined aliases will not break existing code (the new classes only provide additional functionality).

The deprecations will be declared as part of 1.1.7.

We are going to rename this issue to cover the decision about when to remove the deprecated/old classes.

trel avatar Mar 28 '23 16:03 trel