[Django] #37070: Add .clear_messages() method to django.contrib.messages

[Django]

#37070: Add .clear_messages() method to django.contrib.messages
----------------------------+--------------------------------------------
Reporter: benjaoming | Type: New feature
Status: new | Component: contrib.messages
Version: | Severity: Normal
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------+--------------------------------------------
Disclaimer: This is really a minor issue 😊

We can do:

```
from django.contrib.messages import get_messages
```

And then we can call `get_messages()` - and if we iterate over them, they
will be cleared.

But we can't explicitly clear them because this method doesn't exist:

```
from django.contrib.messages import clear_messages
```

For me, the use-case was test-related: Writing an e2e test case that calls
some views and at each step verified messages, then cleared them.

Not sure if adding the method would make people use the messages framework
wrongly, but I think it makes sense to note that ADDING `clear_messages`
to the mix might make some people think you need to call it... which in
most cases, you don't, and therefore the documentation needs to be
''clear'' (pun intended).

Forum discussion: https://forum.djangoproject.com/t/why-isnt-it-easier-to-
clear-messages/5727/7
--
Ticket URL: <https://code.djangoproject.com/ticket/37070>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#37070: Add .clear_messages() method to django.contrib.messages

----------------------------------+--------------------------------------
Reporter: benjaoming | Owner: (none)

Type: New feature | Status: new

Component: contrib.messages | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

----------------------------------+--------------------------------------
Changes (by Sarah Boyce):

* version: => dev


Old description:

> Disclaimer: This is really a minor issue 😊
>
> We can do:
>
> ```
> from django.contrib.messages import get_messages
> ```
>
> And then we can call `get_messages()` - and if we iterate over them, they
> will be cleared.
>
> But we can't explicitly clear them because this method doesn't exist:
>
> ```
> from django.contrib.messages import clear_messages
> ```
>
> For me, the use-case was test-related: Writing an e2e test case that
> calls some views and at each step verified messages, then cleared them.
>
> Not sure if adding the method would make people use the messages
> framework wrongly, but I think it makes sense to note that ADDING
> `clear_messages` to the mix might make some people think you need to call
> it... which in most cases, you don't, and therefore the documentation
> needs to be ''clear'' (pun intended).
>
> Forum discussion: https://forum.djangoproject.com/t/why-isnt-it-easier-
> to-clear-messages/5727/7

New description:

Disclaimer: This is really a minor issue 😊

We can do:

{{{
from django.contrib.messages import get_messages
}}}

And then we can call `get_messages()` - and if we iterate over them, they
will be cleared.

But we can't explicitly clear them because this method doesn't exist:

{{{
from django.contrib.messages import clear_messages
}}}

For me, the use-case was test-related: Writing an e2e test case that calls
some views and at each step verified messages, then cleared them.

Not sure if adding the method would make people use the messages framework
wrongly, but I think it makes sense to note that ADDING `clear_messages`
to the mix might make some people think you need to call it... which in
most cases, you don't, and therefore the documentation needs to be
''clear'' (pun intended).

Forum discussion: https://forum.djangoproject.com/t/why-isnt-it-easier-to-
clear-messages/5727/7

--

--
Ticket URL: <https://code.djangoproject.com/ticket/37070#comment:1>

[Django]

#37070: Add .clear_messages() method to django.contrib.messages
----------------------------------+------------------------------------

Reporter: benjaoming | Owner: (none)
Type: New feature | Status: new
Component: contrib.messages | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------------+------------------------------------

Changes (by Sarah Boyce):

* stage: Unreviewed => Accepted

Comment:

Accepting without requesting this be added to the new features board as
this is based off an existing older discussion with already a good
consensus that this is useful and a small addition
--
Ticket URL: <https://code.djangoproject.com/ticket/37070#comment:2>

[Django]

#37070: Add .clear_messages() method to django.contrib.messages
----------------------------------+------------------------------------
Reporter: benjaoming | Owner: (none)
Type: New feature | Status: new
Component: contrib.messages | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------------+------------------------------------

Comment (by Natalia Bidart):

My only request would be to name this consistently with how we reset the
queries:

{{{#!pycon
>>> from django.db import connection, reset_queries
>>> connection.queries
[]
>>> reset_queries()
>>>
}}}

Therefore I think the function should be called `reset_messages()`.
--
Ticket URL: <https://code.djangoproject.com/ticket/37070#comment:3>