bpo-16379: expose SQLite error codes and error names in `sqlite3` by erlend-aasland · Pull Request #27786 · python/cpython

erlend-aasland · 2021-08-16T18:48:56Z

Original PR: GH-1108 (contributed by @palaviv, based on patches by @danielshahaf)

This PR is a rebase and rework of Aviv & Daniel's work.

Co-authored-by: Aviv Pavlivoda
Co-authored-by: Daniel Shahaf
Co-authored-by: Erlend E. Aasland

https://bugs.python.org/issue16379

- Naming: sqlite3ErrName => pysqlite_error_name - Error handling: * return NULL if no exception matched * receiver handles errors * don't use error table to store SQLITE_UNKNOWN string

- Use intermingled declarations - Simplify ref count handling

- Declutter add_error_constants() - No need to typedef struct - Simplify naming - Use PyModule_AddIntConstant

To avoid mismatch between char *name and constant

IMO, we should not pollute the SQLITE_* namespace

- Use correct attribute name - Normalise error variable naming - Remove 'Errno' from printed string to avoid confusion

- Use assertRaisesRegex iso. two assert functions - Normalise quotes - Test that constants are added to the module

…ability

erlend-aasland · 2021-08-16T18:49:38Z

cc. @nedbat

erlend-aasland · 2021-08-16T18:50:27Z

cc. @auvipy & @matrixise who reviewed the original PR.

erlend-aasland · 2021-08-19T08:17:06Z

FYI, I pushed a small tweak to the unit test: use the temp_dir helper iso. a hard coded path.

Thanks for reviewing, @auvipy

pablogsal · 2021-08-25T10:36:45Z

-int
-_pysqlite_seterror(pysqlite_state *state, sqlite3 *db)
+static PyObject *
+get_exception_class(pysqlite_state *state, int errorcode)


This is slighly confusing because normally returning NULL signifies an error. Could you please document this both on the call site and in this function? Otherwise the call site reads weirdly because
PyObject *exc_class = get_exception_class(state, errorcode); if (exc_class == NULL) { return errorcode; }
seems that is handling an error

Yes, I see now that it can be a bit confusing. I'll add a comment. Thanks!

Is it clearer with 3589a6a?
~~(FYI, I need to rebase onto main again bco. GH-26202)~~

erlend-aasland · 2021-08-25T12:54:53Z

~~I'll sync with main after #27942 is merged.~~ => synced with a3c45b6

pablogsal

LGTM.

Good work!

erlend-aasland · 2021-08-30T19:20:45Z

Thanks Pablo, and you can thank @danielshahaf & @palaviv for the good work; I just "stole" it, rebased onto main and made some minor adjustments :)

palavivand others added 29 commits May 9, 2019 12:54

sqlite3 module expose sqlite error code and name in exceptions
83ab267

Fix syntax error
eeb10f4

Add NEWS entry
42636f9

Update version
f224223

Fix whitespace
31467e3

Merge branch 'main' into sqlite-expose-error-code
679280d

Move exception documentation to the exceptions section
8aa0859

Use PyModule_AddObjectRef to add error codes
e4195c0

Refactor: add add_error_constants()
a4a0762

Sort error codes alphabetically
c18d227

Normalise style with the rest of the code base (PEP 7, etc.)
67e49e8

Improve "get error name" function
1893ced
- Naming: sqlite3ErrName => pysqlite_error_name - Error handling: * return NULL if no exception matched * receiver handles errors * don't use error table to store SQLITE_UNKNOWN string

Refactor _pysqlite_seterror changes
67ea5f2
- Use intermingled declarations - Simplify ref count handling

Refactor error code table
6ced38c
- Declutter add_error_constants() - No need to typedef struct - Simplify naming - Use PyModule_AddIntConstant

Use macro to create error table
467f7ba
To avoid mismatch between char *name and constant

Add missing SQLITE_NOTICE and SQLITE_WARNING codes
4abd093

Add comment
70507dd

Merge branch 'main' into sqlite-expose-error-code
b617192

Assert exception class is always set
db053b9

Use explicit API's iso. Py_BuildValue, etc.
98106dd

Remove duplicate return code entries
0567938

Group stuff
16889a1

Use 'unknown' when a proper SQLite exception cannot be found
a7a1cf8
IMO, we should not pollute the SQLITE_* namespace

Fix complete_statement.py example
772a29c
- Use correct attribute name - Normalise error variable naming - Remove 'Errno' from printed string to avoid confusion

Improve unit tests
fa5a1af
- Use assertRaisesRegex iso. two assert functions - Normalise quotes - Test that constants are added to the module

Adjust NEWS entry and update What's New
cf551b1

Use PyObject_SetAttrString iso. _PyObject_SetAttrId => slow path/read…
a3646c9
…ability

Refactor _pysqlite_seterror
8a49659

Link to sqlite.org/rescode.html iso. sqlite.org/c3ref/c_abort.html
8d11bc5

erlend-aasland requested a review from berkerpeksag as a code owner August 16, 2021 18:48

the-knights-who-say-ni added the CLA signed label Aug 16, 2021

bedevere-bot added the awaiting review label Aug 16, 2021

erlend-aasland requested a review from pablogsal August 16, 2021 19:15

auvipy approved these changes Aug 18, 2021
View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Aug 18, 2021

Use test.support.os_helper.temp_dir() in test_error_code_on_exception()
7a69798

shihai1991 approved these changes Aug 22, 2021
View reviewed changes

pablogsal reviewed Aug 25, 2021
View reviewed changes

Erlend E. Aasland added 2 commits August 25, 2021 12:58

Merge branch 'main' into sqlite-expose-error-code
b9a5a77

Address review: document get_exception_class() return value
3589a6a

Merge branch 'main' into sqlite-expose-error-code
a3c45b6

Spacetown reviewed Aug 26, 2021
View reviewed changes

Comment threadModules/_sqlite/module.c Outdated

Spacetown reviewed Aug 26, 2021
View reviewed changes

Comment threadModules/_sqlite/module.c Outdated

Address review: compare char ptr with NULL iso. 0
5a5683c

pablogsal approved these changes Aug 30, 2021
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Aug 30, 2021

pablogsal merged commit 86d8b46 into python:mainAug 30, 2021

bedevere-bot removed the awaiting merge label Aug 30, 2021

erlend-aasland deleted the sqlite-expose-error-code branch August 30, 2021 19:04

erlend-aasland mentioned this pull request Aug 30, 2021
bpo-16379: Expose sqlite error code #1108
Closed

erlend-aasland mentioned this pull request Oct 7, 2021
bpo-16379: Fix SQLite version checks in test_module_constants() #28809
Merged

Navigation Menu

Uh oh!

Uh oh!

bpo-16379: expose SQLite error codes and error names in `sqlite3` - #27786

bpo-16379: expose SQLite error codes and error names in `sqlite3`#27786
pablogsal merged 34 commits into
python:mainfrom
erlend-aasland:sqlite-expose-error-code

erlend-aasland commented Aug 16, 2021•
edited
Loading

Uh oh!

erlend-aasland commented Aug 16, 2021

Uh oh!

erlend-aasland commented Aug 16, 2021

Uh oh!

erlend-aasland commented Aug 19, 2021•
edited
Loading

Uh oh!

pablogsalAug 25, 2021

Uh oh!

erlend-aaslandAug 25, 2021

Uh oh!

erlend-aaslandAug 25, 2021•
edited
Loading

Uh oh!

erlend-aasland commented Aug 25, 2021•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

pablogsal left a comment

Uh oh!

erlend-aasland commented Aug 30, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Aug 16, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Aug 16, 2021

Uh oh!

erlend-aasland commented Aug 16, 2021

Uh oh!

erlend-aasland commented Aug 19, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pablogsalAug 25, 2021

Choose a reason for hiding this comment

Uh oh!

erlend-aaslandAug 25, 2021

Choose a reason for hiding this comment

Uh oh!

erlend-aaslandAug 25, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Aug 25, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pablogsal left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Aug 30, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

erlend-aasland commented Aug 16, 2021•
edited
Loading

erlend-aasland commented Aug 19, 2021•
edited
Loading

erlend-aaslandAug 25, 2021•
edited
Loading

erlend-aasland commented Aug 25, 2021•
edited
Loading