Configuration integration #184

ZacZhangzhuo · 2023-10-20T16:54:25Z

Request @Licini for a detailed review, and a Major release for this update.
This should update and close Mouse and keyboard combination profile #172 close key actions #77 close Concept Diagram Check #183

CHANGELOG

Remove the scripts folder as it is duplicated with the examples folder, and the other COMPAS packages do not contain this folder.
Add example example_custom_keys.py in the examples/control.
Update the example files in the tutorial.
Update the software architecture diagram in the documentation.
Update the UI naming conventions diagram in the documentation.
Add the Tutorial Software Concepts section in the documentation.
Add the Tutorial Configuration section in the documentation.
Action class which controls all the key actions.
Categorize all the view settings into one config file.

Checklist

I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
I ran all tests on my computer and it's all green (i.e. invoke test).
I ran lint on my computer and there are no errors (i.e. invoke lint).
I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
I have added tests that prove my fix is effective or that my feature works.
I have added the necessary documentation (if appropriate)

Quick Description

Key customization possible.
All the settings are configuration-based.
Diagrams and new examples for the documentation.

Have a good weekend :)

…s_view2 into example-files

ZacZhangzhuo · 2023-10-21T08:07:33Z

I went through invoke lint and invoke test on my machine. But I still got build errors:

Cannot load backend 'Qt5Agg' which requires the 'qt5' interactive framework, as 'headless' is currently running

Looks like an error unrelated to my change.
https://stackoverflow.com/questions/56129786/cannot-load-backend-qt5agg-which-requires-the-qt5-interactive-framework-as

Maybe need help from @Licini

Licini

Just some initial feedbacks here and there, could you rebase this branch on the latest main, so that the file change history of example-files don't get mixed in ?
A quick tutorial here:
https://www.youtube.com/watch?v=_UZEXUrj-Ds

PS: a general advice is that this PR is too large, I understand it is difficult for structural changes like this, in the future plz break it down as much as you can, a rule of thumb is to make each PR under 10 files (for non-repetitive edits).

Licini · 2023-10-23T08:24:36Z

src/compas_view2/__init__.py

@@ -1,10 +1,12 @@
 import os
+from .helpers import *  # noqa: F401, F403


You don't need this here. And it is the reason is the test failed

Licini · 2023-10-23T08:24:49Z

src/compas_view2/__init__.py

@@ -35,4 +37,4 @@ def new_util_find_library(name):
    util.find_library = new_util_find_library


-__all__ = ["HOME", "DATA", "DOCS", "TEMP", "DATA_OBJECT", "register"]
+__all__ = ["HOME", "DATA", "DOCS", "TEMP", "DATA_OBJECT", "register"]  # noqa: F405


Why is this added?

Licini · 2023-10-23T08:28:19Z

src/compas_view2/helpers/__init__.py

Could you elaborate a bit what does helper folder do? (we can discuss in person if too much to write)

Licini · 2023-10-23T08:31:10Z

src/compas_view2/app/app.py

@@ -16,6 +14,8 @@

 from functools import partial

+from typing import Literal, Tuple


move it up and keep it consistent with previous import?

Licini · 2023-10-23T08:36:09Z

src/compas_view2/app/app.py

+        if title:
+            config["app"]["title"] = title
+        if version:
+            config["app"]["version"] = version
+        if width:
+            config["app"]["width"] = width
+        if height:
+            config["app"]["height"] = height
+
+        if viewmode:
+            config["view"]["viewmode"] = viewmode
+        if show_grid:
+            config["view"]["show_grid"] = show_grid
+
+        if enable_sidebar:
+            config["sidebar"]["enable_sidebar"] = enable_sidebar
+
+        if enable_sidedock1:
+            config["sidedocks"]["enable_sidedock1"] = enable_sidedock1
+        if enable_sidedock2:
+            config["sidedocks"]["enable_sidedock2"] = enable_sidedock2
+        if enable_sceneform:
+            config["sidedocks"]["enable_sceneform"] = enable_sceneform
+        if enable_propertyform:
+            config["sidedocks"]["enable_propertyform"] = enable_propertyform
+
+        if show_flow:
+            config["flow"]["show_flow"] = show_flow
+        if flow_view_size:
+            config["app"]["flow_view_size"] = flow_view_size
+        if flow_auto_update:
+            config["app"]["flow_auto_update"] = flow_auto_update


It is safer to use if xxx is not None:

Licini · 2023-10-23T08:48:41Z

src/compas_view2/actions/__init__.py

+from .view_capture import ViewCapture  # noqa : F401
+
+
+def mouse_key_check(event, key_status: Dict, mouse_key: Dict):


These functions should be move to a file, like checks.py

Licini · 2023-10-23T08:49:40Z

src/compas_view2/actions/action.py

+from qtpy import QtCore
+
+
+def supported_keys():


Why not directly a variable like SUPPORTED_KEYS = {...} instated of function?

Licini · 2023-10-23T08:51:43Z

data/rst_generator.py

Now I think about this, this file should be in scriptes/, and all example files currently there should be moved to a new folder called examples/, but let's make that a separate PR later

ZacZhangzhuo · 2023-10-23T14:16:45Z

Aha, then this should be good @Licini . My fork is up-to-date now.

ZacZhangzhuo · 2023-12-06T12:13:56Z

close since it has been separately integrated

ZacZhangzhuo and others added 10 commits October 6, 2023 12:15

file name changed, example files created

5a13e54

add example files and .rst files

59724ac

changelog and lint

3e35e0e

ready to merge

7151b28

Merge branch 'main' into example-files

6e35887

image replaced

ef3ae56

Merge branch 'example-files' of https://github.com/ZacZhangzhuo/compa…

7c0c221

…s_view2 into example-files

half-way changes

7de5856

halfway commit

5b6976c

ready for the PR

3fbf237

ZacZhangzhuo requested a review from Licini October 20, 2023 16:54

ZacZhangzhuo added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 20, 2023

ZacZhangzhuo assigned Licini Oct 20, 2023

ZacZhangzhuo added 3 commits October 20, 2023 19:12

update

cd8bb6b

update

d2eda13

Add Developer Guide Section

5f110af

Licini suggested changes Oct 23, 2023

View reviewed changes

update based on the comments

453a391

ZacZhangzhuo requested a review from Licini October 23, 2023 11:44

ZacZhangzhuo mentioned this pull request Oct 23, 2023

Config integration rebased #185

Closed

2 tasks

rebased

0540915

Multi Selection in the Sceneform

1056df6

ZacZhangzhuo closed this Dec 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configuration integration #184

Configuration integration #184

ZacZhangzhuo commented Oct 20, 2023 •

edited

Loading

ZacZhangzhuo commented Oct 21, 2023

Licini left a comment

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

Licini Oct 23, 2023

ZacZhangzhuo commented Oct 23, 2023

ZacZhangzhuo commented Dec 6, 2023

		@@ -1,10 +1,12 @@
		import os
		from .helpers import * # noqa: F401, F403

		@@ -16,6 +14,8 @@

		from functools import partial

		from typing import Literal, Tuple

		from .view_capture import ViewCapture # noqa : F401


		def mouse_key_check(event, key_status: Dict, mouse_key: Dict):

Configuration integration #184

Configuration integration #184

Conversation

ZacZhangzhuo commented Oct 20, 2023 • edited Loading

CHANGELOG

Checklist

Quick Description

ZacZhangzhuo commented Oct 21, 2023

Licini 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZacZhangzhuo commented Oct 23, 2023

ZacZhangzhuo commented Dec 6, 2023

ZacZhangzhuo commented Oct 20, 2023 •

edited

Loading