OOP implementation and improve preferences UX #14
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
Also add 'Documentation' button to the add-on preferences menu and rewrite `bl_info`.
- Free `__init__.py` from a bunch of processing code, keeping concern on metadata only. Now all code for preferences, menus and keymaps belongs to `preferences.py`; `operators.py` is responsible for all operators. - Every module is responsible for registering and unregistering its components from now. - Push `bl_info` to the top of the file, so we have to ignore E402 of 'Flake8' from `__init__.py`.
- Implement first OOP way to handle clipboard for `LinuxClipboard`. Some
classes are used to support:
- `Clipboard`: an abstract class to handle the clipboard.
- `Process`: a class to handle command line process with safe
`Popen.communicate()`.
- `Report`: a class to generate a report for operations status.
- `Image`: a class to hold image information.
- Also rewrite all the operators to fit the new OOP way.
- Add `poll()` method to all operators to let them execute on the right
context.
- Default directory currently takes `.blend` files (if possible) or
'Blender' temporary folder `bpy.app.tempdir`, it will be deleted after
closing session, user won't have to specify it anymore. Improve this
to be more flexible later.
- Most operations now explicitly inform users about its status, include
logging on the console for debugging purpose.
- Add docstring to most of the classes and functions.
- Currently disable 'Windows' and 'Darwin' clipboard support.
- Also fix a bug that make old implementation cannot copy a JPG image
(or other types except PNG) from the Image Editor to the clipboard
with guesstimated MIME types.
- Implement the `WindowsClipboard` class following OOP using old
approach, still really slow.
- Fix the missing f-string sign in `LinuxClipboard.push()`.
- Turn `__str__` into `__repr__` for `Report`.
- Add `split` options for output of a process.
- Reinforce the context in `poll()` for all operators. Allow operators
related to Image Editor run on both Image Editor and UV Editor.
Attention: 'Python' API changes the `bpy.area.ui_type` of Image Editor
from `VIEW` ('Blender' 2.83) to `IMAGE_EDITOR` ('Blender' 2.93). Both
areas still have the same `bpy.area.type` value (`IMAGE_EDITOR`).
- Rewrite all operators docstring to be more friendly on 'Blender' UI
because they're used to display hover tooltips.
- Prioritize using `from ... import ...` more than `import ...` in
`image` module.
Using previous approach with `osascript`. Haven't tested yet, to be reviewed in #14.
thanhph111
force-pushed
the
oop-implementation
branch
from
94f69a4
to
001e5b8
Compare
|
@williamchange I am implementing the OOP version of macOS clipboard based on your code, but don't have any knowledge to do the test. Can you help me with this? |
thanhph111
changed the title
This will add an 'Report a Bug' button to the add-on preferences.
The docstrings for operators should be short, no period and contain no context as they will be display under UI.
- `IMAGEPASTE_OT_imageeditor_copy` operator should check if loaded image is not an empty render result. - `IMAGEPASTE_OT_shadereditor_paste` operator should check if a material is loading.
- Reference: "We often put imports within functions body which is not pep8 compliant. This is done to speed up Blender's startup times to avoid loading in many files and libraries which the user may never access." (https://wiki.blender.org/wiki/Style_Guide/Python). - Also improve condition checking accuracy. - Also remove `universal_newlines` argument from `subprocess.Popen` as it's an alias for `text` argument.
|
I just checked it out, fixed a couple of issues and opened a PR for it. But there's still some other issues. |
- Add new preferences UI with:
- An option to use another directory for images instead of the
temporary directory, including another option to force use it.
- An option to use subdirectory in the `.blend` file path.
- An option to disable debug message.
- Split multiple utilities code to to `helper.py` module.
- Rewrite the `get_save_directory()` function to adapt with the new
preferences and fix the "not existent directory" bug.
- Add missing execute function call and correctly capturing `stdout`. - Pass a report when an image is written with a warning (catch by checking the saved file instead of `stderr`). - Use `pasteboard` to check for filepaths. - Target TIFF when checking clipboard contents via `pasteboard`.
|
@Yeetus3141 I suppose we did a good refactoring here, most changes are under the hood but it will help us a lot in the future. We also have a new preferences menu which saves users from having to specify a saving directory if they don't care. About the feature that moves scattered pasted images into |
|
Just tried the new build. Seems to be great! Awesome work you guys. |
b-init
approved these changes
Jul 21, 2021
|
Yeah, don't worry, I plan to implement right after merging this and will request your review then. |
thanhph111
added a commit
that referenced
this pull request
Jul 21, 2021
Using previous approach with `osascript`. Haven't tested yet, to be reviewed in #14.
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.
Proposed changes
This pull request proposes an OOP approach to the clipboard implementation, which is better for maintenance and development.
These changes also aim to improve user experience on the add-on preferences. Details:
preferences.py(add-on preferences, menu UI, keymaps) andoperators.py(operator classes only).__init__.pynow contains only metadata (7dc3cc5).Clipboardclass (support by a list of classes described in dd9c494).WindowsClipboard(fdfd421).LinuxClipboard(dd9c494).DarwinClipboard(001e5b8, 5c0e789)..blendfile is not available. This option will free user from specifying a default directory. However, we should allow users to overwrite this directory.The new preferences below (2a99d8c) added:
.blendfile path.Discuss about the idea: moving scattered images to(out of the PR scope).blendfile folder when saving.Further comments
linux.py, fix an issue make Linux clipboard cannot copy an JPG image (or other types except PNG) (dd9c494).