145 lines
3.5 KiB
Python
145 lines
3.5 KiB
Python
import copy
|
|
from io import StringIO
|
|
import abc
|
|
|
|
import numpy as np
|
|
import yaml
|
|
|
|
from . import Rotation
|
|
from . import Orientation
|
|
|
|
class NiceDumper(yaml.SafeDumper):
|
|
"""Make YAML readable for humans."""
|
|
|
|
def write_line_break(self, data=None):
|
|
super().write_line_break(data)
|
|
|
|
if len(self.indents) == 1:
|
|
super().write_line_break()
|
|
|
|
def increase_indent(self, flow=False, indentless=False):
|
|
return super().increase_indent(flow, False)
|
|
|
|
def represent_data(self, data):
|
|
"""Cast Config objects and its subclasses to dict."""
|
|
if isinstance(data, dict) and type(data) != dict:
|
|
return self.represent_data(dict(data))
|
|
if isinstance(data, (Rotation, Orientation)):
|
|
return self.represent_data(data.as_quaternion())
|
|
else:
|
|
return super().represent_data(data)
|
|
|
|
def ignore_aliases(self, data):
|
|
"""No references."""
|
|
return True
|
|
|
|
class Config(dict):
|
|
"""YAML-based configuration."""
|
|
|
|
def __repr__(self):
|
|
"""Show as in file."""
|
|
output = StringIO()
|
|
self.save(output)
|
|
output.seek(0)
|
|
return ''.join(output.readlines())
|
|
|
|
|
|
def __copy__(self):
|
|
"""Create deep copy."""
|
|
return copy.deepcopy(self)
|
|
|
|
copy = __copy__
|
|
|
|
|
|
@classmethod
|
|
def load(cls,fname):
|
|
"""
|
|
Load from yaml file.
|
|
|
|
Parameters
|
|
----------
|
|
fname : file, str, or pathlib.Path
|
|
Filename or file for writing.
|
|
|
|
"""
|
|
try:
|
|
fhandle = open(fname)
|
|
except TypeError:
|
|
fhandle = fname
|
|
return cls(yaml.safe_load(fhandle))
|
|
|
|
|
|
def save(self,fname,**kwargs):
|
|
"""
|
|
Save to yaml file.
|
|
|
|
Parameters
|
|
----------
|
|
fname : file, str, or pathlib.Path
|
|
Filename or file for writing.
|
|
**kwargs : dict
|
|
Keyword arguments parsed to yaml.dump.
|
|
|
|
"""
|
|
try:
|
|
fhandle = open(fname,'w',newline='\n')
|
|
except TypeError:
|
|
fhandle = fname
|
|
|
|
if 'width' not in kwargs:
|
|
kwargs['width'] = 256
|
|
if 'default_flow_style' not in kwargs:
|
|
kwargs['default_flow_style'] = None
|
|
if 'sort_keys' not in kwargs:
|
|
kwargs['sort_keys'] = False
|
|
|
|
def array_representer(dumper, data):
|
|
"""Convert numpy array to list of native types."""
|
|
return dumper.represent_list([d.item() for d in data])
|
|
|
|
NiceDumper.add_representer(np.ndarray, array_representer)
|
|
|
|
try:
|
|
fhandle.write(yaml.dump(self,Dumper=NiceDumper,**kwargs))
|
|
except TypeError: # compatibility with old pyyaml
|
|
del kwargs['sort_keys']
|
|
fhandle.write(yaml.dump(self,Dumper=NiceDumper,**kwargs))
|
|
|
|
|
|
def add(self,d):
|
|
"""
|
|
Add dictionary.
|
|
|
|
d : dict
|
|
Dictionary to append.
|
|
"""
|
|
duplicate = self.copy()
|
|
duplicate.update(d)
|
|
return duplicate
|
|
|
|
|
|
def delete(self,key):
|
|
"""
|
|
Delete item.
|
|
|
|
key : str or scalar
|
|
Label of the key to remove.
|
|
"""
|
|
duplicate = self.copy()
|
|
del duplicate[key]
|
|
return duplicate
|
|
|
|
|
|
@property
|
|
@abc.abstractmethod
|
|
def is_complete(self):
|
|
"""Check for completeness."""
|
|
pass
|
|
|
|
|
|
@property
|
|
@abc.abstractmethod
|
|
def is_valid(self):
|
|
"""Check for valid file layout."""
|
|
pass
|