Add dataclass encoding by zjkmxy · Pull Request #111 · named-data/python-ndn

zjkmxy · 2026-10-08T06:57:27Z

Ref: #97 #108

New wire format is longer but with advantage:

Built-in dataclass support, such as =, repr and asdict. Also, models can be easily encoded into JSON and other formats for human/subagents to read.
Built-in typing annotation. Type checker now can correctly understand field types.
Faster than v1. Using type hints cache, v2 is about 80% of the time in v1 for encoding and decoding.

Not so good points:

v2 typing is longer than v1.
Signature representation is still ugly.
Annotation handling could change with interpreters.
bytes field could actually hold memoryview. Need further effort to improve.

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot

🔵 Needs a closer look

Module shadowing leaves eight migrated examples with invalid attribute lookups that prevent startup or Interest expression.

0 open findings

What changed in this PR

This breaking migration adopts dataclass-based TLV models across python-ndn and makes ndn.app the canonical application API.

Changes:

Migrate protocol models, validators, tools, and examples.
Remove legacy application and schema APIs.
Add wire-format regression tests and update documentation.

File	Description
tests/security/signer_test.py	Assert the new validator contract.
tests/misc/svs_tlv_test.py	Test SVS dataclass wire formats.
tests/misc/security_v2_test.py	Test certificates and SafeBag encoding.
tests/misc/nfd_mgmt_test.py	Test management command and response formats.
tests/misc/light_versec_test.py	Test binary model round trips.
tests/integration/app_v2_test.py	Remove the separate v2 integration suite.
tests/integration/app_test.py	Migrate application tests and cover registration.
tests/encoding/ndnlp_v2_test.py	Extend NDNLP encoding and parsing coverage.
tests/encoding/ndn_format_0_3_test.py	Add packet and signature regression tests.
tests/encoding/ndn_format_0_3_2017_test.py	Test legacy packet-format compatibility.
src/ndn/types.py	Remove legacy callback aliases.
src/ndn/security/validator/known_key_validator.py	Return `ValidResult` from known-key validators.
src/ndn/security/validator/digest_validator.py	Update digest validation; remove legacy composition.
src/ndn/security/validator/cascade_validator.py	Remove the cascade validator.
src/ndn/security/validator/__init__.py	Update validator exports.
src/ndn/schema/util.py	Remove schema pattern utilities.
src/ndn/schema/simple_trust.py	Remove schema trust policies.
src/ndn/schema/simple_node.py	Remove schema resource nodes.
src/ndn/schema/simple_cache.py	Remove schema caching.
src/ndn/schema/schema_tree.py	Remove the namespace schema framework.
src/ndn/schema/policy.py	Remove schema policy interfaces.
src/ndn/schema/__init__.py	Remove the schema package initializer.
src/ndn/name_tree.py	Remove legacy application tree helpers.
src/ndn/encoding/tlv_model_v2.py	Retire the separate v2 codec module.
src/ndn/encoding/ndnlp_v2.py	Convert NDNLP models to dataclasses.
src/ndn/bin/tools/cmd_serve_rdrcontent.py	Switch to canonical application imports.
src/ndn/bin/tools/cmd_serve_data.py	Switch to canonical application imports.
src/ndn/bin/tools/cmd_fetch_rdrcontent.py	Switch to canonical application imports.
src/ndn/bin/tools/cmd_fetch_data.py	Switch to canonical application imports.
src/ndn/bin/nfdc/utils.py	Rename the command-expression helper.
src/ndn/bin/nfdc/cmd_set_strategy.py	Update application and command-helper references.
src/ndn/bin/nfdc/cmd_remove_strategy.py	Update application and command-helper references.
src/ndn/bin/nfdc/cmd_remove_route.py	Update application and command-helper references.
src/ndn/bin/nfdc/cmd_remove_face.py	Use dataclass encoding for face management.
src/ndn/bin/nfdc/cmd_new_route.py	Update command expression.
src/ndn/bin/nfdc/cmd_new_face.py	Pass URI strings to dataclass models.
src/ndn/bin/nfdc/cmd_get_strategy.py	Parse strategy dataclasses.
src/ndn/bin/nfdc/cmd_get_status.py	Parse status dataclasses.
src/ndn/bin/nfdc/cmd_get_route.py	Parse routing dataclasses.
src/ndn/bin/nfdc/cmd_get_face.py	Encode queries and parse face dataclasses.
src/ndn/appv2.py	Remove the separate v2 application module.
src/ndn/app_support/svs/tlv.py	Convert SVS models to dataclasses.
src/ndn/app_support/svs/sync.py	Adopt canonical application and codec APIs.
src/ndn/app_support/segment_fetcher.py	Remove the legacy segment fetcher.
src/ndn/app_support/security_v2.py	Migrate certificate models and signing.
src/ndn/app_support/nfd_mgmt.py	Migrate management models and helpers.
src/ndn/app_support/light_versec/validator.py	Remove legacy LVS validation integration.
src/ndn/app_support/light_versec/binary.py	Convert LVS binary models to dataclasses.
src/ndn/app_support/light_versec/__init__.py	Remove legacy validator imports.
src/ndn/app_support/keychain_register.py	Use canonical application imports.
src/ndn/app_support/dispatcher.py	Remove the legacy dispatcher.
examples/rpc_producer.py	Remove the legacy RPC producer.
examples/rpc_consumer.py	Remove the legacy RPC consumer.
examples/rdrnode.py	Remove the schema-based RDR example.
examples/putchunks.py	Remove the legacy chunk producer.
examples/producer.py	Remove the legacy producer example.
examples/nfd_status.py	Remove the legacy status example.
examples/lvs/producer.py	Remove the legacy LVS producer.
examples/lvs/consumer.py	Remove the legacy LVS consumer.
examples/dpdk_experimental/udp_producer.py	Migrate DPDK producer application references.
examples/dpdk_experimental/udp_consumer.py	Migrate DPDK consumer application references.
examples/consumer.py	Remove the legacy consumer example.
examples/catchunks.py	Remove the legacy chunk consumer.
examples/app/svs/sync_example.py	Migrate SVS application references.
examples/app/keychain_cert/keychain_register.py	Use the canonical application constructor.
examples/app/keychain_cert/fetch_certificate.py	Migrate certificate-fetching application references.
examples/app/forwarding_hint/producer.py	Migrate producer application references.
examples/app/forwarding_hint/consumer.py	Migrate consumer application references.
examples/app/basic_packets/producer.py	Migrate basic producer application references.
examples/app/basic_packets/consumer.py	Migrate basic consumer application references.
docs/src/security/security.rst	Document the new validator contract.
docs/src/schema/utils.rst	Remove schema utility documentation.
docs/src/schema/schema.rst	Remove the schema overview.
docs/src/schema/schema_tree.rst	Remove schema tree documentation.
docs/src/schema/policies.rst	Remove schema policy documentation.
docs/src/schema/ex1.rst	Remove the schema file-sharing tutorial.
docs/src/schema/custom_node.rst	Remove custom-node documentation.
docs/src/lvs/package.rst	Update the type-alias documentation directive.
docs/src/examples/tlv_model.rst	Replace descriptor examples with dataclasses.
docs/src/examples/basic_app.rst	Document canonical consumer and producer APIs.
docs/src/encoding/tlv_model.rst	Document the dataclass codec API.
docs/src/encoding/encoding.rst	Update the encoding overview.
docs/src/appv2.rst	Remove the separate v2 application reference.
docs/src/app.rst	Document the canonical application API.
docs/index.rst	Remove retired documentation entries.
CHANGELOG.rst	Record the breaking migration and removals.

🧠 Review effort: Balanced

Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Co-authored-by: Cursor <cursoragent@cursor.com>

zjkmxy · 2026-10-12T15:53:34Z

@yoursunny Do you mind giving a review of this new version? Thanks!

Copilot

🟡 Changes recommended

Certificate-cache expiration and empty KeyLocator handling leave unresolved validation defects.

2 open issues

_{Review effort: Balanced}

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

🔵 Needs a closer look

The broad breaking API migration and security-sensitive certificate-validation rewrite require final human review.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Handle struct.error from truncated ValidityPeriod TLV

src/ndn/security/validator/cascade_validator.py:360

A truncated multi-byte TLV header inside a fetched certificate's ValidityPeriod raises struct.error, which this handler does not catch. The initial parse_data skips that extension, so a correctly signed certificate with malformed validity data can reach this second parse. The exception escapes the application's validation task and leaves the pending Interest to time out instead of returning ValidResult.FAIL. Import struct and include struct.error in this handler; add a regression test for a truncated nested TLV header.

2 resolved since last review

_{Review effort: Balanced}

zjkmxy · 2026-10-20T01:59:54Z

Test failure on Windows is weird: it seems Cryptodomex is not properly installed and not specifically related to this PR.

yoursunny · 2026-10-20T20:20:34Z

      matrix:
        os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
        python-version: ['3.14', 'pypy-3.11']
+        exclude:


If this is an "upstream error", add a comment linking to the upstream bug report.

It's a very minor case that affects Windows & PyPy3.11 only with Pycryptodomex, where a specific library is missing in building. Current master branch failed it as well:

https://github.com/named-data/python-ndn/actions/runs/37704290209/job/118874937404

I have not found any bug report yet and not have cycle to trace it. Let me add a warning in README about this.

And it's not due to PyCryptodome version 3.24.1. We had successful runs with this version:
https://github.com/named-data/python-ndn/actions/runs/39279816700/job/118151786493

You should not disable a test if you cannot confirm why it's failing.
Instead, keep it enabled and in red until it is investigated.
If needed, you can relax the branch protection rules to merge this PR even if the test is failing.

yoursunny · 2026-10-29T16:34:54Z

      matrix:
        os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
        python-version: ['3.14', 'pypy-3.11']
+        exclude:


You should not disable a test if you cannot confirm why it's failing.
Instead, keep it enabled and in red until it is investigated.
If needed, you can relax the branch protection rules to merge this PR even if the test is failing.

yoursunny · 2026-10-29T16:37:47Z

+import os
+import sys
+
+from ndn import app, encoding as enc, types


All examples should have consistent import syntax.
Previous examples alias this import with app as ndn_app, and keep app as the variable name.
This example use app as import name and ndn_app as variable name.
Choose one convention and apply to all examples.

zjkmxy and others added 7 commits October 7, 2026 23:25

encoding: add dataclass TLV codec to canonical model

dc3c99e

Co-authored-by: Cursor <cursoragent@cursor.com>

encoding: migrate packet and LP models to dataclasses

a9cfd47

Co-authored-by: Cursor <cursoragent@cursor.com>

app-support: migrate protocol models to dataclasses

32f76fd

Co-authored-by: Cursor <cursoragent@cursor.com>

app: promote v2 implementation to ndn.app

5ea1c18

Co-authored-by: Cursor <cursoragent@cursor.com>

app: remove legacy application surfaces

ac29339

Co-authored-by: Cursor <cursoragent@cursor.com>

encoding: remove legacy TLV descriptor API

9144999

Co-authored-by: Cursor <cursoragent@cursor.com>

docs: document breaking dataclass and app APIs

12e89f2

Co-authored-by: Cursor <cursoragent@cursor.com>

zjkmxy requested a balanced review from Copilot October 8, 2026 06:57

Copilot started reviewing on behalf of zjkmxy October 8, 2026 06:57

View session

zjkmxy self-assigned this Oct 8, 2026

Copilot AI reviewed Oct 8, 2026

View reviewed changes

style: use Python 3.11 typing syntax

39afa3f

Co-authored-by: Cursor <cursoragent@cursor.com>

yoursunny suggested changes Oct 13, 2026

View reviewed changes

yoursunny reviewed Oct 13, 2026

View reviewed changes

Comment thread docs/src/encoding/tlv_model.rst

Migrate some obsoleted examples

f20ea04

yoursunny reviewed Oct 14, 2026

View reviewed changes

Comment thread CHANGELOG.rst Outdated

zjkmxy added 2 commits October 18, 2026 11:11

fix: CHANGELOG and cmd_fetch_data bug

4ca2cb3

encoding: Make tlv_field helper class

a69153a

zjkmxy force-pushed the dev3 branch from f8eb5c1 to a69153a Compare October 18, 2026 18:30

docs: Fix document for tlv_model

1e89a7e

zjkmxy requested a balanced review from Copilot October 18, 2026 23:04

Copilot started reviewing on behalf of zjkmxy October 18, 2026 23:05

View session

Copilot AI reviewed Oct 18, 2026

View reviewed changes

Comment thread src/ndn/security/validator/cascade_validator.py

Comment thread src/ndn/app_support/light_versec/validator.py Outdated

lvs: Fix key_locator name check condition

583dbfe

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

yoursunny reviewed Oct 19, 2026

View reviewed changes

Comment thread examples/app/rpc/consumer.py

sec: Add explanations to the limitation of PublicKeyStorage

70aac0d

zjkmxy requested a balanced review from Copilot October 19, 2026 18:02

Copilot started reviewing on behalf of zjkmxy October 19, 2026 18:03

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

fix: catch struct.error in LVS Validator

2ce6567

yoursunny reviewed Oct 20, 2026

View reviewed changes

suraviregmi mentioned this pull request Oct 28, 2026

Changes for new ndn-python updates UCLA-IRL/ndn-python-repo#129

Draft

zjkmxy force-pushed the dev3 branch from cdee4cc to cbfe449 Compare October 29, 2026 12:58

zjkmxy requested a review from yoursunny October 29, 2026 13:02

yoursunny reviewed Oct 29, 2026

View reviewed changes

misc: Correct examples and documentation

f4294ad

zjkmxy force-pushed the dev3 branch from cbfe449 to f4294ad Compare October 30, 2026 02:13

zjkmxy merged commit 827aaaa into named-data:master Oct 30, 2026
7 of 8 checks passed

zjkmxy deleted the dev3 branch October 30, 2026 02:18

Conversation

zjkmxy commented Oct 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

zjkmxy commented Oct 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

zjkmxy commented Oct 20, 2026

Uh oh!

yoursunny Oct 20, 2026

Choose a reason for hiding this comment

Uh oh!

zjkmxy Oct 20, 2026

Choose a reason for hiding this comment

Uh oh!

zjkmxy Oct 20, 2026

Choose a reason for hiding this comment

Uh oh!

yoursunny Oct 29, 2026

Choose a reason for hiding this comment

Uh oh!

yoursunny Oct 29, 2026

Choose a reason for hiding this comment

Uh oh!

yoursunny Oct 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants