Remove link to addon directory at exit of blender - take 2 by Mateusz-Grzelinski · Pull Request #184 · JacquesLucke/blender_vscode

Mateusz-Grzelinski · 2024-08-17T15:40:41Z

Design is complete. No breaking changes will be introduced in this PR.

Remove addon link at the blender exit. This is implemented as new feature with setting blender.addon.keepAddonInstalled.

In this PR implemented:

Disable "Load Previous settings" Blender feature during VS code session. Blender breaks when trying to copy link from previous version
Windows only: disable addon uninstallation if addon is link because if will cause data loss on Windows :
Add option to make addon link/junction temporary blender.addon.keepAddonInstalled. If false addon will be available only during debug session
Send notification if linking addon failed
Update readme
multiple blender instances might use the same addon (for example you start blender twice). Do not remove the directory when another blender instance still needs it!

Relevant: #49

Pros:

Having the link temporary will fix issues that pop up in ugly corner cases in various places:
- uninstalling addon from blender might lead to data loss
- importing data from previous blender converts junction (link) into directory what leads to permission error when trying to install addon

Cons:

changes what users are used to. we can also prompt user to choose.
removing junctions and directories in python is a mess!!! Different python versions handle junctions dramatically differently.

Design 1 - link only when debugging - used in this PR

temporary link to addon dir is made only for VS code session - proposed in Remove link to addon directory at exit of blender #55 but not merged, so
- add new setting to go back to previous behaviour - simple
- or create a command "Blender: Install addons" that links/installs addons permamently - might be complicated - addons can have different ways of installation.

Design 2 - modify addon directory - unused

breaking change
modify VS code startup to use separate addon BLENDER_USER_SCRIPTS and dir BLENDER_SYSTEM_EXTENSIONS
- might conflict with user settings

Design 3

Modfiy blender preferences to recognise addon location via bpy.context.preferences.filepaths.script_directories
Cons:

breaking change
requires specific directory structure, see instructions from this random repo: https://github.com/hextantstudios/hextant_python_debugger?tab=readme-ov-file#setup-a-custom-scripts-folder-for-your-add-on
is extension supported via this mechanism?
script directories change require blender restart
older blender versions can specify one path, later have list of paths to specify in bpy.context.preferences.filepaths.script_directories - might conflict with user settings

- Capitalize global variables - Add type hints

fixes policy violation

Fresh installation of blender is not going to have directory created.

…o-cherry-pick # Conflicts: # pythonFiles/include/blender_vscode/__init__.py # pythonFiles/include/blender_vscode/load_addons.py

- you are developing extension in addons directory - extension has legacy bl_info defined - do not create a link

- prevent from various errors from old links - during blender version upgrade links are copied what breaks them and required manual fix

This reverts commit c6ab0fc

# Conflicts: # pythonFiles/include/blender_vscode/load_addons.py

# Conflicts: # pythonFiles/include/blender_vscode/load_addons.py # pythonFiles/tests/blender_vscode/test_load_addons.py

…ink-on-exit # Conflicts: # CHANGELOG.md # README.md # pythonFiles/include/blender_vscode/__init__.py # pythonFiles/include/blender_vscode/communication.py # pythonFiles/include/blender_vscode/installation.py # pythonFiles/include/blender_vscode/load_addons.py # pythonFiles/include/blender_vscode/operators/addon_update.py # pythonFiles/tests/blender_vscode/test_load_addons.py # src/blender_executable.ts

# Conflicts: # pythonFiles/include/blender_vscode/communication.py # pythonFiles/include/blender_vscode/environment.py # pythonFiles/include/blender_vscode/load_addons.py # pythonFiles/include/blender_vscode/operators/addon_update.py

This is non-destructive operation, files are not deleted.

Mateusz-Grzelinski · 2024-09-04T21:35:48Z

+from typing import Optional, Union
+
+
+def resolve_link(path: Union[str, os.PathLike]) -> Optional[str]:


handling juction is an absolute disaster due to python changes 3.7 -> 3.11. In worst case scenario use cmd call.

JacquesLucke · 2024-09-05T09:26:46Z

I'm not sure about this yet. I think this needs a better problem description before jumping to a solution.

Some notes:

If Blender crashes, the addon link won't be removed and leads to an unexpected change.
Is it expected that the addon is also available in Blender when not starting from vscode? In this case, we would have to figure out how to "overwrite" the normally installed addon with the version that is in development.
Instead of trying to figure out how to remove links, maybe there is a way to make the addon available in Blender without having to create a link in the first place?

Mateusz-Grzelinski · 2024-09-05T15:23:22Z

If Blender crashes

Yes, blender panic will leave the link. But that is true for any solution, unless we implement server side cleanup. Hm, maybe I will implement it, seems easy enough.

Note: python exceptions do a proper cleanup. Only the panic with blender.crash.txt will leave the link.

Is it expected that the addon is also available in Blender when not starting from vscode?

Currently you do not have a choice. Right now your addon is permamently linked and available also outside of VS code session. Using new setting blender.addon.keepAddonInstalled now you have a choice.

In this case, we would have to figure out how to "overwrite" the normally installed addon with the version that is in development.

This is impossible to design without any flaws.
I found only Design 1 and 2 in description of this PR. I also added design 3, which could potentially work... I did not find only more sensible options for us.

Current behavior: blender will fail to start (because link can not be created, directory already exists). I recently improved the error message: https://github.com/JacquesLucke/blender_vscode/blob/master/pythonFiles/include/blender_vscode/load_addons.py#L41

Mateusz-Grzelinski added 30 commits July 22, 2024 23:02

Fix JacquesLucke#138: avoid creating duplicate link for addon

e6f2f34

- Capitalize global variables - Add type hints

Rever capitalization of global vars

408442f

Support loading from externsion directory

7c62eca

Add patch based tests

6866abb

Fix tests and compability with python 3.7

bf3d5a4

Fix addon reloading

99c7873

Fix type hint

869f0df

Fix logic for setting up addon links

74f9585

Remove comment

3e9e7ee

Mock call to sys.path

b7d756d

Deduplicate patch calls

f7b4f7e

Update comment

a0f99b6

Extensions probably does not need sys.path

445778f

fixes policy violation

Remove no longer needed gitignore

750fc41

Fix missing directory

469435c

Fresh installation of blender is not going to have directory created.

Fix: prevent type hint from failing older verions of blender

b803c97

Merge remote-tracking branch 'refs/remotes/jack/master' into master-n…

c2e4330

…o-cherry-pick # Conflicts: # pythonFiles/include/blender_vscode/__init__.py # pythonFiles/include/blender_vscode/load_addons.py

Cover corner case with extension that can be an addon

af8167a

- you are developing extension in addons directory - extension has legacy bl_info defined - do not create a link

Fix test and test new edge case

21c4e78

Remove link after blender exits

c6ab0fc

- prevent from various errors from old links - during blender version upgrade links are copied what breaks them and required manual fix

Disable loading from previous blender

322cc2c

Send error notification when addon fails to load

c5feb7a

Fix: sys.path was not handled correctly for fresh blender install

bbe0c9e

Fix: sys.path was not handled correctly for fresh blender install

4794614

Revert "Remove link after blender exits"

702e4ea

This reverts commit c6ab0fc

Fix tests

25b1454

Merge branch 'refs/heads/master' into remove-link-on-exit

95d7335

# Conflicts: # pythonFiles/include/blender_vscode/load_addons.py

Always print exception

d82c598

Add VS code setting to enable legacy, no cleanup behaviour

236f5e8

Remove debug print

4c6ef68

Mateusz-Grzelinski added 9 commits August 12, 2024 19:42

Fix tests and blender 2.8 compatibility

4e8601b

Update readme

4f45939

Use env var for passing VS code setting, disable uninstall operations

3e149d1

Merge branch 'refs/heads/master' into remove-link-on-exit

dea1282

# Conflicts: # pythonFiles/include/blender_vscode/load_addons.py # pythonFiles/tests/blender_vscode/test_load_addons.py

Fix test

95bb357

Separate functionality to files, add optimize_defaults, rename files

6851545

Update changelog

5cf70f0

Fix weird corner cases

16a3fe4

Mateusz-Grzelinski added this to the 0.0.23 milestone Aug 17, 2024

Mateusz-Grzelinski mentioned this pull request Sep 4, 2024

Permission Error access Denied #17

Open

Mateusz-Grzelinski added 9 commits September 4, 2024 22:04

Fix chenagelog, remove duplicate from readme

25a9bd9

remove optimized defaults

a943e6c

rename var

058afca

Fix tests

ae4205d

There is no need to disable extension remove

ac24601

This is non-destructive operation, files are not deleted.

disable_copy_settings_from_previous_version only on windows

d5c51a9

Do not change default behavior

0f576f9

Document corner case

0730305

Mateusz-Grzelinski marked this pull request as ready for review September 4, 2024 21:31

Update redme

95cbcb3

Mateusz-Grzelinski commented Sep 4, 2024

View reviewed changes

Fix missing import

91fb1dd

Mateusz-Grzelinski modified the milestones: 0.0.23, 0.0.24 Sep 7, 2024

Mateusz-Grzelinski mentioned this pull request Oct 9, 2024

Bug: Blender 4.2 registers addons both as legacy and extensions after using Blender 3.6 #209

Closed

Mateusz-Grzelinski marked this pull request as draft December 24, 2024 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove link to addon directory at exit of blender - take 2#184

Remove link to addon directory at exit of blender - take 2#184
Mateusz-Grzelinski wants to merge 64 commits into
JacquesLucke:masterfrom
Mateusz-Grzelinski:remove-link-on-exit

Mateusz-Grzelinski commented Aug 17, 2024 •

edited

Loading

Uh oh!

Mateusz-Grzelinski Sep 4, 2024

Uh oh!

JacquesLucke commented Sep 5, 2024

Uh oh!

Mateusz-Grzelinski commented Sep 5, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		from typing import Optional, Union


		def resolve_link(path: Union[str, os.PathLike]) -> Optional[str]:

Conversation

Mateusz-Grzelinski commented Aug 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

In this PR implemented:

Design 1 - link only when debugging - used in this PR

Design 2 - modify addon directory - unused

Design 3

Uh oh!

Mateusz-Grzelinski Sep 4, 2024

Choose a reason for hiding this comment

Uh oh!

JacquesLucke commented Sep 5, 2024

Uh oh!

Mateusz-Grzelinski commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Mateusz-Grzelinski commented Aug 17, 2024 •

edited

Loading

Mateusz-Grzelinski commented Sep 5, 2024 •

edited

Loading