New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove local pubsub 3.3.0 code and import 4.0.0 from external package #782

Merged
merged 3 commits into from Mar 20, 2018

Conversation

Projects
None yet
3 participants
@david-hughes
Contributor

david-hughes commented Mar 12, 2018

Updates pubsub to latest version 4.0.0 by removing the local version 3.3.0 source code and importing version 4.0.0 from external stand-alone pubsub package (pip install Pypubsub).

This request arises out of discussion with pubsub author at schollii/pypubsub#7 and the change permits wxPython code that uses pubsub to be frozen succssfully by PyInstaller.

The inclusion of pubsub source code itself inside wx.lib is mainly historical and numerous other wx.lib items rely on external modules and packages being installed. It is being done this way in the interests of D.R.Y.

@RobinD42

This comment has been minimized.

Member

RobinD42 commented Mar 12, 2018

Please add a ReST formatted docstring in __init__.py so we'll have something in the wxPython documentation about this. It doesn't have to be a lot, maybe just a few sentences about what pubsub is and why it's useful in a wx application. And also include a link to pubsub's docs, and give the pip command for installing it.

What do you think about adding it as a dependency in setup.py?

@david-hughes

This comment has been minimized.

Contributor

david-hughes commented Mar 12, 2018

I'm not familiar with ReST formatting but I can see how someone - Werner? - created the docstrings for wx.lib.pdfviewer and can mimic those. Is there a definitive guide to ReST formatting anywhere?

A dependency in setup.py like 'six'? Yes, why not. The extra disk space - < 500k - is more than compensated for by the removal of version 3.3.0 in wx.lib

@RobinD42

This comment has been minimized.

Member

RobinD42 commented Mar 12, 2018

There's some wxPython-specific info here, although it's mostly about documenting classes and methods: https://docs.wxpython.org/DocstringsGuidelines.html

There are some general intros and guides here: http://docutils.sourceforge.net/rst.html

@mesalu

This comment has been minimized.

Collaborator

mesalu commented Mar 13, 2018

Looks like you'll just need to add 'pypubsub' to the DEPENDENCIES list on line 92 in /setup.py to accomplish the correct dependent behavior.
I'm definitely in favor of this if we're going to use pypubsub externally.

@RobinD42 RobinD42 merged commit fa53686 into wxWidgets:master Mar 20, 2018

3 checks passed

ci/circleci: Python-2.7 Your tests passed on CircleCI!
Details
ci/circleci: Python-3.5 Your tests passed on CircleCI!
Details
ci/circleci: Python-3.6 Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment