[IPython-dev] Question about the stability of the api

[Wes Turner]

On Aug 20, 2015 1:53 AM, "Matthias Bussonnier" <bussonniermatthias at gmail.com>
wrote:
>
> Hi Fred,
>
>
>> On Aug 20, 2015, at 08:25, Fred Jendrzejewski <
fred.jendrzejewski at gmail.com> wrote:
>>
>> Hello everyone,
>>
>> I started working with a third party package (pymc3) in ipython4 I get
some errors that seem concern changes in the api of ipython:
>>
>> ShimWarning: The `IPython.html` package has been deprecated. You should
>> import from `notebook` instead. `IPython.html.widgets` has moved to
>> `ipywidgets`. "`IPython.html.widgets` has moved to `ipywidgets`.",
ShimWarning)
>> ./lib/python3.4/site-packages/IPython/utils/traitlets.py:5: UserWarning:
IPython.utils.traitlets
>> has moved to a top-level traitlets package.
>> warn("IPython.utils.traitlets has moved to a top-level traitlets
package."
>>
>> Before we wanted to start the debugging procedure, we wanted to ask how
stable this part of the ipython API is. In other words, is it worth to find
a clean fix or will this change within a short time frame anyway again ?
>
>
> These are just warnings
>
> You can just replace
>
> import IPython.html.widgets
>
> by
>
> try:
>    import ipywidgets
> except ImportErrror:
>   import IPython.html.widgets.
>
> (same with traitlets)
>
> Or actually do a conditional import depending on the IPython version.
>
> The stability depends on each package, that know have their own version
numbers, so the stability will depends on each specific package.
> They will most likely not move again before a few years.

http://sphinx-doc.org/markup/para.html

http://docs.ckan.org/en/latest/contributing/documentation.html#versionadded-and-versionchanged

.. versionchanged:
..

IPython widgets

| docs:
http://nbviewer.ipython.org/github/ipython/ipython/blob/master/examples/Interactive%20Widgets/Index.ipynb
| docs:
http://nbviewer.ipython.org/github/ipython/ipython/blob/master/examples/Interactive%20Widgets/Custom%20Widget%20-%20Hello%20World.ipynb
| docs: https://ipython.org/ipython-doc/dev/api/
| docs:
https://ipython.org/ipython-doc/dev/api/generated/IPython.html.widgets.widget.html
| src:
https://github.com/ipython/ipython/tree/master/examples/Interactive%20Widgets
| src: https://github.com/ipython/ipython/tree/3.x/IPython/html/widgets

IPython/ipywidgets

| docs:
http://nbviewer.ipython.org/github/ipython/ipywidgets/blob/master/examples/Index.ipynb
| docs:
http://nbviewer.ipython.org/github/ipython/ipywidgets/tree/master/examples/
| src: https://github.com/ipython/ipywidgets/tree/master/examples
| src: https://github.com/ipython/ipywidgets
| src: https://github.com/ipython/ipywidgets/tree/master/ipywidgets/widgets

Also,

* [ ] view source links in the IPython API docs (conf.py)?
   * [ ] view source links to (-> github at revtag?)

> --
> M
>
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20150820/87b28192/attachment.html>