This release brings a few minor backward incompatibilities, so be sure to read
on before upgrading. However, fear not: the ones that are most likely relevant
to you have a relatively simple migration path.
Backward Incompatibilities
^^^^^^^^^^^^^^^^^^^^^^^^^^
* ``classic.teleport_function`` now executes the function in the connection's
namespace by default. To get the old behaviour, use
``teleport_function(conn, func, conn.modules[func.__module__].__dict__)``
instead.
* Changed signature of ``Service.on_connect`` and ``on_disconnect``, adding
the connection as argument.
* Changed signature of ``Service.__init__``, removing the connection argument
* no longer store connection as ``self._conn``. (allows services that serve
multiple clients using the same service object, see `198`_).
* ``SlaveService`` is now split into two asymmetric classes: ``SlaveService``
and ``MasterService``. The slave exposes functionality to the master but can
not anymore access remote objects on the master (`232`_, `248`_).
If you were previously using ``SlaveService``, you may experience problems
when feeding the slave with netrefs to objects on the master. In this case, do
any of the following:
* use ``ClassicService`` (acts exactly like the old ``SlaveService``)
* use ``SlaveService`` with a ``config`` that allows attribute access etc
* use ``rpyc.utils.deliver`` to feed copies rather than netrefs to
the slave
* ``RegistryServer.on_service_removed`` is once again called whenever a service
instance is removed, making it symmetric to ``on_service_added`` (`238`_)
This reverts PR `173`_ on issue `172`_.
* Removed module ``rpyc.experimental.splitbrain``. It's too confusing and
undocumented for me and I won't be developing it, so better remove it
altogether. (It's still available in the ``splitbrain`` branch)
* Removed module ``rpyc.experimental.retunnel``. Seemingly unused anywhere, no
documentation, no clue what this is about.
* ``bin/rpyc_classic.py`` will bind to ``127.0.0.1`` instead of ``0.0.0.0`` by
default
* ``SlaveService`` no longer serves exposed attributes (i.e., it now uses
``allow_exposed_attrs=False``)
* Exposed attributes no longer hide plain attributes if one otherwise has the
required permissions to access the plain attribute. (`165`_)
.. _165: https://github.com/tomerfiliba/rpyc/issues/165
.. _172: https://github.com/tomerfiliba/rpyc/issues/172
.. _173: https://github.com/tomerfiliba/rpyc/issues/173
.. _198: https://github.com/tomerfiliba/rpyc/issues/198
.. _232: https://github.com/tomerfiliba/rpyc/issues/232
.. _238: https://github.com/tomerfiliba/rpyc/issues/238
.. _248: https://github.com/tomerfiliba/rpyc/issues/248
What else is new
^^^^^^^^^^^^^^^^
* teleported functions will now be defined by default in the globals dict
* Can now explicitly specify globals for teleported functions
* Can now use streams as context manager
* keep a hard reference to connection in netrefs, may fix some ``EOFError``
issues, in particular on Jython related (`237`_)
* handle synchronous and asynchronous requests uniformly
* fix deadlock with connections talking to each other multithreadedly (`270`_)
* handle timeouts cumulatively
* fix possible performance bug in ``Win32PipeStream.poll`` (oversleeping)
* use readthedocs theme for documentation (`269`_)
* actually time out sync requests (`264`_)
* clarify documentation concerning exceptions in ``Connection.ping`` (`265`_)
* fix ``__hash__`` for netrefs (`267`_, `268`_)
* rename ``async`` module to ``async_`` for py37 compatibility (`253`_)
* fix ``deliver()`` from IronPython to CPython2 (`251`_)
* fix brine string handling in py2 IronPython (`251`_)
* add gevent_ Server. For now, this requires using ``gevent.monkey.patch_all()``
before importing for rpyc. Client connections can already be made without
further changes to rpyc, just using gevent's monkey patching. (`146`_)
* add function ``rpyc.lib.spawn`` to spawn daemon threads
* fix several bugs in ``bin/rpycd.py`` that crashed this script on startup
(`231`_)
* fix problem with MongoDB, or more generally any remote objects that have a
*catch-all* ``__getattr__`` (`165`_)
* fix bug when copying remote numpy arrays (`236`_)
* added ``rpyc.utils.helpers.classpartial`` to bind arguments to services (`244`_)
* can now pass services optionally as instance or class (could only pass as
class, `244`_)
* The service is now charged with setting up the connection, doing so in
``Service._connect``. This allows using custom protocols by e.g. subclassing
``Connection``. More discussions and related features in `239`_-`247`_.
* service can now easily override protocol handlers, by updating
``conn._HANDLERS`` in ``_connect`` or ``on_connect``. For example:
``conn._HANDLERS[HANDLE_GETATTR] = self._handle_getattr``.
* most protocol handlers (``Connection._handle_XXX``) now directly get the
object rather than its ID as first argument. This makes overriding
individual handlers feel much more high-level. And by the way it turns out
that this fixes two long-standing issues (`137`_, `153`_)
* fix bug with proxying context managers (`228`_)
* expose server classes from ``rpyc`` top level module
* fix logger issue on jython
.. _137: https://github.com/tomerfiliba/rpyc/issues/137
.. _146: https://github.com/tomerfiliba/rpyc/issues/146
.. _153: https://github.com/tomerfiliba/rpyc/issues/153
.. _165: https://github.com/tomerfiliba/rpyc/issues/165
.. _228: https://github.com/tomerfiliba/rpyc/issues/228
.. _231: https://github.com/tomerfiliba/rpyc/issues/231
.. _236: https://github.com/tomerfiliba/rpyc/issues/236
.. _237: https://github.com/tomerfiliba/rpyc/issues/237
.. _239: https://github.com/tomerfiliba/rpyc/issues/239
.. _244: https://github.com/tomerfiliba/rpyc/issues/244
.. _247: https://github.com/tomerfiliba/rpyc/issues/247
.. _251: https://github.com/tomerfiliba/rpyc/issues/251
.. _253: https://github.com/tomerfiliba/rpyc/issues/253
.. _264: https://github.com/tomerfiliba/rpyc/issues/264
.. _265: https://github.com/tomerfiliba/rpyc/issues/265
.. _267: https://github.com/tomerfiliba/rpyc/issues/267
.. _268: https://github.com/tomerfiliba/rpyc/issues/268
.. _269: https://github.com/tomerfiliba/rpyc/issues/269
.. _270: https://github.com/tomerfiliba/rpyc/issues/270
.. _gevent: http://www.gevent.org/