[v7r3] move Script goods to DIRACScript

docs/source/AdministratorGuide/Tutorials/dmsWithTs.rst

@@ -88,7 +88,7 @@ script that creates a removal transformation:
 
     # set up the DIRAC configuration, parse command line arguments
     from DIRAC import gLogger, S_OK, S_ERROR
-    from DIRAC.Core.Base import Script
+    from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
     Script.parseCommandLine()
 
     from DIRAC.TransformationSystem.Client.Transformation import Transformation

docs/source/AdministratorGuide/Tutorials/installWMS.rst

@@ -153,7 +153,7 @@ Create a Python script to generate and submit a simple job. Copy paste the follo
   #!/bin/env python
   # Magic lines necessary to activate the DIRAC Configuration System
   # to discover all the required services
-  from DIRAC.Core.Base import Script
+  from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
   Script.parseCommandLine(ignoreErrors=True)
   from DIRAC.Interfaces.API.Job import Job
   from DIRAC.Interfaces.API.Dirac import Dirac

docs/source/DeveloperGuide/AddingNewComponents/DevelopingCommands/dirac_my_great_script.py

@@ -16,8 +16,7 @@
 __RCSID__ = '$Id$'
 
 from DIRAC import S_OK, S_ERROR, gLogger, exit as DIRACExit
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
-from DIRAC.Core.Base import Script
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 
 
 class Params(object):
@@ -29,6 +28,13 @@ def __init__(self):
     """ C'or """
     self.raw = False
     self.pingsToDo = 1
+    # Defined all switches that can be used while calling the script from the command line interface.
+    self.switches = [
+        ('', 'text=', 'Text to be printed'),
+        ('u', 'upper', 'Print text on upper case'),
+        ('r', 'showRaw', 'Show raw result from the query', self.setRawResult),
+        ('p:', 'numPings=', 'Number of pings to do (by default 1)', self.setNumOfPingsToDo)
+    ]
 
   def setRawResult(self, _):
     """ ShowRaw option callback function, no option argument.
@@ -52,26 +58,6 @@ def setNumOfPingsToDo(self, value):
     return S_OK()
 
 
-def registerSwitches():
-  """
-    Registers all switches that can be used while calling the script from the command line interface.
-  """
-
-  # Some of the switches have associated a callback, defined on Params class.
-  cliParams = Params()
-
-  switches = [
-      ('', 'text=', 'Text to be printed'),
-      ('u', 'upper', 'Print text on upper case'),
-      ('r', 'showRaw', 'Show raw result from the query', cliParams.setRawResult),
-      ('p:', 'numPings=', 'Number of pings to do (by default 1)', cliParams.setNumOfPingsToDo)
-  ]
-
-  # Register switches
-  for switch in switches:
-    Script.registerSwitch(*switch)
-
-
 def registerArguments():
   """
     Registers a positional arguments that can be used while calling the script from the command line interface.
@@ -112,14 +98,15 @@ def parseSwitchesAndPositionalArguments():
 
 
 # IMPORTANT: Make sure to add the console-scripts entry to setup.cfg as well!
-@DIRACScript()
+@Script()
 def main():
   """
     This is the script main method, which will hold all the logic.
   """
+  params = Params()
 
   # Script initialization
-  registerSwitches()
+  Script.registerSwitches(params.switches)
   registerArguments()
   switchDict, repType, user, services = parseSwitchesAndPositionalArguments()
 

docs/source/DeveloperGuide/AddingNewComponents/DevelopingCommands/dirac_ping_info.py

@@ -13,10 +13,9 @@
 __RCSID__ = "$Id$"
 
 import sys
-from DIRAC import exit as DIRACExit
-from DIRAC import S_OK, S_ERROR, gLogger
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+
+from DIRAC import S_OK, S_ERROR, gLogger, exit as DIRACExit
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 
 
 # Define a simple class to hold the script parameters
@@ -38,7 +37,7 @@ def setNumOfPingsToDo(self, value):
     return S_OK()
 
 
-@DIRACScript()
+@Script()
 def main():
   # Instantiate the params class
   cliParams = Params()
@@ -49,7 +48,7 @@ def main():
   Script.registerArgument(['System: system names'])
 
   # Parse the command line and initialize DIRAC
-  Script.parseCommandLine(ignoreErrors=False)
+  switches, servicesList = Script.parseCommandLine(ignoreErrors=False)
 
   # Get the list of services
   servicesList = Script.getPositionalArgs()

docs/source/DeveloperGuide/AddingNewComponents/DevelopingCommands/index.rst

@@ -4,7 +4,7 @@ Developing Commands
 
 .. warning::
     This instructions here demonstrate how to support both the legacy (Python 2) and future (Python3) installations of DIRAC.
-    If only having Python 3 support is acceptable, the requirement for scripts to be in the the *scripts* directory of their parent system will be removed and the only requirement will be for the function to be decorated with the ``@DIRACScript()`` decorator.
+    If only having Python 3 support is acceptable, the requirement for scripts to be in the the *scripts* directory of their parent system will be removed and the only requirement will be for the function to be decorated with the ``@Script()`` decorator.
 
 Commands are one of the main interface tools for the users. Commands are also called *scripts* in DIRAC lingo. 
 
@@ -37,16 +37,16 @@ which will set the interpreter directive to the python on the environment.
 
 **2.** The next is the documentation line which is describing the command. This same documentation line will be used also the command help information available with the *-h* command switch.
 
-**3.** The majority of the code should be contained with a function, often called ``main`` though this is not required. This function should be wrapped with the ``@DIRACScript()`` decorator to allow the DIRAC plugin mechanism to override the script with the function from the highest priority extension.
+**3.** The majority of the code should be contained with a function, often called ``main`` though this is not required. This function should be wrapped with the ``@Script()`` decorator to allow the DIRAC plugin mechanism to override the script with the function from the highest priority extension.
 
 .. code-block:: python
 
    #Import the required DIRAC modules
-   from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+   from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
    from DIRAC.Interfaces.API.DIRAC import DIRAC
    from DIRAC import gLogger
 
-   @DIRACScript()
+   @Script()
    def main():
      # Do stuff
 

docs/source/DeveloperGuide/AddingNewComponents/YourFirstDIRACCode/index.rst

@@ -94,7 +94,7 @@ Remember to start the script with:
    #!/usr/bin/env python
    """ Some doc: what does this script should do?
    """
-   from DIRAC.Core.Base import Script
+   from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
    Script.parseCommandLine()
 
 

docs/source/DeveloperGuide/Systems/Framework/stableconns/client.py

@@ -4,7 +4,7 @@
 import sys
 import time
 from DIRAC import S_OK, S_ERROR
-from DIRAC.Core.Base import Script
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 from DIRAC.Core.DISET.MessageClient import MessageClient
 
 Script.parseCommandLine()

docs/source/DeveloperGuide/Systems/Transformation/transformationplugin.rst

@@ -121,7 +121,7 @@ with `setEvenOdd`, and then execute this function to test it.
    :linenos:
 
     from DIRAC import gLogger, S_OK, S_ERROR
-    from DIRAC.Core.Base import Script
+    from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
     Script.parseCommandLine()
 
     from DIRAC.TransformationSystem.Client.Transformation import Transformation

docs/source/UserGuide/GettingStarted/UserJobs/DiracAPI/index.rst

@@ -25,7 +25,7 @@ Creating a DIRAC Job using API
   The API allows creating DIRAC jobs using the Job object, specifying job requirements.::
 
     # setup DIRAC
-    from DIRAC.Core.Base import Script
+    from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
     Script.parseCommandLine(ignoreErrors=False) 
 
     from DIRAC.Interfaces.API.Job import Job
@@ -63,7 +63,7 @@ Job Monitoring
   Once you have submitted your jobs to the Grid, a little script can be used to monitor the job status::
 
     # setup DIRAC
-    from DIRAC.Core.Base import Script
+    from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
     Script.parseCommandLine(ignoreErrors=False) 
 
     from DIRAC.Interfaces.API.Dirac import Dirac
@@ -88,7 +88,7 @@ Job Output
   When the status of the job is done, the outputs can be retrieved using also a simple script::
 
     # setup DIRAC
-    from DIRAC.Core.Base import Script
+    from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
     Script.parseCommandLine(ignoreErrors=False) 
 
     from DIRAC.Interfaces.API.Dirac import Dirac

src/DIRAC/AccountingSystem/Client/ReportCLI.py

@@ -5,7 +5,7 @@
 Once ready it could be used with a script as simple as:
 
 
-from DIRAC.Core.Base import Script
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 
 Script.localCfg.addDefaultEntry("LogLevel", "info")
 Script.parseCommandLine()

src/DIRAC/AccountingSystem/scripts/dirac_accounting_decode_fileid.py

@@ -5,12 +5,6 @@
 ########################################################################
 """
 Decode Accounting plot URLs
-
-Usage:
-  dirac-accounting-decode-fileid [options] ... URL ...
-
-Arguments:
-  URL: encoded URL of a DIRAC Accounting plot
 """
 from __future__ import absolute_import
 from __future__ import division
@@ -24,16 +18,15 @@
 from six.moves.urllib import parse as urlparse
 
 from DIRAC import gLogger
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 
 
-@DIRACScript()
+@Script()
 def main():
   from DIRAC.Core.Utilities.Plotting.FileCoding import extractRequestFromFileId
-  Script.parseCommandLine()
+  Script.registerArgument(["URL: encoded URL of a DIRAC Accounting plot"])
 
-  fileIds = Script.getPositionalArgs()
+  _, fileIds = Script.parseCommandLine()
 
   for fileId in fileIds:
     # Try to find if it's a url
@@ -53,4 +46,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+  main()

src/DIRAC/AccountingSystem/scripts/dirac_admin_accounting_cli.py

@@ -5,21 +5,17 @@
 ########################################################################
 """
 Command line administrative interface to DIRAC Accounting DataStore Service
-
-Usage:
-  dirac-admin-accounting-cli [options] ...
 """
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
 __RCSID__ = "$Id$"
 
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 
 
-@DIRACScript()
+@Script()
 def main():
   Script.localCfg.addDefaultEntry("LogLevel", "info")
   Script.parseCommandLine()

src/DIRAC/ConfigurationSystem/scripts/dirac_admin_add_resources.py

@@ -17,8 +17,7 @@
 
 import six
 
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 from DIRAC import gLogger, exit as DIRACExit
 from DIRAC.ConfigurationSystem.Client.Utilities import getGridCEs, getSiteUpdates
 from DIRAC.Core.Utilities.Subprocess import systemCall
@@ -256,7 +255,7 @@ def handler(signum, frame):
   DIRACExit(-1)
 
 
-@DIRACScript()
+@Script()
 def main():
   signal.signal(signal.SIGTERM, handler)
   signal.signal(signal.SIGINT, handler)

src/DIRAC/ConfigurationSystem/scripts/dirac_admin_add_shifter.py

@@ -5,40 +5,29 @@
 ########################################################################
 """
 Adds or modify a shifter, in the operations section of the CS
-
-Usage:
-  dirac-admin-add-shifter [options] ... ShifterRole UserName DIRACGroup ...
-
-Arguments:
-  ShifterRole:  Name of the shifter role, e.g. DataManager
-  UserName:     A user name, as registered in Registry section
-  DIRACGroup:   DIRAC Group, e.g. diracAdmin (the user has to have this role)
 """
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
+
 __RCSID__ = "$Id$"
 
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 from DIRAC.ConfigurationSystem.Client.CSAPI import CSAPI
 from DIRAC import exit as DIRACExit, gLogger
 
 
-@DIRACScript()
+@Script()
 def main():
+  # Registering arguments will automatically add their description to the help menu
+  Script.registerArgument("ShifterRole:  Name of the shifter role, e.g. DataManager")
+  Script.registerArgument("UserName:     A user name, as registered in Registry section")
+  Script.registerArgument("DIRACGroup:   DIRAC Group, e.g. diracAdmin (the user has to have this role)")
   Script.parseCommandLine(ignoreErrors=True)
-  args = Script.getPositionalArgs()
 
   csAPI = CSAPI()
 
-  if len(args) < 3:
-    Script.showHelp(exitCode=1)
-
-  shifterRole = args[0]
-  userName = args[1]
-  diracGroup = args[2]
-
+  shifterRole, userName, diracGroup = Script.getPositionalArgs(group=True)
   res = csAPI.addShifter({shifterRole: {'User': userName, 'Group': diracGroup}})
   if not res['OK']:
     gLogger.error("Could not add shifter", ": " + res['Message'])

src/DIRAC/ConfigurationSystem/scripts/dirac_admin_add_site.py

@@ -8,42 +8,34 @@
 If site is already in the CS with another name, error message will be produced.
 If site is already in the CS with the right name, only new CEs will be added.
 
-Usage:
-  dirac-admin-add-site [options] ... DIRACSiteName GridSiteName CE [CE] ...
-
-Arguments:
-  DIRACSiteName:  Name of the site for DIRAC in the form GRID.LOCATION.COUNTRY (ie:LCG.CERN.ch)
-  GridSiteName:   Name of the site in the Grid (ie: CERN-PROD)
-  CE:             Name of the CE to be included in the site (ie: ce111.cern.ch)
-
 Example:
-  $ dirac-admin-add-site LCG.IN2P3.fr IN2P3-Site
+  $ dirac-admin-add-site LCG.IN2P3.fr IN2P3-Site ce01.in2p3.fr
 """
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
+
 __RCSID__ = "$Id$"
 
 import six
 
-from DIRAC.Core.Base import Script
-from DIRAC.Core.Utilities.DIRACScript import DIRACScript
+from DIRAC.Core.Utilities.DIRACScript import DIRACScript as Script
 from DIRAC import exit as DIRACExit, gLogger
 from DIRAC.ConfigurationSystem.Client.Helpers.Resources import getDIRACSiteName
 from DIRAC.ConfigurationSystem.Client.CSAPI import CSAPI
 
 
-@DIRACScript()
+@Script()
 def main():
+  # Registering arguments will automatically add their description to the help menu
+  Script.registerArgument("DIRACSiteName: Name of the site for DIRAC in the form GRID.LOCATION.COUNTRY "
+                          "(ie: LCG.CERN.ch)")
+  Script.registerArgument("GridSiteName:  Name of the site in the Grid (ie: CERN-PROD)")
+  Script.registerArgument(["CE:           Name of the CE to be included in the site (ie: ce111.cern.ch)"])
   Script.parseCommandLine(ignoreErrors=True)
-  args = Script.getPositionalArgs()
 
-  if len(args) < 3:
-    Script.showHelp(exitCode=1)
+  diracSiteName, gridSiteName, ces = Script.getPositionalArgs(group=True)
 
-  diracSiteName = args[0]
-  gridSiteName = args[1]
-  ces = args[2:]
   try:
     diracGridType, place, country = diracSiteName.split('.')
   except ValueError: