`scons --clean` deletes some files that are fetched from the repo

[CyrilleB79]

Steps to reproduce:

• Clone NVDA GIT repo
• Run scons --clean
• Build and run NVDA alpha.

Actual behavior:

Critical error. Here is the log:

Log

INFO - __main__ (18:18:04.681) - MainThread (4004): Starting NVDA version source-master-1e139d4 INFO - core.main (18:18:04.919) - MainThread (4004): Config dir: D:\Cyrille\Dev\GIT\nvdaNew\source\userConfig INFO - config.ConfigManager._loadConfig (18:18:04.919) - MainThread (4004): Loading config: .\userConfig\nvda.ini INFO - core.main (18:18:05.036) - MainThread (4004): Using Windows version 10.0.18362 workstation INFO - core.main (18:18:05.036) - MainThread (4004): Using Python version 3.7.5 (tags/v3.7.5:5c02a39a0b, Oct 14 2019, 23:09:19) [MSC v.1916 32 bit (Intel)] INFO - core.main (18:18:05.036) - MainThread (4004): Using comtypes version 1.1.7 INFO - core.main (18:18:05.036) - MainThread (4004): Using configobj version 5.1.0 with validate version 1.0.1 CRITICAL - __main__ (18:18:05.451) - MainThread (4004): core failure Traceback (most recent call last): File "source\nvda.pyw", line 215, in File "core.py", line 256, in main import appModuleHandler File "appModuleHandler.py", line 27, in import NVDAHelper File "NVDAHelper.py", line 19, in import eventHandler File "eventHandler.py", line 9, in import api File "api.py", line 19, in import NVDAObjects.IAccessible File "NVDAObjects\IAccessible\__init__.py", line 22, in import IAccessibleHandler File "IAccessibleHandler.py", line 18, in import UIAHandler File "UIAHandler.py", line 11, in from _UIAHandler import * # noqa: F403 File "_UIAHandler.py", line 29, in from comtypes.gen import UIAutomationClient as UIA ImportError: cannot import name 'UIAutomationClient' from 'comtypes.gen' (D:\Cyrille\Dev\GIT\nvdaNew\include\comtypes\comtypes\gen\__init__.py)

Expected behavior:

A build after scons --clean should be able to generate an NVDA version able to start correctly.

System configuration

NVDA installed/portable/running from source:

Source

NVDA version:

Alpha (commit 1e139d4)

Windows version:

Win 10 1903

Name and version of other software in use when reproducing the issue:

Visual Studio 2019.

Other information about your system:

Other questions

Does the issue still occur after restarting your PC?

Yes

Have you tried any other versions of NVDA? If so, please report their behaviors.

Running other versions from source is also failing. I did not succeed in running from source since I have built with VS2019.

[josephsl]

Hi, did you recently do a scons –clean? If yes, you should do a git reset –hard before proceeding. Thanks. From: CyrilleB79 <notifications@github.com> Sent: Monday, March 2, 2020 9:30 AM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Subscribed <subscribed@noreply.github.com> Subject: [nvaccess/nvda] Unable to run NVDA alpha (#10833) Steps to reproduce: Build and run NVDA alpha. Actual behavior: Critical error. Here is the log: Log INFO - __main__ (18:18:04.681) - MainThread (4004): Starting NVDA version source-master-1e139d4 INFO - core.main (18:18:04.919) - MainThread (4004): Config dir: D:\Cyrille\Dev\GIT\nvdaNew\source\userConfig INFO - config.ConfigManager._loadConfig (18:18:04.919) - MainThread (4004): Loading config: .\userConfig\nvda.ini INFO - core.main (18:18:05.036) - MainThread (4004): Using Windows version 10.0.18362 workstation INFO - core.main (18:18:05.036) - MainThread (4004): Using Python version 3.7.5 (tags/v3.7.5:5c02a39a0b, Oct 14 2019, 23:09:19) [MSC v.1916 32 bit (Intel)] INFO - core.main (18:18:05.036) - MainThread (4004): Using comtypes version 1.1.7 INFO - core.main (18:18:05.036) - MainThread (4004): Using configobj version 5.1.0 with validate version 1.0.1 CRITICAL - __main__ (18:18:05.451) - MainThread (4004): core failure Traceback (most recent call last): File "source\nvda.pyw", line 215, in File "core.py", line 256, in main import appModuleHandler File "appModuleHandler.py", line 27, in import NVDAHelper File "NVDAHelper.py", line 19, in import eventHandler File "eventHandler.py", line 9, in import api File "api.py", line 19, in import NVDAObjects.IAccessible File "NVDAObjects\IAccessible\__init__.py", line 22, in import IAccessibleHandler File "IAccessibleHandler.py", line 18, in import UIAHandler File "UIAHandler.py", line 11, in from _UIAHandler import * # noqa: F403 File "_UIAHandler.py", line 29, in from comtypes.gen import UIAutomationClient as UIA ImportError: cannot import name 'UIAutomationClient' from 'comtypes.gen' (D:\Cyrille\Dev\GIT\nvdaNew\include\comtypes\comtypes\gen\__init__.py) Expected behavior: NVDA running. System configuration NVDA installed/portable/running from source: Source NVDA version: Alpha (commit <1e139d4> 1e139d4) Windows version: Win 10 1903 Name and version of other software in use when reproducing the issue: Visual Studio 2019. Other information about your system: Other questions Does the issue still occur after restarting your PC? Yes Have you tried any other versions of NVDA? If so, please report their behaviors. Running other versions from source is also failing. I did not succeed in running from source since I have built with VS2019. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#10833?email_source=notifications&email_token=AB4AXEEPS44EFR2KLQTDZMLRFPUJNA5CNFSM4K7ZA4A2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4IRYRD7A> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4AXEFBGY7KXZYLGGZKH63RFPUJNANCNFSM4K7ZA4AQ> .

[CyrilleB79]

Yes, I did a scons -c when trying to fix another issue.

source code is now starting up correctly. Thanks!

Just to understand, why do I need to do this git reset --hard after a scons -c?

[josephsl]

Hi, it’s because when scons –clean is run, it removes comInterfaces directory, which includes UIA modules. Thanks. From: CyrilleB79 <notifications@github.com> Sent: Monday, March 2, 2020 12:00 PM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Joseph Lee <joseph.lee22590@gmail.com>; Comment <comment@noreply.github.com> Subject: Re: [nvaccess/nvda] Unable to run NVDA alpha (#10833) Yes, I did a scons -c when trying to fix another issue. source code is now starting up correctly. Thanks! Just to understand, why do I need to do this git reset --hard after a scons -c? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#10833?email_source=notifications&email_token=AB4AXEGXY5DBZYPTRDNEHQ3RFQF4NA5CNFSM4K7ZA4A2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENQXLII#issuecomment-593589665> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4AXEDFWPFUMXNKZD36I6DRFQF4NANCNFSM4K7ZA4AQ> .

[CyrilleB79]

OK, but why does scons --clean clean some files that are fetched from the repo?

[Adriani90]

@CyrilleB79 are you still having this issue with last Alpha?

[CyrilleB79]

@Adriani90 no, as written in my previous comment, I can build and run correctly thanks to Joseph's comment.

However, this question remains unanswered:

OK, but why does scons --clean clean some files that are fetched from the repo?

There are two possibilities:

• If it is a bug, it should be fixed
• If it is intended, it should be documented, maybe in the README of NVDA where you find build instructions.

@josephsl could you comment further? Thanks.

I will update the issue title and description.

[josephsl]

Hi, this is because SCons may not know about UIA COM interfaces files, so it removes them. I hope this can be resolved from SCons end by letting projects specify files to be kept when scons –clean is run. Thanks. From: CyrilleB79 <notifications@github.com> Sent: Thursday, May 7, 2020 12:27 AM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Joseph Lee <joseph.lee22590@gmail.com>; Mention <mention@noreply.github.com> Subject: Re: [nvaccess/nvda] Unable to run NVDA alpha (#10833) @Adriani90 <https://github.com/Adriani90> no, as written in my previous comment, I can build and run correctly thanks to Joseph's comment. However, this question remains unanswered: OK, but why does scons --clean clean some files that are fetched from the repo? There are two possibilities: * If it is a bug, it should be fixed * If it is intended, it should be documented, maybe in the README of NVDA where you find build instructions. @josephsl <https://github.com/josephsl> could you comment further? Thanks. I will update the issue title and description. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10833 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4AXEHVLDTPM6SVZWSOQMDRQJPC7ANCNFSM4K7ZA4AQ> .

[CyrilleB79]

I do not know anything of these UIA COM interfaces files and why it would be necessary to tell expliciely to scons to keep them (on contrary to other source files).

Anyway, what do you suggest for this issue? May we open an issue against scons about this. Or we may link it here if there is already an issue opened against scons. Also may we add an information in the readme in the mean time?

[josephsl]

Hi, I think filing a feature suggestion with SCons would be the best option, as it will benefit NVDA and other projects. Thanks. From: CyrilleB79 <notifications@github.com> Sent: Thursday, May 7, 2020 12:51 AM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Joseph Lee <joseph.lee22590@gmail.com>; Mention <mention@noreply.github.com> Subject: Re: [nvaccess/nvda] `scons --clean` deletes some files that are fetched from the repo (#10833) I do not know anything of these UIA COM interfaces files and why it would be necessary to tell expliciely to scons to keep them (on contrary to other source files). Anyway, what do you suggest for this issue? May we open an issue against scons about this. Or we may link it here if there is already an issue opened against scons. Also may we add an information in the readme in the mean time? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10833 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB4AXEB2SI4L3IQA4IKC3Q3RQJR5RANCNFSM4K7ZA4AQ> .

[CyrilleB79]

Would you mind to fill this feature suggestion agains scons project? I am not able to describe them the issue.

Indeed, again, I do not know the specificity of the UIA COM interfaces files and why they are deleted by scons --cleanwhen I would have expected all repo source file to be kept without any specific configuration for them.

[mohammad-suliman]

I recently came across this issue also. The scons --clean deletes the following 3 files under comeInterfaces as stated by @josephsl :

• _944DE083_8FB8_45CF_BCB7_C477ACB2F897_0_1_0.py
• readme.md
• UIAutomationClient.py

Unfortunately, running git reset --hard is not practical because it will delete any local changes I did while working on the source.

[lukaszgo1]

This does not require changes in Scons and can certainly be fixed in our code. I cannot say when I would have a time to look into the problem but I do intent to at some point.