-
Notifications
You must be signed in to change notification settings - Fork 373
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.
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
File-like entity paths #4476
Merged
Merged
File-like entity paths #4476
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emilk
force-pushed
the
emilk/better-entity-paths-2
branch
from
December 12, 2023 14:52
9001f39
to
7201623
Compare
jleibs
approved these changes
Dec 12, 2023
Comment on lines
+37
to
+38
In other words, the `log` call is akin to creating a folder with `mkdir -p` and then writing files (components) to it. | ||
Existing components of the same name will be overwritten. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still liking this analogy!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
me too :)
Co-authored-by: Jeremy Leibs <[email protected]>
Co-authored-by: Jeremy Leibs <[email protected]>
emilk
added
include in changelog
🪵 Log & send APIs
Affects the user-facing API for all languages
labels
Dec 13, 2023
4 tasks
emilk
added a commit
that referenced
this pull request
Dec 13, 2023
### What The new label "🪵 Log API" means "stuff that affects all the APIs". This include changes to `re_types` and (relevantly) changes to how entity paths works (#4476). I also gave uniform names to the other labels: * 🌊 C++ API * 🐍 Python API * 🦀 Rust API _some_ of these used "SDK" before, but that felt too over-arching since SDK implies a full kit, including the `rerun` binary, the web viewer, etc - but the language specific things is just the API surface. ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Full build: [app.rerun.io](https://app.rerun.io/pr/4508/index.html) * Partial build: [app.rerun.io](https://app.rerun.io/pr/4508/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) - Useful for quick testing when changes do not affect examples in any way * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG - [PR Build Summary](https://build.rerun.io/pr/4508) - [Docs preview](https://rerun.io/preview/a9278cf8ec9bc1353be9910bd2c4394642a64308/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/a9278cf8ec9bc1353be9910bd2c4394642a64308/examples) <!--EXAMPLES-PREVIEW--> - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This is a breaking change, though in most cases it is a cosmetic one.
This PR makes entity paths work a lot more similar to file paths.
There is no need for
"
quotes around path parts, instead we now use\
to escape special characters.You need to escape any character that isn't alphabetical, numeric,
.
,-
, or_
.Before:
world/"My Image.jpg"/detection
After:
world/My\ Image.jpg/detection
The entity path parser is very liberal in what it accepts (in fact, it never errors), but it will log a warning if the entity path doesn't follow the normalized form.
NOTE: unicode characters do NOT need escaping, so
värld/bil
is a valid entity path.We also support unicode escapes like
\u{211D}
.More details here: #4464
Checklist