[Django] #28805: Provide a new database function for RegexpReplace
Django
-------------------------------------+-------------------------------------
Reporter: Joey | Owner: nobody
Wilhelm |
Type: New | Status: new
feature |
Component: Database | Version: master
layer (models, ORM) |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
I've created a database function in my own project to utilize
`REGEXP_REPLACE`, and wanted to contribute it upstream. At a quick glance,
it appears that this is only available on PostgreSQL and Oracle. So my
main question would be, which route would be preferable for inclusion?
Should this be added to the PostgreSQL-specific code and let Oracle
languish, or would this require the addition of a new feature flag on
database backends?
With the former implementation, I have code ready to go. The latter, I
would definitely want some guidance.
This is of course all assuming that this feature is desired.
Here is an example usage:
{{{#!python
MyModel.objects.annotate(no_letters=RegexpReplace(F('name'), r'[A-Za-z]+',
''))
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28805>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
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
-------------------------------------+-------------------------------------
Comment (by Matthew Schinckel):
Personally, I'd create it in the {{{django.contrib.postgres}}} section:
there are already other functions in there that you should be able to look
at how they are written.
The other alternative is to put it in
{{{django.db.models.functions.text}}}, but I'm not sure how to flag that
it only works on specific backends there.
You might want to bring this up on the django-developers list, as that
sometimes gets a bit more notice.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:1>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Matthew Schinckel):
Oh, it is worth pointing out that this is something that should be easy to
package up in a reusable manner, since it (probably) won't require any
changes, just the addition of a new class.
That class could then be imported from anywhere.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:2>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Joey Wilhelm):
Yeah, I was debating the thought of creating some sort of `django-
postgres-regex` package, for this and related functions. But if I could
contribute it to core, why not, ya know?
The implementation relatively easy; I based it off, I believe, Substr.
{{{#!python
from django.db.models import Func, Value
class RegexpReplace(Func):
function = 'REGEXP_REPLACE'
def __init__(self, expression, pattern, replacement, **extra):
if not hasattr(pattern, 'resolve_expression'):
if not isinstance(pattern, str):
raise TypeError("'pattern' must be a string")
pattern = Value(pattern)
if not hasattr(replacement, 'resolve_expression'):
if not isinstance(replacement, str):
raise TypeError("'replacement' must be a string")
replacement = Value(replacement)
expressions = [expression, pattern, replacement]
super().__init__(*expressions, **extra)
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Unreviewed => Accepted
Comment:
For a mergable patch, I think we would want both Oracle and PostgreSQL
support.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Sardorbek Imomaliev (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Oskar Persson (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => assigned
* needs_better_patch: 0 => 1
* needs_tests: 0 => 1
* owner: nobody => Nick Pope
* needs_docs: 0 => 1
* has_patch: 0 => 1
Comment:
I have a WIP [https://github.com/django/django/pull/12438 PR].
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
* needs_tests: 1 => 0
* needs_docs: 1 => 0
Comment:
I've updated the [https://github.com/django/django/pull/12438 PR] to add
support for `RegexpStrIndex`, `RegexpReplace`, and `RegexpSubstr`.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:11>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:12>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
Comment:
Moving back to PNI. Having a rethink on a few aspects of this patch.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:13>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
You can also remove code for MySQL <= 8.0.4.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:14>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Nick Pope):
Replying to [comment:14 Mariusz Felisiak]:
> You can also remove code for MySQL <= 8.0.4.
Yup. Already done in what I'm working on.
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:15>
Django
-------------------------------------+-------------------------------------
Reporter: Joey Wilhelm | Owner: Nick Pope
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Oskar Persson (removed)
--
Ticket URL: <https://code.djangoproject.com/ticket/28805#comment:16>