This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: dict view comparison methods are not documented
Type: Stage: needs patch
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: ezio.melotti, georg.brandl, rhettinger, sandro.tosi, terry.reedy, zuo
Priority: normal Keywords: patch

Created on 2010-01-24 17:19 by zuo, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue7771-py3k.patch sandro.tosi, 2010-10-08 19:00
issue7771-py3k-v2.patch sandro.tosi, 2010-10-08 22:27
issue7771-py3k-v3.patch sandro.tosi, 2010-10-09 07:45
Messages (8)
msg98240 - (view) Author: Jan Kaliszewski (zuo) Date: 2010-01-24 17:19
Dictionary views documentation (e.g. http://docs.python.org/3.1/library/stdtypes.html#dictionary-view-objects) contains nothing about comparison (> >= < <= == !=) operations.
msg98538 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-01-29 20:58
The 3.2a doc is unchanged (similarly lacking).

The situation is that view have all of the special method (operator methods) that frozen sets do but none of the named methods (.copy to .union). I think it would be helpful if the doc said so. Perhaps change

"Then these set operations are available ..."

to

"For set-like view, all of the syntax operations on sets (but none of the named methods, like set.copy,) are available ..."

I think

dictview < / <= / >= / > other:
 same as corresponding operation with two sets

might be sufficient, but list all four is ok too.
msg118218 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2010-10-08 19:00
Hello,
here attached a patch for this bug. I hope the format "< / <= / == / != / >= / >" is clearly understandable as an alternative sequence of different operations.

Regards,
Sandro
msg118224 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2010-10-08 20:07
We should probably just make reference to the collections.Set() abstract API instead of listing out all operations.
msg118229 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2010-10-08 22:27
Hello Raymond,
thanks for the review. I've reworked the patch to refer to Collections.Set (but is there a way to make that reference a link to the description of Collections ABCs?) and so I've also removed all the examples, leaving only the one for '^' because I didn't see a Set operator to do that (but I'm happy to be proven wrong :)

Regards,
Sandro
msg118231 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2010-10-08 22:34
The '^' corresponds to the __xor__ magic method.

snip from _abcoll.py:

    def __xor__(self, other):
        if not isinstance(other, Set):
            if not isinstance(other, Iterable):
                return NotImplemented
            other = self._from_iterable(other)
        return (self - other) | (other - self)
msg118247 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2010-10-09 07:45
gaah, sorry about that. I've prepared another patch that removes the '^' part and adds an example about that.

About the reference to Collections.Set to be a link to the Collections page, do you think it's acceptable to define all the Collection ABCs as :class:`...` ? I looked at http://docs.python.org/documenting/markup.html but didn't find a specific markup for ABC, so I suppose 'class' is fine.

If you think it might worth the effort, I can mark those ABCs up as class, and scan the documentation for references to them and convert to link (if not already done automagically).
msg118788 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-10-15 16:03
Applied in r85532. Thanks!
History
Date User Action Args
2022-04-11 14:56:56adminsetgithub: 52019
2010-10-15 16:03:07georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg118788
2010-10-09 07:45:41sandro.tosisetfiles: + issue7771-py3k-v3.patch

messages: + msg118247
2010-10-08 22:34:26rhettingersetmessages: + msg118231
2010-10-08 22:27:38sandro.tosisetfiles: + issue7771-py3k-v2.patch

messages: + msg118229
2010-10-08 20:07:26rhettingersetnosy: + rhettinger
messages: + msg118224
2010-10-08 19:00:51sandro.tosisetfiles: + issue7771-py3k.patch

nosy: + sandro.tosi
messages: + msg118218

keywords: + patch
2010-01-29 20:58:01terry.reedysetnosy: + terry.reedy
messages: + msg98538
2010-01-24 20:15:27ezio.melottisetpriority: normal
nosy: + ezio.melotti

stage: needs patch
2010-01-24 17:19:24zuocreate