Commit graph

876 commits

Author SHA1 Message Date
Yian Chen
78dd54e641 address flake8 format check 2024-04-11 19:01:59 -07:00
Jacob Alexander
1fb168796d Prepare for v2.0.0 release
- Update CHANGELOG.md
2024-01-19 08:35:01 -08:00
Jacob Alexander
1f2349ab45
Update README.md
Cap'n'proto has transitioned to GitHub Mailing Lists
2023-11-25 11:10:25 -08:00
Jacob Alexander
84830d6357 Prepare for v2.0.0b2 release
- Update CHANGELOG.md
2023-11-25 11:04:29 -08:00
Lasse Blaauwbroek
3aade70bfa Some fixes to the magic import system
- Stop adding the directory of every .capnp file to the import path. If a .capnp
  file wants to import a file in its own directory, it should use a relative
  import. Fixes #278
- Stop using /usr/include/capnp as an import path. This is incorrect. It should
  only be /usr/include.
- Stop allowing additional paths to be specified for magic imports. This leads
  to inconsistencies. More specifically, the way that a nested import like
  `ma.mb.mc_capnp` gets imported by python, is to first import `ma`, then import
  `ma.mb`, and finally `ma.mb.mc_capnp`. Pycapnp's magic importing is only
  involved in the last step. So any additional paths specified don't work for
  nested imports. It is very confusing to only have this for non-nested imports.
  Users with folder layouts that don't follow pythons import paths can still use
  `capnp.load(.., .., imports=[blah])`.
2023-11-25 08:16:38 -08:00
Lasse Blaauwbroek
b6ea909e9a Corner case for cancelled server methods that raise exceptions
When a server method is cancelled, but it nonetheless raises an exception (other
than `CancelledError`), this exception cannot be reported to the caller (because
it has cancelled that call).

The only place where it can go is to the asyncio exception handler...
2023-11-09 09:10:39 -08:00
Lasse Blaauwbroek
0ec4d0b778 Allow cancellation of all capability contexts 2023-11-08 07:09:10 -08:00
Lasse Blaauwbroek
49bda5ccae Fix re-raising of KjException
- The `KjException._to_python()` function neglected to check if the wrapper was
  set when attempting to convert to `AttributeError`, leading to exceptions while
  raising an exception.
- The syntax `raise A, B, C` hasn't existed since Python 3. The only reason it
  works is because Cython supports it. Lets get rid of it.
- There was an attempt to convert a certain kind of `KjException` to an
  `AttributeError`. However, the original exception remains in the context when
  the new exception is raised. This is confusing. We get rid of the original
  exception by doing `raise e._to_python() from None`.
2023-11-08 07:04:27 -08:00
Lasse Blaauwbroek
ef5e039067 Support _DynamicListReader in _setDynamicField
See the test for an explanation.

Note that I'm not sure what the purpose of `_setDynamicFieldWithField` and
`_setDynamicFieldStatic` is. It does not appear to be used. I've kept them for
now (they are a public API), but perhaps this can be removed.
2023-11-08 07:02:09 -08:00
Lasse Blaauwbroek
aafec2281e Make reraise_kj_exception available to downstream
I'm using Pycapnp in a project, where we compile `.capnp` files directly to
Cython instead of using the dynamic interface (for speed). For this, we need
access to the `reraise_kj_exception` C function defined by Pycapnp. This is not
possible, because Cython does not automatically make this function available to
downstream users.

My previous solution, in #301, was rather flawed. The  file `capabilityHelper.cpp`, where
`reraise_kj_exception` is defined, was bundled into the distribution, so that
this file could be included in downstream libraries. This turns out to be a
terrible idea, because it redefines a bunch of other things like
`ReadPromiseAdapter`. For reasons not entirely clear to me, this leads to
segmentation faults. This PR revers #301.

Instead, in this PR I've made `reraise_kj_exception` a Cython-level function,
that can be used by downstream libraries. The C-level variant has been renamed
to `c_reraise_kj_exception`.
2023-11-05 13:58:13 -08:00
Fabio Rossetto
42665a61c9 Properly join list of methods in _DynamicCapabilityClient
This was already fixed in c9bea05f44, but the fix does not seem to work.
This commit uses a set union, which should be more robust. It also adds
a couple of assertions to verify that it indeed works.
2023-11-01 19:03:11 -07:00
lewinb-corp
c9bea05f44 DynamicCapabilityClient: fix crash due to wrong types
In the last commit touching this line, a ')' was put in the wrong place, leading to errors like this one:

```
  File "capnp/lib/capnp.pyx", line 2172, in capnp.lib.capnp._DynamicCapabilityClient.__dir__
TypeError: unsupported operand type(s) for +: 'set' and 'tuple'
```
2023-10-23 10:48:47 -07:00
Tobias Ahrens
7a4970605e Disable the use of ninja for windows builds
Aperantly github added ninja to all of there runners now. This
causes the windows build to fail. This is expected because we
add the architecture as a compiler arg which is not known to
ninja. Even with this the build fails.

This commit disables ninja on windows for now. Once we fixed the
underlying issue with ninja and windows we can reenable it.
2023-10-23 10:23:16 -07:00
Lasse Blaauwbroek
ca8d120901 Handle exceptions from server callbacks
In its current form, when a server callback throws an exception, it is
completely swallowed. Only when the asyncio loop is being shut down might one
possibly see that error. On top of that, the connection is never closed, causing
any clients to hang, and a memory leak in the server.

This is a proposed fix that reports the exception to the asyncio exception
handler. It also makes sure that the connection is always closed, even if the
callback doesn't close it explicitly.

Note that the design of AsyncIoStream is directly based on the design of
Python's asyncio streams: https://docs.python.org/3/library/asyncio-stream.html
These streams appear to have exactly the same flaw. I've reported this here:
https://github.com/python/cpython/issues/110894. Since I don't really know what
I'm doing, it might be worth seeing what kind of solution they might come up
with and model our solution after theirs.
2023-10-22 23:29:47 -07:00
Mike Laiosa
09f7cd0d08 Unlock the GIL for all capnp functions that do IO
IO might block, and its rude to block while holding the GIL, since that
prevents other threads from running.
2023-10-16 13:51:27 -07:00
Lasse Blaauwbroek
a30fd77a1c Fix retransmit bug for large messages causing message corruption
Logic bug: We are looping over segments sent by the C++ library and sending them
over a python transport. If the last message is larger than the transport pause
threshold, this causes the transport to pause us. In that case, we forget to
increment the current write_index, causing us to retransmit the same message in
an infinite loop.

This is a serious bug, because it causes messages to become corrupted.
2023-10-16 11:06:49 -07:00
Tobias Ahrens
302a96d84d
Update documentation to async code (#331) (#332)
* Update documentation to async code (#331)

This commit updates the documentation to the latest changes added
with pycapnp 2.0.0.

* Remove non existing classes/functions from the reference documentation
* Adapt the quickstart to the latest changes. Mainly to new rpc handling,
  that now exlusively is done through asyncio.

* DOC: Add section about send and receive messages over a socket

Since #313 it is possible to read and write messages over a socket.
This commit adds a small section for read and write in the quickstart.
2023-10-16 11:05:27 -07:00
Lasse Blaauwbroek
1446386636 Make a server fail early when the KJ loop is not running 2023-10-15 08:10:54 -07:00
Lasse Blaauwbroek
cc088211dc Delete and update some Python 3.7-specific todo notes
When I wrote some of these, I was wrong about the affected versions. Upgraded
them to v3.9
2023-10-13 07:55:57 -07:00
Lasse Blaauwbroek
b22763f3c6 Fix 'AttributeError: '_UnixSelectorEventLoop' object has no attribute 'call_soon'
See haata/pycapnp#1 for a discussion. The cause of this bug is still unknown to
me. But it likely has been fixed in Python 3.10. For some crazy reason, you can
just keep retrying the offending call, and the attribute will magically
'reappear'.
2023-10-13 06:47:25 -07:00
Lasse Blaauwbroek
ae965128de
Update README example to async code (#331) 2023-10-12 07:13:27 -07:00
Tobias Ahrens
941f018092
Fix broken test in test_load (#329)
The new context manager for the event loop
seems to be missing in `test_load_capnp`.
2023-10-11 11:33:41 -07:00
Tobias Ahrens
bb15822850
Fixes for capnp 1.0 (#1)
* add capnp_api.h to gitignore

* Change type of read_min_bytes from size to int

Not sure why this was not causing issues before or if that
is the right fix ... but it seems to be fine :)

* Adapt python_requires to >=3.8

This was overlooked when 3.7 was deprecated. The ci no longer
works with python 3.7 and cibuildwheel uses python_requires ...

* Replace deprecated find_module with find_spec (importlib)

find_module was deprecated with python 3.4 and python 3.12
removed it (https://docs.python.org/3.12/whatsnew/3.12.html#importlib).

The new command is find_spec and only required a few adaptions
2023-10-11 11:28:24 -07:00
Jacob Alexander
313d0d4c6d Prepare for v2.0.0b1 release
- Update CHANGELOG.md
- Update to bundled capnproto-1.0.1
  * Compiles with capnproto-0.8.0 and higher
- *Breaking Change* Remove allow_cancellation (see
  https://capnproto.org/news/2023-07-28-capnproto-1.0.html)
  * This is tricky to handle for older versions of capnproto. Instead of
    dealing with lots of complication, removing it entirely.
- Fix some documentation after the build backend support was added
- Update tox.ini to support 3.8 to 3.12
- Update cibuildwheel to 2.16.1
  * Adds Python 3.12 supports and implicitly deprecates EOL 3.7 (though it's
    still built)
2023-10-03 12:29:48 -07:00
Lasse Blaauwbroek
e13a0c9254
Experiment: Wrap all capnp code in a context-manager to avoid segfaults (#317)
* Experiment: Wrap all capnp code in a context-manager

* Fix segfault in on_disconnect
2023-10-03 09:04:51 -07:00
Tobias Ahrens
d48ffea939
Add custom build backend to support build args (#328)
This implements a custom build backend, inspired by the
[solution used by Pillow.](https://github.com/python-pillow/Pillow/pull/7171)

install-option is deprecated and was removed with pip 23.1. The
comonly accepted solution seems to be to define a custom build
backend for now
https://github.com/pypa/setuptools/issues/2491#issuecomment-1589764230

This commit changes the usage from `--install-option` to `--config-settings`.
2023-10-02 22:30:51 -07:00
Karl
db26d60283
Pin cython to below version 3, Python 3.11 support (#320)
* Pin cython to below version 3

Cython 3 includes backwards incompatible changes so it's no longer
possible to install pycapnp from source.

* Add py311 environment

I'm not sure if this is necessary, but 3.11 is out so might as well?
2023-07-21 01:40:49 -07:00
Jacob Alexander
8f3bfc3536
Merge pull request #307 from Zentren/dynamic_schema_loading
Schema loading from the wire
2023-06-19 13:27:15 -07:00
DaneSlattery
f59b3fdc91 adjust tests for async 2023-06-19 12:21:38 +02:00
Rowan Reeve
a5c29a74d2 Schema loading from the wire
Cap'n Proto provides a schema loader, which can be used to dynamically
load schemas during runtime. To port this functionality to pycapnp,
a new class is provided `C_SchemaLoader`, which exposes the Cap'n
Proto C++ interface, and `SchemaLoader`, which is part of the pycapnp
library.

The specific use case for this is when a capnp message contains
a Node.Reader: The schema for a yet unseen message can be loaded
dynamically, allowing the future message to be properly processed.

If the message is a struct containing other structs, all the schemas for
every struct must be loaded to correctly parse the message. See
https://github.com/DaneSlattery/capnp_generic_poc for a
proof-of-concept.

Add docs and cleanup

Add more docs

Reduce changes

Fix flake8 formatting

Fix get datatype
2023-06-12 14:10:13 +02:00
Jacob Alexander
b439993b1f
Merge pull request #315 from LasseBlaauwbroek/cull-sync
Remove the synchronous RPC mode
2023-06-12 00:31:16 -07:00
Lasse Blaauwbroek
1e94f2e321 Remove the option to create servers through _new_server.
Inheritance is required now to create a server
2023-06-11 04:09:03 +02:00
Lasse Blaauwbroek
5edf700548 Remove .capnp fixture from test_capability_context.py
Using a fixture makes things more complicated. If we want to test explicit
capnp.load() functionality, we can do that separately
2023-06-11 04:09:01 +02:00
Lasse Blaauwbroek
95bb528ea2 Delete test_capability_old.py, which is mostly redundant
All of these tests also exist in test_capability.py. The only difference is the
way the .capnp file is loaded. But that could be tested with much less code.
2023-06-11 03:51:23 +02:00
Lasse Blaauwbroek
83d610c116 Remove some more c++ helper functions 2023-06-11 03:50:54 +02:00
Lasse Blaauwbroek
0483596da1 Miscellaneous 2023-06-09 22:05:12 +02:00
Lasse Blaauwbroek
d6261b6d79 Manually handle deallocation of some objects for the benefit of p3.7
Python 3.7 seems to have trouble dealocating objects in a timely fashion. We
rely on this, because the c++ destructors need to run before the kj event loop
is closed. Hence, we do it manually.
2023-06-09 22:05:12 +02:00
Lasse Blaauwbroek
74ebaff4e3 Make older python versions work 2023-06-09 22:05:05 +02:00
Lasse Blaauwbroek
0d160fc81d Fix forgotten async server method 2023-06-09 22:04:39 +02:00
Lasse Blaauwbroek
84d0f365ad Fix formatting 2023-06-08 08:18:50 +02:00
Lasse Blaauwbroek
bc01774ede Add pytest-asyncio to ci 2023-06-08 08:13:28 +02:00
Lasse Blaauwbroek
770be41b6d Bugfix: Attach server to on_disconnect to prevent early closing 2023-06-08 08:11:23 +02:00
Lasse Blaauwbroek
7a8175ed84 Get rid of VoidPromise and (almost) Promise
We only retain RemotePromise for its pipelining capabilities.
2023-06-08 08:02:07 +02:00
Lasse Blaauwbroek
da6a07efd5 No more need for promise joining 2023-06-08 05:34:04 +02:00
Lasse Blaauwbroek
20868d7db0 Get rid of dead code 2023-06-08 04:13:59 +02:00
Lasse Blaauwbroek
4b5c4211f1 Force server methods to be async and client calls to use await 2023-06-08 03:56:57 +02:00
Lasse Blaauwbroek
a69bc72a0b Remove a bunch of unused code 2023-06-08 02:42:04 +02:00
Lasse Blaauwbroek
854d910bee Make tests run faster by reducing timeouts 2023-06-08 02:31:06 +02:00
Lasse Blaauwbroek
af99e388fb Fix and improve a bunch of tests 2023-06-08 02:29:54 +02:00
Lasse Blaauwbroek
b29f18ed64 Cleanup 2023-06-08 02:29:24 +02:00