[Django] #23766: Documentation and tests for cursor.callproc()
Django
-------------------------------------+-------------------------------------
Reporter: shaib | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Database | Keywords:
layer (models, ORM) | Has patch: 0
Severity: Normal | Needs tests: 0
Triage Stage: | Easy pickings: 0
Unreviewed |
Needs documentation: 0 |
Patch needs improvement: 0 |
UI/UX: 0 |
-------------------------------------+-------------------------------------
This is a spin off #23546 -- actually, a requirement for that ticket.
Quoting my [https://groups.google.com/d/msg/django-
developers/v3AhQhJFhGM/TScISVjLBQoJ message] to -developers on the subject
(the thread trails off to discussions of higher-level interfaces, but the
following seems to be in consensus):
For a very long time -- as far as I'm aware, forever -- we've had, in our
cursor classes, a `callproc()` method that follows the `callproc()`
definition of [http://legacy.python.org/dev/peps/pep-0249/#callproc
pep249]; this allows database stored procedures to be called.
Recently [...] we found that
1. `cursor.callproc()` is not documented
2. `cursor.callproc()` is not tested (except for one Oracle-specific
test that uses it to test something else)
Which means, essentially, that it is treated as an intenal API.
I see no reason that we shouldn't make it public.
--
Ticket URL: <https://code.djangoproject.com/ticket/23766>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: shaib | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
(models, ORM) | Triage Stage: Accepted
Severity: Normal | Needs documentation: 0
Keywords: | Patch needs improvement: 0
Has patch: 0 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by manfre):
* stage: Unreviewed => Accepted
Comment:
Agreed. This should be documented and tested.
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:1>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
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 felixxm):
* status: new => assigned
* owner: nobody => felixxm
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
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 felixxm):
I would like to resolve this issue, but it seems that we don't have
appropriate place for `cursor.callproc` in the documentation. Any
suggestions?
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
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 Tim Graham):
Perhaps near the [https://docs.djangoproject.com/en/dev/topics/db/sql
/#connections-and-cursors Connections and cursors] section? Anyway,
getting a draft of the content is most of the work; it can be moved if
needed.
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:4>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
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 GitHub <noreply@…>):
In [changeset:"3189a93cebbd5d8fbda8f251786918820156acec" 3189a93c]:
{{{
#!CommitTicketReference repository=""
revision="3189a93cebbd5d8fbda8f251786918820156acec"
Refs #23766 -- Added tests for CursorWrapper.callproc().
Thanks Tim Graham for the review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:5>
Django
-------------------------------------+-------------------------------------
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"660d50805b6788d592b4f1fae706b725baf0195c" 660d5080]:
{{{
#!CommitTicketReference repository=""
revision="660d50805b6788d592b4f1fae706b725baf0195c"
Fixed #23766 -- Doc'd CursorWrapper.callproc().
Thanks Tim Graham for the review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:6>
Django
-------------------------------------+-------------------------------------
Type: | Status: closed
Cleanup/optimization |
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution: fixed
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 Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"fe51017efdc3f26c94c83fe5930b14d71e1bb380" fe51017e]:
{{{
#!CommitTicketReference repository=""
revision="fe51017efdc3f26c94c83fe5930b14d71e1bb380"
[1.11.x] Fixed #23766 -- Doc'd CursorWrapper.callproc().
Thanks Tim Graham for the review.
Backport of 660d50805b6788d592b4f1fae706b725baf0195c from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/23766#comment:7>