Turn on and fix Python linting of examples #1191

emilk · 2023-02-10T19:41:39Z

Mostly superficial fixes, but one important:

- except:
+ except Exception:

The first also catches KeyboardInterrupt, which is quite annoying when you are trying to Ctrl-C an example.

TODO:

Run just py-run-all

Checklist

I have read and agree to Contributor Guide and the Code of Conduct
I've included a screenshot or gif (if applicable)
I've added a line to CHANGELOG.md (if this is a big enough change to warrant it)

Wumpf

TIL string interpolation in python can't do multiline

examples/dicom/main.py

Wumpf · 2023-02-11T09:15:06Z

examples/deep_sdf/dataset/dataset.py

@@ -85,7 +85,7 @@ def download_and_extract(url: str, path: Path) -> None:
 def download_glb_sample(name: str) -> Path:
    """Downloads a sample glb mesh and returns the path it was downloaded to."""
    capitalized_name = name.capitalize()
-    url = f"https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true"
+    url = f"https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true"  # noqa: E501 line too long


pep8 says https://stackoverflow.com/a/54950733

Suggested change

url = f"https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true" # noqa: E501 line too long

url = (

"https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/"

f"{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true"

)

no, didn't work

Wumpf · 2023-02-11T09:17:12Z

examples/multiprocessing/main.py

@@ -20,14 +18,14 @@ def task(title: str) -> None:

    rr.log_text_entry(
        "log",
-        text=f"Logging from pid={os.getpid()}, thread={threading.get_ident()} using the rerun recording id {rr.get_recording_id()}",
+        text=f"Logging from pid={os.getpid()}, thread={threading.get_ident()} using the rerun recording id {rr.get_recording_id()}",  # noqa: E501 line too long


Suggested change

text=f"Logging from pid={os.getpid()}, thread={threading.get_ident()} using the rerun recording id {rr.get_recording_id()}", # noqa: E501 line too long

text=(

f"Logging from pid={os.getpid()}, thread={threading.get_ident()} "

f"using the rerun recording id {rr.get_recording_id()}",

)

nope, didn't work

Wumpf · 2023-02-11T09:19:14Z

scripts/lint.py

-        'Wasm',
-        'num_instances',
-        'instances_count',
+        "if let Err(err) = foo",


but why are the above still in ticks?

because they contain "

Co-authored-by: Andreas Reich <[email protected]>

* Turn on python linting of examples * Fix minor lints * Mute lints about bad docstrings * Use list() instead of trivial list comprehension * ignore some lines, fix others * don't use single-letter names * ignore line * `catch:` -> `catch Exception:` * Dict comprehension * format * Docstring improvements * More docstring fixes * Docstring fixes * docstrings done! * Enable and fix more lints * One more * Clean up .flake8 file * Final cleanup of .flake8 * Also lint python scripts under scripts/ * py-format * better dicom explanation Co-authored-by: Andreas Reich <[email protected]> --------- Co-authored-by: Andreas Reich <[email protected]>

* Split python and rust examples into separate folders * objectron: ensure logging reaches the screen * try fix * remove dead shellscript * fix objectron build-script * Fixes * Fix Rust objectron demo * Add readme for rust examples * lint * fix mypy * Improve the docs of `rerun` (#1179) * Split out the `run` parts of the rerun library to its own file * Document that the web feature flag requires running scripts/setup_web.sh * Improve the docs of rerun and re_sdk * Describe more things * Fix warning * More docs, and split out `coordinates` into its own module * nit comment Co-authored-by: Andreas Reich <[email protected]> * Improve docstring * Improve error message * Add some spacing * For instance -> For example --------- Co-authored-by: Andreas Reich <[email protected]> * Add newlines before types, `impl`, `fn`, and docstrings * Update examples/requirements.txt * Mark git directories as safe for our docker_ci container and fix cargo caching (#1187) * Mark git directories as safe for our docker_ci container * New cargo packages means a new cache key * Add CACHE_KEY everywhere and Only update cache from 1 location * Run cargo check after patching pre-release (#1190) * Allow logging the contents of an image file, not by path (#1193) * log_image_file: require named arguments * Allow logging the contents of an image file, not by path * Add --dataset and --resize flags to colmap (#1177) * Add --dataset and --resize flags to colmap * Enable `--web-viewer` in the Python Wheels (#1182) * Make 'web' a default feature of the python sdk * Add sanity-checking to crates/re_web_server/build.rs * Allow crates/re_web_server/build.rs to be run from any CWD * Run setup_web.sh on the Python CI * Turn on the web feature on the CI * Only enable the web feature when building pypi package * Improve setup_web.sh * Add winget package manager to setup_web.sh * Print out what is happening * Add shell: bash * Try getting wasm-opt into the windows build * Correct path to exe * run setup_web.sh but allow it to fail --------- Co-authored-by: Jeremy Leibs <[email protected]> * Install web dependencies before running cargo check (#1196) * Update arrow2, arrow2_convert and polars (#1189) * Update arrow2, arrow2_convert and polars * Patch arrow2-convert again * Add instructions for how to patch crates to Cargo.toml * Use trunk polars in patch * Turn on and fix Python linting of examples (#1191) * Turn on python linting of examples * Fix minor lints * Mute lints about bad docstrings * Use list() instead of trivial list comprehension * ignore some lines, fix others * don't use single-letter names * ignore line * `catch:` -> `catch Exception:` * Dict comprehension * format * Docstring improvements * More docstring fixes * Docstring fixes * docstrings done! * Enable and fix more lints * One more * Clean up .flake8 file * Final cleanup of .flake8 * Also lint python scripts under scripts/ * py-format * better dicom explanation Co-authored-by: Andreas Reich <[email protected]> --------- Co-authored-by: Andreas Reich <[email protected]> * Update the paths in .flake8 * examples/deep_sdf: sort scenes by relevance instead of lexically + better default one * examples/raw_mesh: sort scenes by relevance instead of lexically + better default one * examples/raw_mesh: now offering a higher level --scene flag --------- Co-authored-by: Clement Rey <[email protected]> Co-authored-by: Andreas Reich <[email protected]> Co-authored-by: Jeremy Leibs <[email protected]>

emilk changed the title ~~Turn on python linting of examples~~ Turn on and fix Python linting of examples Feb 10, 2023

emilk marked this pull request as ready for review February 10, 2023 22:58

Wumpf approved these changes Feb 11, 2023

View reviewed changes

emilk and others added 21 commits February 11, 2023 10:50

Turn on python linting of examples

bfa04ec

Fix minor lints

0db86df

Mute lints about bad docstrings

d4c7009

Use list() instead of trivial list comprehension

ed0256c

ignore some lines, fix others

9311880

don't use single-letter names

40e62e7

ignore line

a7b639e

catch: -> catch Exception:

e4280b5

Dict comprehension

1e3fcda

format

88ba142

Docstring improvements

22354c7

More docstring fixes

dc49b29

Docstring fixes

07b6344

docstrings done!

cbb3d34

Enable and fix more lints

daa8937

One more

14a63a9

Clean up .flake8 file

e48988d

Final cleanup of .flake8

448ee38

Also lint python scripts under scripts/

c9f5db2

py-format

74db29f

better dicom explanation

e230757

Co-authored-by: Andreas Reich <[email protected]>

emilk force-pushed the emilk/lint-examples branch from 2825069 to e230757 Compare February 11, 2023 09:52

emilk merged commit 49cea4c into main Feb 11, 2023

emilk deleted the emilk/lint-examples branch February 11, 2023 10:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Turn on and fix Python linting of examples #1191

Turn on and fix Python linting of examples #1191

emilk commented Feb 10, 2023 •

edited

Loading

Wumpf left a comment

Wumpf Feb 11, 2023

emilk Feb 11, 2023

Wumpf Feb 11, 2023 •

edited by emilk

Loading

emilk Feb 11, 2023

Wumpf Feb 11, 2023

emilk Feb 11, 2023

-    url = f"https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true"  # noqa: E501 line too long
+    url = (
+        "https://github.com/KhronosGroup/glTF-Sample-Models/blob/master/2.0/"
+        f"{capitalized_name}/glTF-Binary/{capitalized_name}.glb?raw=true"
+    )

-        text=f"Logging from pid={os.getpid()}, thread={threading.get_ident()} using the rerun recording id {rr.get_recording_id()}",  # noqa: E501 line too long
+        text=(
+            f"Logging from pid={os.getpid()}, thread={threading.get_ident()} "
+            f"using the rerun recording id {rr.get_recording_id()}",
+        )

Turn on and fix Python linting of examples #1191

Turn on and fix Python linting of examples #1191

Conversation

emilk commented Feb 10, 2023 • edited Loading

TODO:

Checklist

Wumpf left a comment

Choose a reason for hiding this comment

Wumpf Feb 11, 2023

Choose a reason for hiding this comment

emilk Feb 11, 2023

Choose a reason for hiding this comment

Wumpf Feb 11, 2023 • edited by emilk Loading

Choose a reason for hiding this comment

emilk Feb 11, 2023

Choose a reason for hiding this comment

Wumpf Feb 11, 2023

Choose a reason for hiding this comment

emilk Feb 11, 2023

Choose a reason for hiding this comment

emilk commented Feb 10, 2023 •

edited

Loading

Wumpf Feb 11, 2023 •

edited by emilk

Loading