Add support for external_packages to Python so Python packages can …
#1784
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
mhammond
force-pushed
the
python-package
branch
from
dd2b6b6 to
49af6e9
Compare
jhugman
approved these changes
Oct 16, 2023
Comment on lines
+101
to
+108
| pub fn module_for_namespace(&self, ns: &str) -> String { | ||
| let ns = ns.to_string().to_snake_case(); | ||
| match self.external_packages.get(&ns) { | ||
| None => format!(".{ns}"), | ||
| Some(value) if value.is_empty() => ns, | ||
| Some(value) => format!("{value}.{ns}"), | ||
| } | ||
| } |
badboy
approved these changes
Oct 18, 2023
| @@ -8,10 +8,34 @@ The generated Python modules can be configured using a `uniffi.toml` configurati | |||
| | ------------------ | ------- |------------ | | |||
| | `cdylib_name` | `uniffi_{namespace}`[^1] | The name of the compiled Rust library containing the FFI implementation (not needed when using `generate --library`). | | |||
| | `custom_types` | | A map which controls how custom types are exposed to Python. See the [custom types section of the manual](../udl/custom_types#custom-types-in-the-bindings-code)| | |||
| | `external_packages` | `.` | A map which controls the package name used by external packages. | |||
There was a problem hiding this comment.
This is a bit confusing in the docs, the default is given as . but the text says this should be a map.
I would expect that I can set external_packages = "." to get the same default behavior, but that doesn't work.
And thus now from only the docs it's not clear how to configure this. It's then explained in the next lines, maybe the table should call this out? "Look further down for details"
There was a problem hiding this comment.
yeah, thanks, I made a few other tweaks to make that clearer too.
…be used. When using external types, the expectation is that most consumers will want to use a Python package which holds all the modules - therefore, imports for external types defaults to `from .module import name`. This behaviour can be changed to support any package name, including just doing a regular top-level module import - which we leverage for some tests. Fixes mozilla#1776
mhammond
force-pushed
the
python-package
branch
from
49af6e9 to
b375663
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…be used.
When using external types, the expectation is that most consumers will want to use a Python package which holds all the modules - therefore, imports for external types defaults to
from .module import name. This behaviour can be changed to support any package name, including just doing a regular top-level module import - which we leverage for some tests.Fixes #1776
(While this seems sensible to me, feel free to push back on either the implementation or the default)