Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread Stephan Houben
Hi Yahya, I like the full.png diagram, however, I see some issues with it. Most seriously, the methods it lists don't match the documentation. E.g. if you check MappingView: https://docs.python.org/3/library/collections.abc.html#collections.abc.MappingView you see it has only a __len__ mixin m

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread Terry Reedy
On 12/30/2017 11:11 AM, Yahya Abou 'Imran via Python-ideas wrote: We can find very usefull class diagramm to understand the hierarchy of the builtin Collection abstract class and interface in java. Some examples: http://www.falkhausen.de/Java-8/java.util/Collection-Hierarchy-simple.html http://

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread pylang
+1 on adding these diagrams to the docs. It's great to visualize where the special methods are implemented. On Sat, Dec 30, 2017 at 4:17 PM, Terry Reedy wrote: > On 12/30/2017 11:11 AM, Yahya Abou 'Imran via Python-ideas wrote: > >> We can find very usefull class diagramm to understand the hier

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread Yahya Abou 'Imran via Python-ideas
> Hi Yahya, > I like the full.png diagram, however, I see some issues with it. > > Most seriously, the methods it lists don't match the documentation. > > E.g. if you check MappingView: > > https://docs.python.org/3/library/collections.abc.html#collections.abc.MappingView > > you see it has only a

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread Yahya Abou 'Imran via Python-ideas
> A. Width restrictions suggest making the async branches a separate diagram. I was thinking about it... Maybe Hashable and Callable could also be removed, since they are standalone ABCs. And they're not directly linked with the concept of Collection anyway. > B. Be consistent on placement of

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-30 Thread Yahya Abou 'Imran via Python-ideas
Here is another version showing all that inherit from Container, Sized and Iterable. I got rid of ABCMeta, since it's not the prupose of the documentation of that page. I left the parenthesis and the end of the methods names though... [collections_abc.png]

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-31 Thread Stephen J. Turnbull
Terry Reedy writes: > B. Be consistent on placement of inherited versus added methods. Always > list inherited first? Different fonts, as suggested, might be > good. I would prefer listing added methods first. ___ Python-ideas mailing list Python

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-31 Thread Stephen J. Turnbull
Sorry about the premature send. Terry Reedy writes: > B. Be consistent on placement of inherited versus added methods. Always > list inherited first? Different fonts, as suggested, might be > good. I would prefer listing overridden and added methods first, because there's a good chance I a

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2017-12-31 Thread Yahya Abou 'Imran via Python-ideas
>Terry Reedy writes: > >>B. Be consistent on placement of inherited versus added methods. Always >>>list inherited first? Different fonts, as suggested, might be >>>good. >> > I would prefer listing added methods first. I don't understand why... In the table of the documentation page, the abst

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Yahya Abou 'Imran via Python-ideas
>While I appreciate what you're trying to accomplish, Yahya, one thing I would >like to say is if we were to accept the diagram into the docs I would prefer >that there be a source file that isn't an image which we can update with >easily available software (e.g. like a dot file). Otherwise upda

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Brett Cannon
While I appreciate what you're trying to accomplish, Yahya, one thing I would like to say is if we were to accept the diagram into the docs I would prefer that there be a source file that isn't an image which we can update with easily available software (e.g. like a dot file). Otherwise updating th

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Terry Reedy
On 1/1/2018 3:39 PM, Brett Cannon wrote: While I appreciate what you're trying to accomplish, Yahya, one thing I would like to say is if we were to accept the diagram into the docs I would prefer that there be a source file that isn't an image which we can update with easily available software

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Wes Turner
SVG is preferable to PNG because you can Ctrl-F SVG. On Monday, January 1, 2018, Wes Turner wrote: > > > On Monday, January 1, 2018, Yahya Abou 'Imran via Python-ideas < > python-ideas@python.org> wrote: > >> Plantuml can also generate ASCII, so playing with ditaa I managed to have >> intersting

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Yahya Abou 'Imran via Python-ideas
Plantuml can also generate ASCII, so playing with ditaa I managed to have intersting things... I opened a public repo on my GitLab account to put that all so you can have a visualization of it (source files and `png`s): https://gitlab.com/yahya-abou-imran/collections-abc-uml `dot` files seems

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Victor Stinner
Hi, There is "blockdiag" which is Sphinx friendly: http://blockdiag.com/en/blockdiag/sphinxcontrib.html Look also at: * http://asciiflow.com/ * http://ditaa.sourceforge.net/ * http://asciidoctor.org/news/2014/02/18/plain-text-diagrams-in-asciidoctor/ * etc. I like ASCII Art since it doesn't req

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Wes Turner
On Monday, January 1, 2018, Yahya Abou 'Imran via Python-ideas < python-ideas@python.org> wrote: > Plantuml can also generate ASCII, so playing with ditaa I managed to have > intersting things... > > I opened a public repo on my GitLab account to put that all so you can > have a visualization of i

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-01 Thread Yahya Abou 'Imran via Python-ideas
http://plantuml.com/ You just run it with the `plantuml` command, and you have .png It has a good integration with a lot of tools (iPython for example) : http://plantuml.com/running I will look at your suggestions though. Message d'origine On 1 janv. 2018 23:32, Victor Stinne

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Yahya Abou 'Imran via Python-ideas
At the end of the day, I found that plantuml is the most suitable tool for this. Graphviz dot is interesting, but it doesn't feel natural to make class diagram with it, or at least it's less handy... I could bring several arguments to support this, but it's not the topic. Everybody wanting to tr

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Wes Turner
On Tuesday, January 2, 2018, Yahya Abou 'Imran < yahya-abou-im...@protonmail.com> wrote: > At the end of the day, I found that plantuml is the most suitable tool for > this. > Graphviz dot is interesting, but it doesn't feel natural to make class > diagram with it, or at least it's less handy... I

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Wes Turner
Is there a way to generate relative links to the classes in the SVG? This would be really convenient: https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable Hashable On Tuesday, January 2, 2018, Wes Turner wrote: > > > On Tuesday, January 2, 2018, Yahya Abou 'Imran <

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Yahya Abou 'Imran via Python-ideas
>Can I suggest that rather than manually producing or tweaking, and later > updating, the diagrams it might be better to spend a little time > annotating the source code [...] > While the diagrams produced might lack the elegance of manually produced > ones they would be much more useful as they wo

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Brett Cannon
On Tue, 2 Jan 2018 at 05:25 Yahya Abou 'Imran < yahya-abou-im...@protonmail.com> wrote: > At the end of the day, I found that plantuml is the most suitable tool for > this. > Right, but when I look at http://plantuml.com/ I don't see any open source code to guarantee it will be available in e.g.

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Yahya Abou 'Imran via Python-ideas
>>Right, but when I look at http://plantuml.com/ I don't see any open source >>code to guarantee >>>it will be available in e.g. 5 years. (I really just see a lot of ads around >>>a free Java app). >> >I see fedora packages plantuml and says is lgpl3 licensed. > >Barry On archlinux: $ pacman -Q

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Yahya Abou 'Imran via Python-ideas
And on the sourceforge page: https://sourceforge.net/projects/plantuml/ License GNU General Public License version 2.0 (GPLv2) ___ Python-ideas mailing list Python-ideas@python.org https://mail.python.org/mailman/listinfo/python-ideas Code of Conduct:

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Barry
After reading this thread I went off and read up about plantuml. According to its docs it produces dot files that it reandes with graphviz. So if graphviz will produce svg that part is solved. Can you creat the plantuml file automatically from the python code? Barry On 2 Jan 2018, at 15:26, Yahy

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Barry
> On 2 Jan 2018, at 19:38, Brett Cannon wrote: > > > >> On Tue, 2 Jan 2018 at 05:25 Yahya Abou 'Imran >> wrote: >> At the end of the day, I found that plantuml is the most suitable tool for >> this. > > Right, but when I look at http://plantuml.com/ I don't see any open source > code to

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-02 Thread Brett Cannon
That's great! They don't advertise this, unfortunately, at plantuml.com :/ On Tue, 2 Jan 2018 at 13:57 Yahya Abou 'Imran < yahya-abou-im...@protonmail.com> wrote: > And on the sourceforge page: > > https://sourceforge.net/projects/plantuml/ > > License > GNU General Public License version 2.0 (GP

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-03 Thread Steve Barnes
You can embed plantuml directives in rst, and possibly the code, and use sphinxcontrib-plantuml which at least keeps the diagrams for documentation close to the code. pyplantuml claims to be able to extract the infromation directly from the code, (https://github.com/cb109/pyplantuml), but havin

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-03 Thread Paul Rudin
Brett Cannon writes: > On Tue, 2 Jan 2018 at 05:25 Yahya Abou 'Imran b1ysje57in+bqq9rb...@public.gmane.org> wrote: > > At the end of the day, I found that plantuml is the most suitable tool for > this. > > Right, but when I look at http://plantuml.com/ I don't see any open source > code

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-03 Thread Brett Cannon
We would check in the resulting image, so any Java dependency would only be for when we update the image. On Wed, Jan 3, 2018, 01:33 Paul Rudin, wrote: > Brett Cannon writes: > > > On Tue, 2 Jan 2018 at 05:25 Yahya Abou 'Imran > b1ysje57in+bqq9rb...@public.gmane.org> wrote: > > > > At the

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-05 Thread Yahya Abou 'Imran via Python-ideas
Hi everybody. I would like to make a recap: It seems that we all agree that it's something nice to have. Now, we are wondering about the tools or the methodology to use them. As I said, if somebody want to give a try, I'm not against it. But what are we doing now? I've already open an issue, I

Re: [Python-ideas] Add an UML class diagram to the collections.abc module documentation

2018-01-05 Thread Brett Cannon
At this point the conversation should shift to https://bugs.python.org/issue32471 . On Fri, 5 Jan 2018 at 08:51 Yahya Abou 'Imran via Python-ideas < python-ideas@python.org> wrote: > Hi everybody. > > I would like to make a recap: > > It seems that we all agree that it's something nice to have. N