Skip to content

Document json_namespace usage #6069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2023
+4 −0
Merged

Document json_namespace usage #6069

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/dev/serialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ and pass `cirq-core/cirq/protocols/json_serialization_test.py`:
containing keys for each of the value's attributes. If these keys do not match the names of
the class' initializer arguments, a `_from_json_dict_` class method must also be defined.

a. Public classes not in the `cirq` module (e.g. `cirq_google.EngineResult`) are also expected
to define a `_json_namespace_` method which returns a prefix to attach to the serialized name.
This is important for preventing name collisions between third-party classes.

2. In `class_resolver_dictionary` within the packages's `json_resolver_cache.py` file,
for each serializable class, the `cirq_type` of the class should be mapped to the imported class
within the package. The key may also be mapped to a helper method that
Expand Down