Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. #18259

avallbona · 2024-06-08T18:44:50Z

Fixed TICKET-22712 - Consider not using built-in functions as parameters.

Trac ticket number

Branch description

Replaced the name that shadows the builtin funcion all and replaced by fetch_all. I'm not sure if we need the changes to be backwards compatible.

Checklist

This PR targets the main branch.
The commit message is written in past tense, mentions the ticket number, and ends with a period.
I have checked the "Has patch" ticket flag in the Trac system.
I have added or updated relevant tests.
I have added or updated relevant docs, including release notes if applicable.
I have attached screenshots in both light and dark modes for any UI changes. (N/A)

EnriqueSoria · 2024-06-12T18:02:06Z

django/contrib/staticfiles/finders.py

@@ -113,17 +113,22 @@ def check(self, **kwargs):
                )
        return errors

-    def find(self, path, all=False):
+    def find(self, path, fetch_all=False, **kwargs):


I'm not familiarized in how deprecations are handled in python/django, but I think that adding **kwargs is overkill. Maybe add something like:

def find(self, path, fetch_all=False, all=None): if all is not None: # TODO: Add a warning or something fetch_all = all

This sadly doesn't fix shadowing all, but by adding a deprecation warning it will allow us to remove it in future versions.

Maybe someone can give us some advice on how to handle this?

Thanks for the feedback @EnriqueSoria. As per your suggestion I've added the deprecations warnings for the use of the all param in 03b3b1f . On the other hand, I don't see why the use of **kwargs is an overkill in this case. I think it fits the case, removing the shadowing of the builtin all function and at the same time avoiding the errors for third party packages that may use or extend the existing finders API. I think using **kwargs provide us the flexibility we need to keep the backwards compatibility.

When using a function that has **kwargs you don't know which parameters it does accept. That's why I dislike using it.

But I guess in this case is worth.

Using **kwargs has the undesired side effect of allowing for arbitrary named arguments and the silently ignoring them. This is something that we should avoid so I see two options:

Continue using all for the deprecation period, is not that terrible since we have already done so for the last 10+ years.

Change to use **kwargs but then we should check that no other named param was given and raise the corresponding TypeError.

I think 1 is the best option, so I would suggest to go down that path.

@avallbona The comment above is what I was referring in the global comment.

Sorry I missed this comment 😬 . I'm not sure I like the option 1, we don't solve the problem right away and we pospone the solution to a future version, but I think it's clearer on what params the method accepts.

I'll fix it.

@nessita Addressed the issue in eacad93

nessita

Thank you @avallbona for this work! It looks good 🌟

I have added some comments and I also think that we should include release notes in the 5.2.txt file, under the section Features deprecated in 5.2. Something like:

* The ``all`` argument for the ``django.contrib.staticfiles.find()`` function
  is deprecated in favor of the ``find_all`` argument.

nessita · 2024-06-20T16:36:57Z

django/contrib/staticfiles/finders.py

@@ -113,17 +113,22 @@ def check(self, **kwargs):
                )
        return errors

-    def find(self, path, all=False):
+    def find(self, path, fetch_all=False, **kwargs):


Using **kwargs has the undesired side effect of allowing for arbitrary named arguments and the silently ignoring them. This is something that we should avoid so I see two options:

Continue using all for the deprecation period, is not that terrible since we have already done so for the last 10+ years.

Change to use **kwargs but then we should check that no other named param was given and raise the corresponding TypeError.

I think 1 is the best option, so I would suggest to go down that path.

django/contrib/staticfiles/finders.py

avallbona · 2024-06-20T21:44:56Z

Thank you @avallbona for this work! It looks good 🌟

I have added some comments and I also think that we should include release notes in the 5.2.txt file, under the section Features deprecated in 5.2. Something like:
* The ``all`` argument for the ``django.contrib.staticfiles.find()`` function
  is deprecated in favor of the ``find_all`` argument.

Addressed the comments in 704fdb9 Thanks for the feedback 🙇🏿‍♂️

nessita · 2024-06-21T20:10:54Z

Thank you @avallbona for the param rename! Looks great.

Did you see my comment about kwargs? Would you have some time to do some follow up with that?

avallbona · 2024-06-21T21:52:31Z

Thank you @avallbona for the param rename! Looks great.

Did you see my comment about kwargs? Would you have some time to do some follow up with that?

I've answered in the comment about kwargs. Thanks for the feedback 🙇🏿‍♂️

…in order to avoid shadowing the builtin function **all**.

… warning message

…l to find_all. Add the deprecation warning in the 5.2 release notes.

EnriqueSoria · 2024-06-22T12:43:10Z

django/contrib/staticfiles/finders.py

+            warnings.warn(
+                DEPRECATION_WARNING_MSG, RemovedInDjango60Warning, stacklevel=2
+            )
+            find_all = all


What about deleting all symbol? That way we don't have it shadowed anymore

Suggested change

find_all = all

find_all = all

del all

Maybe it's a bit tricky, but it does the job:

>>> all = 3 >>> find_all = 3 >>> all([1,0,1]) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: 'int' object is not callable >>> del all >>> all([1,0,1]) False >>> find_all 3

avallbona force-pushed the ticket-22712 branch 2 times, most recently from d3338d7 to 5d3e09b Compare June 8, 2024 18:50

avallbona changed the title ~~Fixed TICKET-22712 - Consider not using built-in functions as parameters.~~ TICKET-22712 - Renamed the param name from **all** to **fetch_all**, in order to avoid shadowing the builtin function **all**. Jun 8, 2024

avallbona changed the title ~~TICKET-22712 - Renamed the param name from **all** to **fetch_all**, in order to avoid shadowing the builtin function **all**.~~ TICKET-22712 - Consider not using built-in functions as parameters Jun 8, 2024

nessita added the DjangoCon Europe 🏰 label Jun 8, 2024

avallbona force-pushed the ticket-22712 branch 5 times, most recently from 4a27321 to eabedf1 Compare June 10, 2024 22:24

avallbona marked this pull request as ready for review June 11, 2024 06:49

EnriqueSoria reviewed Jun 12, 2024

View reviewed changes

avallbona requested a review from EnriqueSoria June 12, 2024 19:11

EnriqueSoria approved these changes Jun 13, 2024

View reviewed changes

nessita changed the title ~~TICKET-22712 - Consider not using built-in functions as parameters~~ Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. Jun 20, 2024

nessita reviewed Jun 20, 2024

View reviewed changes

avallbona force-pushed the ticket-22712 branch from e0921c0 to 704fdb9 Compare June 20, 2024 21:41

avallbona requested a review from nessita June 20, 2024 21:45

avallbona added 5 commits June 22, 2024 00:03

TICKET-22712 - Renamed the param name from **all** to **fetch_all**, …

175ff41

…in order to avoid shadowing the builtin function **all**.

TICKET-22712 - Code review fixes. Added deprecation warnings

3d43374

TICKET-22712 - Small refactor. Created const to store the deprecation…

2ad5f8d

… warning message

TICKET-22712 - Code review fixes (II). Changed the param name from al…

f9dd6ca

…l to find_all. Add the deprecation warning in the 5.2 release notes.

TICKET-22712 - Code reviews fixes (III). Removed the use of kwargs.

eacad93

avallbona force-pushed the ticket-22712 branch from 704fdb9 to eacad93 Compare June 21, 2024 22:04

EnriqueSoria reviewed Jun 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. #18259

Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. #18259

avallbona commented Jun 8, 2024 •

edited

Loading

EnriqueSoria Jun 12, 2024

avallbona Jun 12, 2024 •

edited

Loading

EnriqueSoria Jun 13, 2024

nessita Jun 20, 2024

nessita Jun 21, 2024

avallbona Jun 21, 2024 •

edited

Loading

avallbona Jun 21, 2024

nessita left a comment

nessita Jun 20, 2024

avallbona commented Jun 20, 2024

nessita commented Jun 21, 2024

avallbona commented Jun 21, 2024

EnriqueSoria Jun 22, 2024

Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. #18259

Are you sure you want to change the base?

Fixed #22712 -- Avoided name shadowing of "all" in findstatic command. #18259

Conversation

avallbona commented Jun 8, 2024 • edited Loading

Trac ticket number

Branch description

Checklist

EnriqueSoria Jun 12, 2024

Choose a reason for hiding this comment

avallbona Jun 12, 2024 • edited Loading

Choose a reason for hiding this comment

EnriqueSoria Jun 13, 2024

Choose a reason for hiding this comment

nessita Jun 20, 2024

Choose a reason for hiding this comment

nessita Jun 21, 2024

Choose a reason for hiding this comment

avallbona Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

avallbona Jun 21, 2024

Choose a reason for hiding this comment

nessita left a comment

Choose a reason for hiding this comment

nessita Jun 20, 2024

Choose a reason for hiding this comment

avallbona commented Jun 20, 2024

nessita commented Jun 21, 2024

avallbona commented Jun 21, 2024

EnriqueSoria Jun 22, 2024

Choose a reason for hiding this comment

avallbona commented Jun 8, 2024 •

edited

Loading

avallbona Jun 12, 2024 •

edited

Loading

avallbona Jun 21, 2024 •

edited

Loading