Create python tutorial. #1648

gogo2464 · 2023-07-10T07:31:42Z

I am going to reuse my template for the tutorial.

gogo2464 · 2023-07-10T12:05:47Z

The minimal example compiles. I tested it in my system. Do you would like cicd to test it?

mhammond

This is looking in reasonable shape, thanks! Many of the files are missing newline characters at the end of the file, and we probably should not assume the reader is running Windows, but I'm not quite sure what we should do there yet. It would also be great if we can work out how to set setup.py to be the smallest possible example - I think there's a fair bit there that isn't strictly necessary and it's already complex enough that anything which isn't necessary is likely to confuse the reader.

docs/manual/src/python/setup.md

mhammond · 2023-07-10T13:12:27Z

examples/distributing/uniffi-rust-to-python-library/Cargo.toml

@@ -0,0 +1,23 @@
+[package]


I think the directory name could be just "python"

mhammond · 2023-07-10T13:13:08Z

examples/distributing/uniffi-rust-to-python-library/README.md

+
+# Building
+
+.\run.bat


This is Windows specific so should probably be removed

examples/distributing/uniffi-rust-to-python-library/out/file.txt

examples/distributing/uniffi-rust-to-python-library/src/math.rs

examples/distributing/uniffi-rust-to-python-library/src/setup.py

mhammond · 2023-07-10T13:32:32Z

examples/distributing/uniffi-rust-to-python-library/src/setup.py

+    return "10.7"
+
+
+# The logic for specifying wheel tags in setuptools/wheel is very complex, hard


I don't think we need this complexity for this sample - I think it's fine if the target only runs on the Python version it was built with.

I agree. This looks like the horrible hack we did over in Glean. And the proper way and IMO what we should recommend is using something like maturin (e.g. see mozilla/glean#2345).
Though for a small example I'm fine with a minimal setup.py still.

I must watch your PR but it is a draft.

@badboy I watched your incomming PR. It seems also very much better with .pytoml. @mhammond can I keep the current work as legacy or should I immediately rewrite it please?

at this moment I work with maturin.

I think @badboy and I are both saying that for this trivial example, there's no need to use maturin. It might make good sense for your project, but for the purposes of this example, we should aim for it being as small as reasonably possible.

examples/distributing/uniffi-rust-to-python-library/run.bat

gogo2464 · 2023-07-10T13:55:10Z

I agree. This example is long. I might remove class build(_build): content. But then I will need to run 2 commands from batch or from bash.

docs/manual/src/python/setup.md

mhammond · 2023-07-11T15:51:55Z

examples/distributing/uniffi-rust-to-python-library/Cargo.toml

+
+[dependencies]
+uniffi = {version = "*", features = [ "cli" ]}
+uniffi_macros = "*"


These all seem odd - you probably want to do what the other examples do, and I don't think this example needs a direct dependency on uniffi_macros or on uniffi_bindgen

gogo2464 · 2023-07-11T17:57:32Z

for a weird reason the tesing fails without uniffi_macro = "*"

gogo2464 · 2023-07-11T18:37:34Z

It does not fails with uniffi_macro. Let me try without and with a rebase please.

gogo2464 · 2023-07-11T21:05:18Z

Yes I maintain that the cicd does not pass over with not uniffi_macro.

badboy · 2023-07-12T08:42:10Z

Yes I maintain that the cicd does not pass over with not uniffi_macro.

Then that's an issue we should address. We're not gonna recommend star-dependencies in official examples; example should showcase best practices.

gogo2464 · 2023-07-12T08:50:39Z

I have already reported. I have not found why it still works with not uniffi_macro for some people. #1645

badboy · 2023-07-17T15:55:00Z

Just as a note: I'll try to help pushing this forward tomorrow.

badboy

I appreciate the effort, but after going through this I think it's easier if I take this over and prepare a minimal example we can land.

badboy · 2023-07-12T08:42:41Z

docs/manual/src/python/setup.md

+python3 ./src/setup.py bdist_wheel --verbose ;
+pip3 install ./dist/* --force-reinstall ;


No need for semicolons

Suggested change

python3 ./src/setup.py bdist_wheel --verbose ;

pip3 install ./dist/* --force-reinstall ;

python3 ./src/setup.py bdist_wheel --verbose

pip3 install ./dist/* --force-reinstall

oh fwiw, I think we should just go ahead and recommend python3 -m build instead of now deprecated ways.

badboy · 2023-07-20T12:29:05Z

Cargo.toml

@@ -19,6 +19,7 @@ members = [
  "examples/sprites",
  "examples/todolist",
  "examples/traits",
+  "examples/distributing/uniffi-rust-to-python-library",


Why the subfolder?

Somebody told me to create a distributing subfolder.

docs/manual/src/SUMMARY.md

docs/manual/src/python/setup.md

gogo2464 · 2023-07-21T11:09:33Z

I appreciate the effort, but after going through this I think it's easier if I take this over and prepare a minimal example we can land.

yes sure. Then I will update.

gogo2464 · 2023-08-11T09:19:34Z

Hello. I am confused. Is it expected to wait for the new python template .pytoml in order to document it or can I continue with setup.py?

badboy · 2023-08-11T09:49:50Z

Hey, sorry. I didn't yet have time to work on this. As I said I will take this over and prepare the docs in a way we want to land them. There's currently no more work for you to be done.

gogo2464 · 2023-08-11T10:07:17Z

Alright. Do I document the old way with a deprecated mention in the doc?

gogo2464 · 2023-08-11T10:07:28Z

or I just wait at least.

gogo2464 · 2023-08-28T09:01:25Z

Hey, sorry. I didn't yet have time to work on this. As I said I will take this over and prepare the docs in a way we want to land them. There's currently no more work for you to be done.

alright. I spent some days to code. It could be fine if I can merge something. Tell me if it is not necessary please?

frebib · 2023-11-11T12:19:47Z

examples/distributing/uniffi-rust-to-python-library/Cargo.toml

+uniffi = { version = "*", features = [ "build", "cli" ] }
+
+[[bin]]
+# This can be whatever name makes sense for your project, but the rest of this tutorial assumes uniffi-bindgen.


As a noob, this is pretty confusing because it makes it ambiguous to whether the intention is to reference this uniffi-bindgen or the uniffi binary tool uniffi-bindgen

gogo2464 · 2023-11-29T21:09:13Z

Hello I read the page https://mozilla.github.io/uniffi-rs/python/configuration.html . Is this issue fixed? We may could set my way for an optional python tutorial on the old setup.py?

gogo2464 force-pushed the document-python2 branch 4 times, most recently from 00bcf45 to 122a1e1 Compare July 10, 2023 12:01

gogo2464 marked this pull request as ready for review July 10, 2023 12:02

gogo2464 requested a review from a team as a code owner July 10, 2023 12:02

gogo2464 requested review from bendk and removed request for a team July 10, 2023 12:02

gogo2464 force-pushed the document-python2 branch from 122a1e1 to 8e2fbbd Compare July 10, 2023 12:09

mhammond reviewed Jul 10, 2023

View reviewed changes

gogo2464 force-pushed the document-python2 branch from 8e2fbbd to 3c5442f Compare July 11, 2023 14:27

mhammond reviewed Jul 11, 2023

View reviewed changes

gogo2464 force-pushed the document-python2 branch 9 times, most recently from 079470c to a78acae Compare July 11, 2023 17:40

gogo2464 force-pushed the document-python2 branch from a78acae to 404e29c Compare July 11, 2023 18:23

gogo2464 force-pushed the document-python2 branch from 404e29c to 6797d81 Compare July 11, 2023 18:40

Create python tutorial.

929bd10

gogo2464 force-pushed the document-python2 branch from 6797d81 to 929bd10 Compare July 11, 2023 20:16

badboy requested changes Jul 20, 2023

View reviewed changes

frebib reviewed Nov 11, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create python tutorial. #1648

Create python tutorial. #1648

gogo2464 commented Jul 10, 2023

gogo2464 commented Jul 10, 2023

mhammond left a comment

mhammond Jul 10, 2023

mhammond Jul 10, 2023

mhammond Jul 10, 2023

badboy Jul 11, 2023

gogo2464 Jul 11, 2023

gogo2464 Jul 11, 2023 •

edited

gogo2464 Jul 11, 2023

mhammond Jul 11, 2023

gogo2464 commented Jul 10, 2023

mhammond Jul 11, 2023

gogo2464 commented Jul 11, 2023

gogo2464 commented Jul 11, 2023

gogo2464 commented Jul 11, 2023

badboy commented Jul 12, 2023

gogo2464 commented Jul 12, 2023

badboy commented Jul 17, 2023

badboy left a comment

badboy Jul 12, 2023

badboy Jul 20, 2023

badboy Jul 20, 2023

gogo2464 Jul 21, 2023

gogo2464 commented Jul 21, 2023

gogo2464 commented Aug 11, 2023

badboy commented Aug 11, 2023

gogo2464 commented Aug 11, 2023

gogo2464 commented Aug 11, 2023

gogo2464 commented Aug 28, 2023

frebib Nov 11, 2023

gogo2464 commented Nov 29, 2023

		return "10.7"


		# The logic for specifying wheel tags in setuptools/wheel is very complex, hard

		python3 ./src/setup.py bdist_wheel --verbose ;
		pip3 install ./dist/* --force-reinstall ;


		# Building

		.\run.bat

Create python tutorial. #1648

Are you sure you want to change the base?

Create python tutorial. #1648

Conversation

gogo2464 commented Jul 10, 2023

gogo2464 commented Jul 10, 2023

mhammond left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gogo2464 Jul 11, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gogo2464 commented Jul 10, 2023

Choose a reason for hiding this comment

gogo2464 commented Jul 11, 2023

gogo2464 commented Jul 11, 2023

gogo2464 commented Jul 11, 2023

badboy commented Jul 12, 2023

gogo2464 commented Jul 12, 2023

badboy commented Jul 17, 2023

badboy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gogo2464 commented Jul 21, 2023

gogo2464 commented Aug 11, 2023

badboy commented Aug 11, 2023

gogo2464 commented Aug 11, 2023

gogo2464 commented Aug 11, 2023

gogo2464 commented Aug 28, 2023

Choose a reason for hiding this comment

gogo2464 commented Nov 29, 2023

gogo2464 Jul 11, 2023 •

edited