materials_commons.cli.subcommands.expt module
- class materials_commons.cli.subcommands.expt.ExptSubcommand[source]
Bases:
ListObjectsList, create, delete, and modify experiments
mc expt mc expt [-c] <exptname>
- Parameters:
cmdname – List[str] Names to use for ‘mc X Y …’, for instance: [“casm”, “prim”] for “mc casm prim”
typename – str With capitalization, for instance: “Process”
typename_plural – str With capitalization, for instance: “Processes”
desc – str Used for help command description
requires_project – bool If True and not in current project, raise MCCLIException
non_proj_member – bool Enable get_all_from_remote. If non_proj_member and proj_member, enable –all option to query all projects.
proj_member – bool Enable get_all_from_project. Restrict queries to current project by default
expt_member – bool Enable get_all_from_experiment. Include –expt option to restrict queries to current experiment
dataset_member – bool Enable get_all_from_dataset. Includes –dataset option to restrict queries to specified dataset
list_columns – List[str] List of column names
headers – List[str] List of column header names, use list_columns if None
deletable – bool If true, enable –delete
dry_runable – bool If true, enable –dry-run
has_owner – bool If true, enable –owner
creatable – bool If true, object can be created via derived class ‘create’ function
custom_actions –
List of str Custom action names which are called via:
<name>(self, args, outout=sys.stdout)
custom_selection_actions –
List of str Custom action names which are called via:
<name>(self, objects, args, outout=sys.stdout)
request_confirmation_actions – Dict of name:msg Dictionary of names of custom_selection_actions which require prompting the user for confirmation before executing. The value is the message shown at the prompt. Delete is always confirmed and is not included here.
- delete(objects, args, dry_run, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source]