Skip to content

Fix subquerload deprecation #11180

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.

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
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jvanasco
Copy link
Member

Change-Id: I3d1b844dee6dc29da4a6aaa0c2916e6a1178aaec

The deprecation info does not appear in 3 important sections:

  • The initial overview
  • API docstrings in 2 places.

This PR notes the deprecation in the overview, and adds links/deprecation docstrings to the functions so they should show up in the API docs.

Description

Checklist

This pull request is:

  • A documentation / typographical / small typing error fix
    • Good to go, no issue or tests are needed
  • A short code fix
    • please include the issue number, and create an issue if none exists, which
      must include a complete example of the issue. one line code fixes without an
      issue and demonstration will not be accepted.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests. one line code fixes without tests will not be accepted.
  • A new feature implementation
    • please include the issue number, and create an issue if none exists, which must
      include a complete example of how the feature would look.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests.

Have a nice day!

Change-Id: I3d1b844dee6dc29da4a6aaa0c2916e6a1178aaec
Change-Id: Id23713cb4c00fa25f8ac99b5b87259dd1e7ac56d
@CaselIT CaselIT requested a review from zzzeek March 20, 2024 18:12
@zzzeek
Copy link
Member

zzzeek commented Nov 19, 2024

im actually not on board deprecating subquery eager loading right now. It's "legacy" for sure but i dont want to be that aggressive about it

@CaselIT
Copy link
Member

CaselIT commented Nov 19, 2024

Maybe we can just be more clear in labelling it as legacy?

@jvanasco
Copy link
Member Author

Six months ago I would agree with you, but with the pace of SQLAlchemy changes and newer alternatives to sub query loading, I think it would be wise to mark this as deprecated and emit warnings now.

It could enjoy an extra long deprecation period and even possibly never be removed due to its importance in legacy applications - but I think signaling to users “hey, this is deprecated and you should update your code” is important.

iirc, it complicated typing some statements, and migrating to newer code resolved that.

@zzzeek
Copy link
Member

zzzeek commented Nov 19, 2024

when you deprecate and especially when you add warnings, people make a big deal out of getting off that API.

which here wouldnt be necessarily a bad thing. but subqueryload is really entrenched and it would be a bit of a panic, which is a bit in conflict with my desire for 2.1 to be a very easy upgrade for people. for example adding this warning will greatly slow down openstack's adoption of 2.1.

@CaselIT
Copy link
Member

CaselIT commented Nov 19, 2024

maybe a compromise could be that we write that it's very legacy in 2.1 and we are considering deprecating it in a future release and that new code should not use it and existing code should consider moving to a different loader.
We could have do the no-load treatment, removing it from the global list of loader options

@zzzeek
Copy link
Member

zzzeek commented Nov 19, 2024

maybe a compromise could be that we write that it's very legacy in 2.1 and we are considering deprecating it in a future release and that new code should not use it and existing code should consider moving to a different loader. We could have do the no-load treatment, removing it from the global list of loader options

yah that's what "legacy" is

@zzzeek
Copy link
Member

zzzeek commented Nov 19, 2024

@CaselIT
Copy link
Member

CaselIT commented Nov 19, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy