feat: add Attachment to API #189

wyfo · 2024-04-19T09:51:47Z

@Mallets

wyfo · 2024-04-19T13:01:46Z

@YuanYuYuan

evshary

Should we also add some tests for user attachments?

examples/z_put.py

evshary · 2024-04-22T08:36:46Z

zenoh/value.py

+    return v if isinstance(v, bytes) else v.encode()
+
+
+class Attachment(_Attachment):


Should we add some description here?

evshary · 2024-04-22T08:42:39Z

examples/z_sub.py

It would be good if we could show how to get attachments on the subscriber's side, but it seems like zenoh Rust doesn't show this either.

Actually, I've tested it using z_put.py and z_sub.py. I've let the attachment in z_put.py, but I removed it from z_pub.py because it was messing with the tests.

Rust added it in protocol_changes, so eventually it will come. Not on this PR though.

examples/z_put.py

zenoh/session.py

Co-authored-by: Luca Cominardi <[email protected]>

Mallets

I've proposed some minor changes to the docstring. The rest LGTM.

P.S.: Some modification to the API will happen into protocol_changes anyway, so current version it's aligned enough with Rust main.

Co-authored-by: Luca Cominardi <[email protected]>

Mallets · 2024-04-22T13:22:46Z

@wyfo as mentioned by @evshary it would be good to have some test.

wyfo · 2024-04-22T13:42:29Z

Would a parameter in z_sub.py to print or not the attachment would be enough?

Mallets · 2024-04-22T13:45:34Z

Would a parameter in z_sub.py to print or not the attachment would be enough?

Attachment should be printed in case it is present (i.e. is not None). But the behaviour will be misaligned with the other bindings and examples. Let's keep this aspect for protocol_changes branch.

wyfo · 2024-04-22T13:48:24Z

So no test?

wyfo · 2024-04-22T13:49:58Z

I mean, features like payload auto-serialization are not tested, because tests are only examples and a standalone test_session.py. Do attachments fall into this category of features?

Mallets · 2024-04-22T14:56:21Z

I mean, features like payload auto-serialization are not tested, because tests are only examples and a standalone test_session.py. Do attachments fall into this category of features?

Attachment tests should go in https://github.com/eclipse-zenoh/zenoh-python/blob/main/tests/test_session.py

wyfo · 2024-04-22T16:14:25Z

Done

Mallets · 2024-04-22T16:21:59Z

Done

I believe you forgot to push :)

wyfo · 2024-04-22T16:36:12Z

🤦‍♂️ My push was rejected because I didn't rebase on the suggestions... Done this time, sorry.

* chore: bump pyo3 to 0.21 (#175) Roughly adapt the code to the new PyO3 API, with a few warning fixes. * fix(examples): fix commented parts of z_put.py (#176) * fix(examples): fix commented parts of z_put.py * fix: apply PR reviews * fix: apply PR reviews * Correct the syntax of pyproject.toml (#181) * feat: Automate Release (#165) * build: Get Read the Docs release number from Cargo manifest This avoids hardcoding the release number in the documentation build config, making it easier to bump the version by only modifying the manifest. * build: Require Python 3.11 in Read the Docs configuration Python 3.11 is needed to access tomllib; useful for parsing the Cargo manifest file. * feat: Create branch, bump version and tag in release workflow * feat: Add publish-github job * fix: Broken tag dependencies * chore: Remove enforce-linking-issues workflow * fix: Bump version in pyproject.toml * chore: Upgrade artifact actions from v3 to v4 * fix: Typo in git-commit command * fix: Support jq 1.6 ubuntu-22.04 runners use jq 1.6 which doesn't recognize a dot for `[]` value iterator. See: jqlang/jq#1168. * Revert "chore: Upgrade artifact actions from v3 to v4" This reverts commit a535971. * fix: Build wheels from release branch * fix: Switch to pypa/gh-action-pypi-publish@release/v1 The older actions doesn't recognize the pyproject.toml metadata fields. * Force sphinx version to 7.2.6 (#185) * fix: Install maturin according to requirements-dev.txt (#186) * fix: fix scout deadlock (#188) Releasing GIL in Scout destructor prevents the deadlock. * fix(uhlc): bump uhlc version (#173) Signed-off-by: gabrik <[email protected]> Co-authored-by: Luca Cominardi <[email protected]> * feat(tracing): using zenoh-util function for log initialization (#172) * feat(tracing): using zenoh-util function for log initialization Signed-off-by: gabrik <[email protected]> * chore: adding Cargo.lock Signed-off-by: gabrik <[email protected]> * feat(tracing): using zenoh main Signed-off-by: gabrik <[email protected]> * chore: using new try_init_log_from_env Signed-off-by: gabrik <[email protected]> * chore: sync Cargo.lock Signed-off-by: gabrik <[email protected]> --------- Signed-off-by: gabrik <[email protected]> Co-authored-by: Luca Cominardi <[email protected]> * feat: add Attachment to API (#189) * feat: add Attachment to API * fix: make attachment a CLI arg in z_put example * Update zenoh/session.py Co-authored-by: Luca Cominardi <[email protected]> * Apply suggestions from code review Co-authored-by: Luca Cominardi <[email protected]> * test: add test for attachment --------- Co-authored-by: Luca Cominardi <[email protected]> * build: Sync with eclipse-zenoh/zenoh@81217c7 from 2024-04-22 (#190) Co-authored-by: eclipse-zenoh-bot <[email protected]> * fix: Create virtual environment for armv6 build (#191) * build: Sync with eclipse-zenoh/zenoh@2fdddae from 2024-04-23 (#192) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@9a9832a from 2024-04-24 (#193) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@7c64d99 from 2024-04-26 (#194) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@ad58af6 from 2024-04-26 (#195) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@e8916bf from 2024-04-26 (#196) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@ea604b6 from 2024-04-29 (#197) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@371ca6b from 2024-04-30 (#198) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@7a47445 from 2024-05-03 (#200) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@f5195c0 from 2024-05-03 (#202) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@e53364f from 2024-05-04 (#203) Co-authored-by: eclipse-zenoh-bot <[email protected]> * test: add z_ping/z_pong examples (#205) * fix: make attachment API more similar to dict API (#201) * fix: make attachment API more similar to dict API * fix: fix formatting * fix: fix formatting * fix: fix typing * fix: uncomment tests 😅 * docs: add docstring for Attachment * build: Sync with eclipse-zenoh/zenoh@7e5d5e8 from 2024-05-07 (#206) Co-authored-by: eclipse-zenoh-bot <[email protected]> * fix: add `Encoding.with_suffix` instead of `Encoding.append` (#208) * fix: add `Encoding.with_suffix` instead of `Encoding.append` * feat: add `prefix`/`suffix` methods to `Encoding` * build: Sync with eclipse-zenoh/zenoh@b8dd01d from 2024-05-07 (#209) Co-authored-by: eclipse-zenoh-bot <[email protected]> * Support timeout for get in session. Signed-off-by: ChenYing Kuo <[email protected]> * Update PR based on the review. Signed-off-by: ChenYing Kuo <[email protected]> * Fix CI lint error. Signed-off-by: ChenYing Kuo <[email protected]> * Update: PyTypeError => PyValueError Signed-off-by: ChenYing Kuo <[email protected]> * build: Sync with eclipse-zenoh/zenoh@45e05f0 from 2024-05-13 (#212) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@763a05f from 2024-05-14 (#213) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@75aa273 from 2024-05-15 (#214) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@25f06bd from 2024-05-21 (#215) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@3118d31 from 2024-05-28 (#216) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@d574654 from 2024-06-03 (#217) Co-authored-by: eclipse-zenoh-bot <[email protected]> * chore: Update artifacts action to v4 (#218) artifacts actions v3 are deprecated * fix: give unique name for artifacts (#220) upload-artifacts/v4 has a breaking change from v3, which requires the artifacts names to be unique. Fix #219 * build: Sync with eclipse-zenoh/zenoh@c279982 from 2024-06-05 (#221) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@d8e66de from 2024-06-10 (#222) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@9d09742 from 2024-06-11 (#223) Co-authored-by: eclipse-zenoh-bot <[email protected]> * Fix markdown format in README. (#211) Signed-off-by: ChenYing Kuo <[email protected]> * build: Sync with eclipse-zenoh/zenoh@ed6c636 from 2024-06-12 (#225) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@8160b01 from 2024-06-13 (#228) Co-authored-by: eclipse-zenoh-bot <[email protected]> * Enable releasing from any branch (#227) * build: Sync with eclipse-zenoh/zenoh@7adad94 from 2024-06-14 (#230) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@93f93d2 from 2024-06-17 (#231) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@2500e5a from 2024-06-20 (#236) Co-authored-by: eclipse-zenoh-bot <[email protected]> * fix: remove deprecated maturin arg (#241) See PyO3/maturin#1620, `--universal2` has been deprecated * build: Sync with eclipse-zenoh/zenoh@869ace6 from 2024-07-02 (#247) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@b93ca84 from 2024-07-03 (#248) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@b3e42ce from 2024-07-08 (#252) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@b3e42ce from 2024-07-08 (#253) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@b3e42ce from 2024-07-08 (#259) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@0a969cb from 2024-07-25 (#261) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@0a969cb from 2024-07-25 (#262) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@e587aa9 from 2024-07-26 (#265) Co-authored-by: eclipse-zenoh-bot <[email protected]> * build: Sync with eclipse-zenoh/zenoh@2d88c7b from 2024-07-29 (#268) Co-authored-by: eclipse-zenoh-bot <[email protected]> * chore: remove useless dependencies --------- Signed-off-by: gabrik <[email protected]> Signed-off-by: ChenYing Kuo <[email protected]> Co-authored-by: Yuyuan Yuan <[email protected]> Co-authored-by: Mahmoud Mazouz <[email protected]> Co-authored-by: oteffahi <[email protected]> Co-authored-by: Gabriele Baldoni <[email protected]> Co-authored-by: Luca Cominardi <[email protected]> Co-authored-by: eclipse-zenoh-bot <[email protected]> Co-authored-by: eclipse-zenoh-bot <[email protected]> Co-authored-by: ChenYing Kuo <[email protected]> Co-authored-by: kydos <[email protected]> Co-authored-by: Diogo Matsubara <[email protected]> Co-authored-by: Diogo Matsubara <[email protected]>

feat: add Attachment to API

55ad5fe

evshary reviewed Apr 22, 2024

View reviewed changes

fix: make attachment a CLI arg in z_put example

5e79d83