...

def __init__(self, backend_id, db_name, shot, run, user_name = None, data_version = 3None)
	if user_name is None:
		user_name = $USER

	if data_version is None:
		data_version = $IMAS_VERSION

Additional "URI-based" constructor will be added in future...

...

All parameters that defines db_entryDBEntry  are set in constructor, so create, open, close will have no mandatory arguments

def create(self, options = None)
def open(self, options = None)
def close(self, options = None)

options - additional options (backend specific)

...

def get(self, idsNameids_name, occurrence = 0) # idsNameids_name (e.g. 'equilibrium') ENUM ?
	wallObj = initialize_ids_obj('wall') 
	wallObj.put(self(db_entry))
	return wallObj, IDSName.EQUILIBRIUM, wall.__name__ (see below)) 

Put IDS

def put(self, ids, occurrence = 0)

IDS

...

put slice

def put_slice(self, ids, occurrence = 0)

...

IDS get slice 

def get_slice(self, ids_name, time_requested, interpolation_method, occurrence=0): # idsName (e.g. 'equilibrium')
	return ids

Any other method is needed to ba added to DBEntry class?

...

Partial Get

def partial_get(self, ids_name, data_path, occurrence = 0, db_entry = None):

IDS superclass

IDSBase  - Parent class for all classes representing particular IDSes.  

Class  methods (aka "static")

def get_ids(cls, ids_name):

For internal use only - it should not be called by users.

IDS class

Class  methods (aka "static")

def get_max_occurrences(cls):

def read_time_mode(self, ctx):

def read_time(self, ctx):

IDS storing / reading

DBEntry  is used to provide explicitly context to methods. This parameter is optional to keep To provide database context user has to pass explicitly DBEntry object to all methods responsible for saving / reading data. This parameter should be mandatory but has to be kept optional to ensure backward compatibility....

...

def put(self, occurrence=0, db_entry=None):

def get(self, occurrence=0, db_entry=None):

def putSlice(self, occurrence=0, db_entry=None):

def getSlice(self, time_requested, interpolation_method, occurrence=0, db_entry=None):

Additional methods

def copy_values(self, ids):

def delete_datapartialGet(self, occurrence=0, db_entry=None ):

def partial_get(self, dataPath, occurrence=0, db_entry=None):

def get_field(self, dataPath, occurrence=0, db_entry=None):

"Messy" methods

... that are not in line with proposed design but they must be kept to ensure backward compatibility.

...

Backward compatibility

  import imas

  imasEnv = imas.ids(1111, 1111)
  imasEnv.create_env(user, db_name, dd_version)  
    
  # Mandatory property
  imasEnv.pf_active.ids_properties.homogeneous_time = 2

  imasEnv.pf_active.put()
        
  imasEnv.close()

import imas

imasEnv = imas.ids(1111, 1111)
imasEnv.open_env(user, db_name, dd_version)  




imasEnv.pf_active.get()
  
imasEnv.close()

...

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 2222, 2222)
db_entry.create()  
    
ids = imas.pf_active()
# Mandatory property
ids.ids_properties.homogeneous_time = 2

db_entry.put(ids)

db_entry.close()

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 2222, 2222)
db_entry.open()  





ids = db_entry.get('pf_active')

db_entry.close()

...

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 3333, 3333)
db_entry.create()  
    
ids = imas.pf_active()
ids.ids_properties.homogeneous_time = 2

ids.put(db_entry = db_entry)
db_entry.close()

import imas
from imas import imasdef

db_entry = imas.DBEntry(imasdef.MDSPLUS_BACKEND, db_name, 3333, 3333)
db_entry.create()  

ids = imas.pf_active()


ids.get(db_entry = db_entry)
db_entry.close()

Importing IDS classes

Suggested method:

import imas
ids_wall = imas.wall()

It is also possible to write:

import imas
from imas.wall import wall
ids_wall = wall()

or

import imas
ids_wall = imas.wall.wall()

IDS names

...

It can be implemented using enum or class attribute

Enum

class IDSName(enum): 

     EQUILIBRIUM = 'equilibrium'

     WALL = 'wall' 

etc etc

Given IDS class attribute

e.g. Wall.__name__