Migrate to Nunavut v2

[Willmac16]

Addresses #277

I'm still a bit unsure about how I'm handling nunavut_support.py, so I'd appreciate feedback on that and anything else.

[pavel-kirienko]

Please run Black to fix code formatting.

Also do not forget to bump the minor version when the PR is ready.

[coveralls]

coverage: 94.802% (-0.4%) from 95.246%
when pulling b8f2e16 on Willmac16:Willmac16/issue277
into a6a899c on OpenCyphal:master.

[Willmac16]

It looks like Yakut needs the pycyphal.dsdl.([a-z_]+) -> nunavut_support.$1 treatment.

[Willmac16]

Unrelated, should the package be marked as zip_safe in setup.cfg at this point?

[pavel-kirienko]

Unrelated, should the package be marked as zip_safe in setup.cfg at this point?

Maybe, but it would probably be a micro-optimization and this flag is obsolete either way, so I prefer not to touch it. See https://setuptools.pypa.io/en/latest/deprecated/zip_safe.html

[pavel-kirienko]

It looks like Yakut needs the pycyphal.dsdl.([a-z_]+) -> nunavut_support.$1 treatment.

I have opened a ticket about this in the Yakut repo. Would you be available to submit the required changes there? For testing, you can replace the PyCyphal dependency specification as follows:

 install_requires =
-    pycyphal[transport-udp,transport-serial,transport-can-pythoncan] ~= 1.8
+    pycyphal[transport-udp,transport-serial,transport-can-pythoncan] ~= git+https://github.com/Willmac16/pycyphal@Willmac16/issue277

You can temporarily replace the Yakut dependency in PyCyphal integration tests in a similar fashion.

[pavel-kirienko]

It looks like Yakut needs the pycyphal.dsdl.([a-z_]+) -> nunavut_support.$1 treatment.

I have opened a ticket about this in the Yakut repo.

Wait, I have a better idea. Can we please provide wrappers in pycyphal.dsdl of the form:

def update_from_builtin(destination: T, source: Any) -> T:
    """
    A wrapper over ``nunavut_support.update_from_builtin``.
    The ``nunavut_support`` module will be generated automatically if it is not importable.
    """
    from nunavut_support import update_from_builtin

    return update_from_builtin(destination, source)

That should avoid the breakage of Yakut.

---

Also, could you please update the docs here:

• https://pycyphal--318.org.readthedocs.build/en/318/pages/architecture.html#dsdl-support
• https://pycyphal--318.org.readthedocs.build/en/318/api/pycyphal.dsdl.html#module-pycyphal.dsdl

CompositeObject and ServiceObject are simply gone now.

[Willmac16]

Once everything in this PR is good to go 🤞

Can I squash my commits into one to keep the commit history of upstream clean.

Edit: Looks like squashed merges are a built in GitHub feature so I'll refrain from doing it manually.

[pavel-kirienko]

I think it looks good aside from a few minor nits. Please request another review when done and we'll have it merged.