Cookie.Morsel interface needs update

[AstraLuma]

BPO	2211
Nosy	@loewis, @AstraLuma, @merwok, @abadger, @bitdancer, @berkerpeksag, @serhiy-storchaka, @demianbrecht
Files	issue2211.patch issue2211_1.patch issue2211_2.patch issue2211_3.patch issue2211_4.patch issue2211_5.patch issue2211_6.patch http_cookies_morsel_pickle.patch http_cookies_morsel_deprecate_set.patch http_cookies_morsel_deprecated_set_1.patch http_cookies_morsel_deprecated_set_2.patch http_cookies_morsel_deprecated_set_3.patch http_cookies_morsel_deprecated_set_4.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/bitdancer'
closed_at = <Date 2015-03-31.23:53:33.612>
created_at = <Date 2008-02-29.20:00:41.723>
labels = ['easy', 'type-bug', 'library']
title = 'Cookie.Morsel interface needs update'
updated_at = <Date 2015-04-01.13:34:25.470>
user = 'https://github.com/AstraLuma'

bugs.python.org fields:

activity = <Date 2015-04-01.13:34:25.470>
actor = 'r.david.murray'
assignee = 'r.david.murray'
closed = True
closed_date = <Date 2015-03-31.23:53:33.612>
closer = 'demian.brecht'
components = ['Library (Lib)']
creation = <Date 2008-02-29.20:00:41.723>
creator = 'AstraLuma'
dependencies = []
files = ['38170', '38410', '38432', '38466', '38476', '38509', '38524', '38540', '38584', '38688', '38690', '38695', '38729']
hgrepos = []
issue_num = 2211
keywords = ['patch', 'easy']
message_count = 46.0
messages = ['63144', '63149', '63329', '63331', '64203', '104581', '235691', '235696', '236180', '236181', '237428', '237664', '237824', '237856', '238299', '238331', '238387', '238389', '238395', '238401', '238448', '238456', '238565', '238603', '238616', '238684', '238923', '238924', '238925', '239259', '239260', '239262', '239269', '239272', '239286', '239521', '239522', '239523', '239606', '239615', '239616', '239617', '239623', '239672', '239765', '239807']
nosy_count = 11.0
nosy_names = ['loewis', 'jafo', 'AstraLuma', 'eric.araujo', 'a.badger', 'r.david.murray', 'BreamoreBoy', 'python-dev', 'berker.peksag', 'serhiy.storchaka', 'demian.brecht']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue2211'
versions = ['Python 3.5']

[AstraLuma]

Cookie.Morsel lacks in properly overloading dict methods, amongst other
things:

• .__eq__() does not take .key and .value into account
• .copy() returns a dict, not a Morsel
• .update() allows invalid attributes in, eg
  Morsel().update({'eggs':'spam'}) works but Morsel()['eggs'] = 'spam' fails
• .__len__() includes unset keys (why does it set them to an empty string?)
• .__repr__() doesn't print out attributes (path, comment, etc)
• Handling of unicode is fuzzy at best: try Morsel().set(u'eggs\u00bf',
  u'\u00f1', u'\00f1'.encode('utf-8'))
• Specifying the idmap and translate function in .set() seems wrong
• Setting .key doesn't check against invalid keys (eg, reserved names)
• The entire Morsel class is undocumented
• There is no way to automatically sync .value and .coded_value

[loewis]

Would you be interested to work on a patch?

[AstraLuma]

Sure, I'll do that.

[AstraLuma]

• Should be backwards compatible with people who actually use Morsel
• Didn't even attempt to document it
• Instead of having the Morsel dict being filled initially, unset
  attributes are, well, unset
• .key, .value, and .coded_value are now property()s
• .value is considered the actual value (eg, .coded_value is ignore for
  __eq__())

[jafo]

I'm going to push this to pending until you can get a patch. Thanks, Jamie.

[bitdancer]

This looks like it would be a worthwhile cleanup, and the issue contains useful info to that end, so I'm marking it languishing rather than closing it, in the hopes that someone will pick it up some day. I also think this could be a nice bug day task for someone, (though it might take all day :), so I'm adding the easy keyword.

(From the sounds of Jamie's second post, he may have thought he uploaded a patch, but didn't...)

Note: I suspect the logic of having 'unset' keys return an empty string is that a Morsel is supposed to have a "fixed set" of keys (and thus those keys should always be there). I'm not sure that should be changed.

[BreamoreBoy]

@demian is this of any interest to you?

[demianbrecht]

@mark: Sure, but not super high priority. Thanks for pointing it out.

[demianbrecht]

The attached patch should cover the implementation/test aspects of this issue. I'll work on the documentation next.

[demianbrecht]

Never mind, Morsel /is/ documented (at least in Docs). I imagine that the OP was after more detailed docstrings, but I don't believe they'd add much value.

The patch should be good to go as-is.