Protected/Private has attributes should be omitted when report

[ypkang]

Describe the feature you'd like

Private has variables should be omitted when reported.

Examples

node Doc {
  has text: str = "This is a text".
  has:priv embedding: list[float];
}

d = Doc();
report d;

The reported data of node d should not include the private attribute embeddings.

[ypkang]

@amadolid I think this one is pretty straightforward. If you also agree this makes sense, you can go ahead and pick this up.

[amadolid]

I don't think private annotation is the right annotation for this as It's usually for inheritance and encapsulation. In this context, it will describe the embedding is private and only accessible in node Doc while also not declaring a method or process how to manipulate it on the same node.

On other OOP, we usually annotate it to be ignored during de serialization via decorator. Example

@json_ignore("field1", "field2")
node Doc {}
#or

node Doc {
   class MetaData:
      json_ignore = ["field1", "field2"]
}

There's multiple way to override it but I think the proper way is to use decorator or override __serialize__ method

[amadolid]

Additional,

Using this approach will also affect how we communicate to other external services (ex: databases, 3rd party service).
We will need to maintain 2 serialization method for report and database serialization.

The most common practice on known frameworks is by having a single serialization per model and convert it to another DTO to have a safer/cleaner/direct structure for response (report). Having a custom ability for report, ex report node1.custom_report();, might be better than just depending on access modifier (private, protect, public).