# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Import/ImportData.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Import/ImportData
"""
from os import linesep
from sys import getsizeof
from logging import getLogger
from ._check import check_var, raise_
from ..Functions.get_logger import get_logger
from ..Functions.save import save
from ..Functions.load import load_init_dict
from ..Functions.Load.import_class import import_class
from copy import deepcopy
from ._frozen import FrozenClass
# Import all class method
# Try/catch to remove unnecessary dependencies in unused method
try:
from ..Methods.Import.ImportData.get_data import get_data
except ImportError as error:
get_data = error
from numpy import isnan
from ._check import InitUnKnowClassError
[docs]class ImportData(FrozenClass):
"""Abstract class for Data Import/Generation"""
VERSION = 1
# cf Methods.Import.ImportData.get_data
if isinstance(get_data, ImportError):
get_data = property(
fget=lambda x: raise_(
ImportError("Can't use ImportData method get_data: " + str(get_data))
)
)
else:
get_data = get_data
# generic save method is available in all object
save = save
# get_logger method is available in all object
get_logger = get_logger
def __init__(
self,
axes=-1,
field=None,
unit="SI",
name="",
symbol="",
normalizations=-1,
symmetries=-1,
init_dict=None,
init_str=None,
):
"""Constructor of the class. Can be use in three ways :
- __init__ (arg1 = 1, arg3 = 5) every parameters have name and default values
for pyleecan type, -1 will call the default constructor
- __init__ (init_dict = d) d must be a dictionary with property names as keys
- __init__ (init_str = s) s must be a string
s is the file path to load
ndarray or list can be given for Vector and Matrix
object or dict can be given for pyleecan Object"""
if init_str is not None: # Load from a file
init_dict = load_init_dict(init_str)[1]
if init_dict is not None: # Initialisation by dict
assert type(init_dict) is dict
# Overwrite default value with init_dict content
if "axes" in list(init_dict.keys()):
axes = init_dict["axes"]
if "field" in list(init_dict.keys()):
field = init_dict["field"]
if "unit" in list(init_dict.keys()):
unit = init_dict["unit"]
if "name" in list(init_dict.keys()):
name = init_dict["name"]
if "symbol" in list(init_dict.keys()):
symbol = init_dict["symbol"]
if "normalizations" in list(init_dict.keys()):
normalizations = init_dict["normalizations"]
if "symmetries" in list(init_dict.keys()):
symmetries = init_dict["symmetries"]
# Set the properties (value check and convertion are done in setter)
self.parent = None
self.axes = axes
self.field = field
self.unit = unit
self.name = name
self.symbol = symbol
self.normalizations = normalizations
self.symmetries = symmetries
# The class is frozen, for now it's impossible to add new properties
self._freeze()
def __str__(self):
"""Convert this object in a readeable string (for print)"""
ImportData_str = ""
if self.parent is None:
ImportData_str += "parent = None " + linesep
else:
ImportData_str += "parent = " + str(type(self.parent)) + " object" + linesep
if len(self.axes) == 0:
ImportData_str += "axes = []" + linesep
for ii in range(len(self.axes)):
tmp = self.axes[ii].__str__().replace(linesep, linesep + "\t") + linesep
ImportData_str += "axes[" + str(ii) + "] =" + tmp + linesep + linesep
if self.field is not None:
tmp = self.field.__str__().replace(linesep, linesep + "\t").rstrip("\t")
ImportData_str += "field = " + tmp
else:
ImportData_str += "field = None" + linesep + linesep
ImportData_str += 'unit = "' + str(self.unit) + '"' + linesep
ImportData_str += 'name = "' + str(self.name) + '"' + linesep
ImportData_str += 'symbol = "' + str(self.symbol) + '"' + linesep
ImportData_str += "normalizations = " + str(self.normalizations) + linesep
ImportData_str += "symmetries = " + str(self.symmetries) + linesep
return ImportData_str
def __eq__(self, other):
"""Compare two objects (skip parent)"""
if type(other) != type(self):
return False
if other.axes != self.axes:
return False
if other.field != self.field:
return False
if other.unit != self.unit:
return False
if other.name != self.name:
return False
if other.symbol != self.symbol:
return False
if other.normalizations != self.normalizations:
return False
if other.symmetries != self.symmetries:
return False
return True
[docs] def compare(self, other, name="self", ignore_list=None, is_add_value=False):
"""Compare two objects and return list of differences"""
if ignore_list is None:
ignore_list = list()
if type(other) != type(self):
return ["type(" + name + ")"]
diff_list = list()
if (other.axes is None and self.axes is not None) or (
other.axes is not None and self.axes is None
):
diff_list.append(name + ".axes None mismatch")
elif self.axes is None:
pass
elif len(other.axes) != len(self.axes):
diff_list.append("len(" + name + ".axes)")
else:
for ii in range(len(other.axes)):
diff_list.extend(
self.axes[ii].compare(
other.axes[ii],
name=name + ".axes[" + str(ii) + "]",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if (other.field is None and self.field is not None) or (
other.field is not None and self.field is None
):
diff_list.append(name + ".field None mismatch")
elif self.field is not None:
diff_list.extend(
self.field.compare(
other.field,
name=name + ".field",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if other._unit != self._unit:
if is_add_value:
val_str = (
" (self=" + str(self._unit) + ", other=" + str(other._unit) + ")"
)
diff_list.append(name + ".unit" + val_str)
else:
diff_list.append(name + ".unit")
if other._name != self._name:
if is_add_value:
val_str = (
" (self=" + str(self._name) + ", other=" + str(other._name) + ")"
)
diff_list.append(name + ".name" + val_str)
else:
diff_list.append(name + ".name")
if other._symbol != self._symbol:
if is_add_value:
val_str = (
" (self="
+ str(self._symbol)
+ ", other="
+ str(other._symbol)
+ ")"
)
diff_list.append(name + ".symbol" + val_str)
else:
diff_list.append(name + ".symbol")
if other._normalizations != self._normalizations:
if is_add_value:
val_str = (
" (self="
+ str(self._normalizations)
+ ", other="
+ str(other._normalizations)
+ ")"
)
diff_list.append(name + ".normalizations" + val_str)
else:
diff_list.append(name + ".normalizations")
if other._symmetries != self._symmetries:
if is_add_value:
val_str = (
" (self="
+ str(self._symmetries)
+ ", other="
+ str(other._symmetries)
+ ")"
)
diff_list.append(name + ".symmetries" + val_str)
else:
diff_list.append(name + ".symmetries")
# Filter ignore differences
diff_list = list(filter(lambda x: x not in ignore_list, diff_list))
return diff_list
def __sizeof__(self):
"""Return the size in memory of the object (including all subobject)"""
S = 0 # Full size of the object
if self.axes is not None:
for value in self.axes:
S += getsizeof(value)
S += getsizeof(self.field)
S += getsizeof(self.unit)
S += getsizeof(self.name)
S += getsizeof(self.symbol)
if self.normalizations is not None:
for key, value in self.normalizations.items():
S += getsizeof(value) + getsizeof(key)
if self.symmetries is not None:
for key, value in self.symmetries.items():
S += getsizeof(value) + getsizeof(key)
return S
[docs] def as_dict(self, type_handle_ndarray=0, keep_function=False, **kwargs):
"""
Convert this object in a json serializable dict (can be use in __init__).
type_handle_ndarray: int
How to handle ndarray (0: tolist, 1: copy, 2: nothing)
keep_function : bool
True to keep the function object, else return str
Optional keyword input parameter is for internal use only
and may prevent json serializability.
"""
ImportData_dict = dict()
if self.axes is None:
ImportData_dict["axes"] = None
else:
ImportData_dict["axes"] = list()
for obj in self.axes:
if obj is not None:
ImportData_dict["axes"].append(
obj.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
)
else:
ImportData_dict["axes"].append(None)
if self.field is None:
ImportData_dict["field"] = None
else:
ImportData_dict["field"] = self.field.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
ImportData_dict["unit"] = self.unit
ImportData_dict["name"] = self.name
ImportData_dict["symbol"] = self.symbol
ImportData_dict["normalizations"] = (
self.normalizations.copy() if self.normalizations is not None else None
)
ImportData_dict["symmetries"] = (
self.symmetries.copy() if self.symmetries is not None else None
)
# The class name is added to the dict for deserialisation purpose
ImportData_dict["__class__"] = "ImportData"
return ImportData_dict
[docs] def copy(self):
"""Creates a deepcopy of the object"""
# Handle deepcopy of all the properties
if self.axes is None:
axes_val = None
else:
axes_val = list()
for obj in self.axes:
axes_val.append(obj.copy())
if self.field is None:
field_val = None
else:
field_val = self.field.copy()
unit_val = self.unit
name_val = self.name
symbol_val = self.symbol
if self.normalizations is None:
normalizations_val = None
else:
normalizations_val = self.normalizations.copy()
if self.symmetries is None:
symmetries_val = None
else:
symmetries_val = self.symmetries.copy()
# Creates new object of the same type with the copied properties
obj_copy = type(self)(
axes=axes_val,
field=field_val,
unit=unit_val,
name=name_val,
symbol=symbol_val,
normalizations=normalizations_val,
symmetries=symmetries_val,
)
return obj_copy
def _set_None(self):
"""Set all the properties to None (except pyleecan object)"""
self.axes = None
if self.field is not None:
self.field._set_None()
self.unit = None
self.name = None
self.symbol = None
self.normalizations = None
self.symmetries = None
def _get_axes(self):
"""getter of axes"""
if self._axes is not None:
for obj in self._axes:
if obj is not None:
obj.parent = self
return self._axes
def _set_axes(self, value):
"""setter of axes"""
if type(value) is list:
for ii, obj in enumerate(value):
if isinstance(obj, str): # Load from file
try:
obj = load_init_dict(obj)[1]
except Exception as e:
self.get_logger().error(
"Error while loading " + obj + ", setting None instead"
)
obj = None
value[ii] = None
if type(obj) is dict:
class_obj = import_class(
"pyleecan.Classes", obj.get("__class__"), "axes"
)
value[ii] = class_obj(init_dict=obj)
if value[ii] is not None:
value[ii].parent = self
if value == -1:
value = list()
check_var("axes", value, "[ImportData]")
self._axes = value
axes = property(
fget=_get_axes,
fset=_set_axes,
doc=u"""List of axes of the data
:Type: [ImportData]
""",
)
def _get_field(self):
"""getter of field"""
return self._field
def _set_field(self, value):
"""setter of field"""
if isinstance(value, str): # Load from file
try:
value = load_init_dict(value)[1]
except Exception as e:
self.get_logger().error(
"Error while loading " + value + ", setting None instead"
)
value = None
if isinstance(value, dict) and "__class__" in value:
class_obj = import_class(
"pyleecan.Classes", value.get("__class__"), "field"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
Import = import_class("pyleecan.Classes", "Import", "field")
value = Import()
check_var("field", value, "Import")
self._field = value
if self._field is not None:
self._field.parent = self
field = property(
fget=_get_field,
fset=_set_field,
doc=u"""Field (Import object)
:Type: Import
""",
)
def _get_unit(self):
"""getter of unit"""
return self._unit
def _set_unit(self, value):
"""setter of unit"""
check_var("unit", value, "str")
self._unit = value
unit = property(
fget=_get_unit,
fset=_set_unit,
doc=u"""Unit of the field
:Type: str
""",
)
def _get_name(self):
"""getter of name"""
return self._name
def _set_name(self, value):
"""setter of name"""
check_var("name", value, "str")
self._name = value
name = property(
fget=_get_name,
fset=_set_name,
doc=u"""Name of the field
:Type: str
""",
)
def _get_symbol(self):
"""getter of symbol"""
return self._symbol
def _set_symbol(self, value):
"""setter of symbol"""
check_var("symbol", value, "str")
self._symbol = value
symbol = property(
fget=_get_symbol,
fset=_set_symbol,
doc=u"""Symbol of the field
:Type: str
""",
)
def _get_normalizations(self):
"""getter of normalizations"""
return self._normalizations
def _set_normalizations(self, value):
"""setter of normalizations"""
if type(value) is int and value == -1:
value = dict()
check_var("normalizations", value, "dict")
self._normalizations = value
normalizations = property(
fget=_get_normalizations,
fset=_set_normalizations,
doc=u"""Dict of normalizations
:Type: dict
""",
)
def _get_symmetries(self):
"""getter of symmetries"""
return self._symmetries
def _set_symmetries(self, value):
"""setter of symmetries"""
if type(value) is int and value == -1:
value = dict()
check_var("symmetries", value, "dict")
self._symmetries = value
symmetries = property(
fget=_get_symmetries,
fset=_set_symmetries,
doc=u"""Dict of symmetries
:Type: dict
""",
)
