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

Jump to bottom

[FEATURE REQUEST] Deprecate the `utils` dunder. #62191

Open

s0undt3ch opened this issue Jun 17, 2022 · 3 comments

Labels

Deprecation Feature

Milestone

Chlorine v3007.0

Collaborator

s0undt3ch commented Jun 17, 2022

Is your feature request related to a problem? Please describe.

The __utils__ dunder(salt loader) tries to provide easy access to Salt's utility modules.

Issues with this approach:

Utility functions should not be available in dunders, they are utility functions.
All utilities are compacted into <module>.<funcname>, which does not recurse into submodules.
This kind of usage, is prone to memory leaks(because utilities were not coded to work within a salt loader context). See fix memory leak in utils/jinja.py #62007 and fix yamlloader.DuplicateKeyWarning leaking #62021

Potential problems if we remove __utils__:

Utility functions aren't available in jinja templating for salt states.
- They shouldn't, jinja uses it's own filters and Salt provides additional filters

Describe the solution you'd like
Completely remove support for __utils__

Describe alternatives you've considered
None.

The text was updated successfully, but these errors were encountered:

s0undt3ch added Feature needs-triage labels

s0undt3ch added this to the Sulphur v3006.0 milestone

Contributor

OrangeDog commented Jun 21, 2022

If it's being removed in 3006 then it needs to be deprecated in 3005.

s0undt3ch mentioned this issue

[WIP] Deprecate and remove __utils__ usage #62208

Closed

Contributor

OrangeDog commented Jun 23, 2022

There's a SEP for this: saltstack/salt-enhancement-proposals#66

Collaborator Author

s0undt3ch commented Jun 23, 2022

If it's being removed in 3006 then it needs to be deprecated in 3005.

The deprecation period, sadly, needs to be longer.

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Deprecate and remove __utils__ usage.

ea0d1bb

Implementation of saltstack/salt-enhancement-proposals#66

Fixes saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Add a deprecated decorator, specifically to deprecate ``__utils__…

011cacd

…`` loader usage.

Refs saltstack#62191
Fixes saltstack#62222

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added the Deprecation label

s0undt3ch removed the needs-triage label

garethgreenaway modified the milestones: Sulphur v3006.0, Chlorine v3007.0

garethgreenaway added the Chlorine v3007.0 label

waynew removed the Chlorine v3007.0 label

Ch3LL modified the milestones: Chlorine v3007.0, Argon v3008

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

a7f30d5

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch mentioned this issue

[master] Stop loading utils modules into __utils__ if they don't define __virtual__ #64425

Open

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

b377417

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

95beaef

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

231db54

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

5cae008

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

dd1e5dc

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

cb0d0b2

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

4a5e9af

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

325e4de

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

42e717e

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

d66aa00

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

1438d2b

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

2812a33

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

305bb4a

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

166eb60

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

6c87383

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

71a8930

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

e2b32b6

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

28b801b

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

50e815a

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

f9a64e6

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

33d51c9

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

b023a7d

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

90e3d9f

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

0dbc986

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

63ec7d2

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

56dc34c

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

bccf760

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

fb0767d

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

6da5967

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

af524c0

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

f26259c

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

b5eab45

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

a7b7736

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

3dda5c3

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop loading utils modules into __utils__ if they don't define `__v…

d849714

…irtual__`

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

s0undt3ch added a commit to s0undt3ch/salt that referenced this issue


          Stop using __utils__ in salt/grains/zfs.py

2f57433

Refs saltstack#62191

Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment