Deprecate nonstandard behavior of a dumbdbm database

[serhiy-storchaka]

BPO	21708
Nosy	@rhettinger, @bitdancer, @PCManticore, @serhiy-storchaka
Files	dbm_dumb_deprecations.patch dbm_dumb_deprecations2.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/serhiy-storchaka'
closed_at = <Date 2016-07-17.08:38:20.164>
created_at = <Date 2014-06-10.18:31:22.211>
labels = ['type-feature', 'library']
title = 'Deprecate nonstandard behavior of a dumbdbm database'
updated_at = <Date 2016-07-17.08:38:20.163>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2016-07-17.08:38:20.163>
actor = 'serhiy.storchaka'
assignee = 'serhiy.storchaka'
closed = True
closed_date = <Date 2016-07-17.08:38:20.164>
closer = 'serhiy.storchaka'
components = ['Library (Lib)']
creation = <Date 2014-06-10.18:31:22.211>
creator = 'serhiy.storchaka'
dependencies = []
files = ['35558', '43477']
hgrepos = []
issue_num = 21708
keywords = ['patch']
message_count = 9.0
messages = ['220185', '221212', '221448', '221490', '221500', '221521', '242965', '268874', '269873']
nosy_count = 5.0
nosy_names = ['rhettinger', 'r.david.murray', 'Claudiu.Popa', 'python-dev', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21708'
versions = ['Python 3.6']

[serhiy-storchaka]

Unlike to other dbm implementations, a dumpdbm database is always opened for update, and will be created if it does not exist. We can fix this discrepancy and implement common behavior for 'r' and 'w' modes, but this will change current behavior and some deprecation period is needed.

Here is a patch (based on patch by Claudiu Popa, submitted in bpo-18039), which adds deprecation warnings for cases when current behavior differs from desired: invalid values for the flag parameter (will raise ValueError in future), opening non-existing database in 'r' or 'w' mode (will raise dbm.dumb.error), modifying a database opened for reading only (will raise dbm.dumb.error).

This patch needs approving by other core developer.

[rhettinger]

The core idea is reasonable.

The patch overreaches by adding readonly warnings to __setitem__ and __delitem__ which will spew-out on every call (these could be ignored or set to warn once by the user but that is PITA).

Minor nit. We have a little PEP-8 overkill on the string splits:

+ with self.assertWarnsRegex(DeprecationWarning,
+ "The database file is missing, the "
+ "semantics of the 'c' flag will "
+ "be used."):

[serhiy-storchaka]

Thanks Raymond for your attention.

Readonly warnings are emitted only when dumpdbm database opened in read only mode. They will be turned into exceptions in future (3.6 or 3.7). Annoying warnings on changed in future operations is desirable effect.

If you worry about performance hit of such checks, __setitem__ and __delitem__ are expensive operations doing file I/O.

[rhettinger]

I'm not worries about the performance. I think the warnings and checks don't need to be there are all (API creep). AFAICT, this has never been requested or needed in the entire history of the dumbdbm.

Your original goal of changing the default update mode is worthwhile.

[bitdancer]

The point is to make the API consistent. So if the other dbm modules raise an error when __setitem__/delitem are called on an R/O db, then the warnings are appropriate (but should mention that this will be an error in the future).

The warnings will only be printed once per run of python, unless I'm completely misremembering how deprecation warnings work.

[rhettinger]

Feel free to ignore my advice and make unnecessary changes to a very old, stable API.

[serhiy-storchaka]

Warnings are not raised by default. They are raised only when the database is opened with the 'r' mode and then modified.

The earlier we start deprecation period, the earlier we could add true "read-only" and "update existing" modes to dbm.dumb.

[serhiy-storchaka]

Patch updated. Added What's New entry.

We already lost 2 years and the 3.5 release. I don't want to lost 3.6 too.