From 6e1d20e76ea2aa900311070c2b45839216807944 Mon Sep 17 00:00:00 2001
From: Sinisa Veseli <sveseli@aps.anl.gov>
Date: Thu, 8 Oct 2015 06:49:46 +0000
Subject: [PATCH] made commands more consistent by using --experiment
everywhere
---
.../dm/ds_web_service/cli/addExperimentCli.py | 20 ++++++++++---------
.../dm/ds_web_service/cli/getExperimentCli.py | 12 +++++------
.../ds_web_service/cli/startExperimentCli.py | 12 +++++------
.../ds_web_service/cli/stopExperimentCli.py | 12 +++++------
4 files changed, 29 insertions(+), 27 deletions(-)
diff --git a/src/python/dm/ds_web_service/cli/addExperimentCli.py b/src/python/dm/ds_web_service/cli/addExperimentCli.py
index d1bc84ca..566a41d0 100755
--- a/src/python/dm/ds_web_service/cli/addExperimentCli.py
+++ b/src/python/dm/ds_web_service/cli/addExperimentCli.py
@@ -7,21 +7,21 @@ from dsWebServiceSessionCli import DsWebServiceSessionCli
class AddExperimentCli(DsWebServiceSessionCli):
def __init__(self):
DsWebServiceSessionCli.__init__(self)
- self.addOption('', '--name', dest='name', help='Experiment name.')
+ self.addOption('', '--experiment', dest='experimentName', help='Experiment name.')
self.addOption('', '--type-id', dest='typeId', help='Experiment type id.')
self.addOption('', '--description', dest='description', help='Experiment description.')
- self.addOption('', '--startDate', dest='startDate', help='Experiment start date in format (15-AUG-15).')
- self.addOption('', '--endDate', dest='endDate', help='Experiment end date in format (15-AUG-15).')
+ self.addOption('', '--start-date', dest='startDate', help='Experiment start date in format 31-AUG-15.')
+ self.addOption('', '--end-date', dest='endDate', help='Experiment end date in format 31-AUG-15.')
def checkArgs(self):
- if self.options.name is None:
+ if self.options.experimentName is None:
raise InvalidRequest('Experiment name must be provided.')
if self.options.typeId is None:
raise InvalidRequest('Experiment type id must be provided.')
- def getName(self):
- return self.options.name
+ def getExperimentName(self):
+ return self.options.experimentName
def getTypeId(self):
return self.options.typeId
@@ -37,15 +37,17 @@ class AddExperimentCli(DsWebServiceSessionCli):
def runCommand(self):
self.parseArgs(usage="""
- dm-add-experiment --name=NAME --type-id=TYPEID
- [--description=DESCRIPTION] [--startDate=STARTDATE] [--endDate=ENDDATE]
+ dm-add-experiment --experiment=EXPERIMENTNAME --type-id=TYPEID
+ [--description=DESCRIPTION]
+ [--start-date=STARTDATE]
+ [--end-date=ENDDATE]
Description:
Add new experiment to the DM database.
""")
self.checkArgs()
api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
- experiment = api.addExperiment(self.getName(), self.getTypeId(), self.getDescription(), self.getStartDate(), self.getEndDate())
+ experiment = api.addExperiment(self.getExperimentName(), self.getTypeId(), self.getDescription(), self.getStartDate(), self.getEndDate())
print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
#######################################################################
diff --git a/src/python/dm/ds_web_service/cli/getExperimentCli.py b/src/python/dm/ds_web_service/cli/getExperimentCli.py
index 8e5255bc..c453f61d 100755
--- a/src/python/dm/ds_web_service/cli/getExperimentCli.py
+++ b/src/python/dm/ds_web_service/cli/getExperimentCli.py
@@ -8,21 +8,21 @@ class GetExperimentCli(DsWebServiceSessionCli):
def __init__(self):
DsWebServiceSessionCli.__init__(self)
self.addOption('', '--id', dest='id', help='Experiment id. Either id or name must be provided. If both are provided, id takes precedence.')
- self.addOption('', '--name', dest='name', help='Experiment name. Either id or name must be provided. If both are provided, id takes precedence.')
+ self.addOption('', '--experiment', dest='experimentName', help='Experiment name. Either id or name must be provided. If both are provided, id takes precedence.')
def checkArgs(self):
- if self.options.id is None and self.options.name is None:
+ if self.options.id is None and self.options.experimentName is None:
raise InvalidRequest('Either experiment id or name must be provided.')
def getId(self):
return self.options.id
- def getName(self):
- return self.options.name
+ def getExperimentName(self):
+ return self.options.experimentName
def runCommand(self):
self.parseArgs(usage="""
- dm-get-experiment --id=ID|--name=NAME
+ dm-get-experiment --id=ID|--experiment=EXPERIMENTNAME
Description:
Retrieves experiment information.
@@ -32,7 +32,7 @@ Description:
if self.getId() is not None:
experiment = api.getExperimentById(self.getId())
else:
- experiment = api.getExperimentByName(self.getName())
+ experiment = api.getExperimentByName(self.getExperimentName())
print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
#######################################################################
diff --git a/src/python/dm/ds_web_service/cli/startExperimentCli.py b/src/python/dm/ds_web_service/cli/startExperimentCli.py
index ed307d58..905f8431 100755
--- a/src/python/dm/ds_web_service/cli/startExperimentCli.py
+++ b/src/python/dm/ds_web_service/cli/startExperimentCli.py
@@ -7,25 +7,25 @@ from dsWebServiceSessionCli import DsWebServiceSessionCli
class StartExperimentCli(DsWebServiceSessionCli):
def __init__(self):
DsWebServiceSessionCli.__init__(self)
- self.addOption('', '--name', dest='name', help='Experiment name.')
+ self.addOption('', '--experiment', dest='experimentName', help='Experiment name.')
def checkArgs(self):
- if self.options.name is None:
+ if self.options.experimentName is None:
raise InvalidRequest('Experiment name must be provided.')
- def getName(self):
- return self.options.name
+ def getExperimentName(self):
+ return self.options.experimentName
def runCommand(self):
self.parseArgs(usage="""
- dm-start-experiment --name=NAME
+ dm-start-experiment --experiment=EXPERIMENTNAME
Description:
Updates experiment start time in the DM database and prepares experiment data directory.
""")
self.checkArgs()
api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
- experiment = api.startExperiment(self.getName())
+ experiment = api.startExperiment(self.getExperimentName())
print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
#######################################################################
diff --git a/src/python/dm/ds_web_service/cli/stopExperimentCli.py b/src/python/dm/ds_web_service/cli/stopExperimentCli.py
index 7715a01d..897a272c 100755
--- a/src/python/dm/ds_web_service/cli/stopExperimentCli.py
+++ b/src/python/dm/ds_web_service/cli/stopExperimentCli.py
@@ -7,25 +7,25 @@ from dsWebServiceSessionCli import DsWebServiceSessionCli
class StopExperimentCli(DsWebServiceSessionCli):
def __init__(self):
DsWebServiceSessionCli.__init__(self)
- self.addOption('', '--name', dest='name', help='Experiment name.')
+ self.addOption('', '--experiment', dest='experimentName', help='Experiment name.')
def checkArgs(self):
- if self.options.name is None:
+ if self.options.experimentName is None:
raise InvalidRequest('Experiment name must be provided.')
- def getName(self):
- return self.options.name
+ def getExperimentName(self):
+ return self.options.experimentName
def runCommand(self):
self.parseArgs(usage="""
- dm-stop-experiment --name=NAME
+ dm-stop-experiment --experiment=EXPERIMENTNAME
Description:
Updates experiment end date in the DM database and checks experiment data permissions.
""")
self.checkArgs()
api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
- experiment = api.stopExperiment(self.getName())
+ experiment = api.stopExperiment(self.getExperimentName())
print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
#######################################################################
--
GitLab