[v7r3] move Script goods to DIRACScript

[TaykYoku]

UPDATE:
additional testing did not reveal similar problems described here, so this reason I think is leveled

This PR is designed to solve the problem described in comment(a more global solution then #5036). Avoiding the use of global variables in favor of instance variables improves the situation.

UPDATE:

1. IIUC that this PR will go to v7r3 as well as [v7r2 --> v7r3(#5035)] register script arguments #5024. Taking this into account, and the fact that these PRs are designed to modify the same files, I decided to combine them here to make reviewing easier.
2. the use of [v7r2 --> v7r3(#5035)] register script arguments #5024 features is optional, but since changes to DIRACScript made before merging were required to edit each affected DIRACScript script, so I have added argument registration for "full testing".
3. the changes should not affect the expected result of the scripts running.

More about PR, since DIRACScript will be used every time the command is called, the main change concerns this class, namely the transfer of logic from Script as instance variables/methods.

Added the ability to register positional arguments and add it to help message from #5024.
Note: Applied

Places where argument registration was not applied:

• src/DIRAC/DataManagementSystem/scripts/dirac_dms_add_file.py
• src/DIRAC/FrameworkSystem/scripts/dirac_sys_sendmail.py
• src/DIRAC/StorageManagementSystem/scripts/dirac_stager_stage_files.py
• src/DIRAC/TransformationSystem/scripts/dirac_production_runjoblocal.py
• tests/Jenkins/dirac-... .py

Main changes:

• DIRACScript:
  • added general methods and initialization part from Script
  • in the DIRACScripts search cycle among the entry_points, a filter by scriptName is added, @chrisburr could you review this change, please?

UPDATE: This already done with #5061

• LocalConfiguration:
  • added registerCmdArg to register arguments
  • added group parameter to getPositionalArguments to to get grouped arguments as they were registered
  • added test

Changes for the scripts(e.g.: dirac-my-great-script):

• Use new method: registerArgument
• remove Script import

from DIRAC.Core.Base import Script
from DIRAC.Core.Utilities.DIRACScript import DIRACScript

a = None

def setA(arg):
  global a
  a = arg

@DIRACScript()
def main():
  global a
  Script.registerSwitch(..., setA)

to

from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script

a = None

def setA(arg):
  global a
  self.a = arg

@Script()
def main():
   Script.registerSwitch(..., setA)
   Script.registerArgument("my arg: my argument")

BEGINRELEASENOTES

*allSystems/scripts
CHANGE: use registerArgument to register positional arguments for scripts
FIX: use DIRACScript instead Script

ENDRELEASENOTES

[chrisburr]

@TaykYoku This looks like a really nice change to remove some of the global state. Can you add an explanation of what is being changed to the PR description to make this easier to review?

Also given how large the changes are and how poorly tested the scripts are in the CI I think this might be better suited to v7r3. If others agree I can come up with a hack to workaround the problem mentioned in #5032 (comment).

[TaykYoku]

@chrisburr agree that many fixes delay the release.
I offer #5036 to bypass the problem, if you haven't already.

[fstagni]

There are some scripts also inside the /tests directory

[TaykYoku]

given that this PR will go to v7r3 as well as #5024, then I can combine them here, to avoid duplication of work on their review. They both affect the same files

[chrisburr]

Perhaps it would be a good idea to discuss how you propose to change the scripts before doing the tedious work of converting them all?

[TaykYoku]

I wanted to protest whether it would work in all cases, but I think you are right.
How best to open a discussion about this?

P.S.: now I'm not improving anything, I'm just fixing bugs to pass the tests(this will simplify reviewing)

[TaykYoku]

restart tests

[TaykYoku]

retest

[TaykYoku]

since the main issue was solved by a separate PR, I rebase/simplified this PR by leaving the transfer of goods from Script and registering positional arguments to display them in the help message.