<filename>pesummary/utils/parameters.py
# Licensed under an MIT style license -- see LICENSE.md

from .list import List
from pesummary.gw.file.standard_names import descriptive_names

__author__ = ["<NAME> <<EMAIL>>"]


class Parameter(str):
    """Class to handle a single parameter

    Parameters
    ----------
    parameter: str
        name of the parameter
    description: str, optional
        text describing what parameter represents. Default, look to see if
        pesummary has a descriptive name for parameter else 'Unknown parameter
        description

    Attributes
    ----------
    description: str
        return text describing what parameter represents
    """
    def __new__(self, parameter, **kwargs):
        return super(Parameter, self).__new__(self, parameter)

    def __init__(self, parameter, description=None):
        self._parameter = parameter
        self._description = "Unknown parameter description"
        if description is None:
            if parameter in descriptive_names.keys():
                self._description = descriptive_names[parameter]
        else:
            self._description = description

    @property
    def description(self):
        return self._description

    def __repr__(self):
        return repr(self._parameter)


class Parameters(List):
    """Class to store the list of parameters

    Parameters
    ----------
    args: tuple
        all arguments are passed to the list class
    **kwargs: dict
        all kwargs are passed to the list class

    Attributes
    ----------
    added: list
        list of parameters that have been appended to the original list
    """
    def __init__(self, *args, cls=Parameter, **kwargs):
        self._cls = cls
        if len(args) == 1:
            super(Parameters, self).__init__(*args, cls=Parameter, **kwargs)
        else:
            _args = list(args)
            _args[2] = Parameter
            super(Parameters, self).__init__(*_args, **kwargs)

    def __iter__(self, *args, **kwargs):
        _iter = super(Parameters, self).__iter__(*args, **kwargs)
        for _value in _iter:
            yield self._cls(_value)


class MultiAnalysisParameters(List):
    """Class to store a multidimensional list of parameters

    Parameters
    ----------
    args: tuple
        all arguments are passed to the list class
    **kwargs: dict
        all kwargs are passed to the list class

    Attributes
    ----------
    added: list
        list of parameters that have been appended to the original list
    """
    def __init__(self, *args, cls=Parameters, **kwargs):
        self._cls = cls
        if len(args) == 1:
            super(MultiAnalysisParameters, self).__init__(
                *args, cls=cls, **kwargs
            )
        else:
            _args = list(args)
            _args[2] = Parameters
            super(MultiAnalysisParameters, self).__init__(*_args, **kwargs)

    def __getitem__(self, *args, **kwargs):
        self.cls = None
        output = super(List, self).__getitem__(*args, **kwargs)
        self.cls = self._cls
        if isinstance(output[0], list):
            return [self.cls(value) for value in output]
        return self.cls(output)

<filename>pesummary/utils/parameters.py
# Licensed under an MIT style license -- see LICENSE.md

from .list import List
from pesummary.gw.file.standard_names import descriptive_names

__author__ = ["<NAME> <<EMAIL>>"]


class Parameter(str):
    """Class to handle a single parameter

    Parameters
    ----------
    parameter: str
        name of the parameter
    description: str, optional
        text describing what parameter represents. Default, look to see if
        pesummary has a descriptive name for parameter else 'Unknown parameter
        description

    Attributes
    ----------
    description: str
        return text describing what parameter represents
    """
    def __new__(self, parameter, **kwargs):
        return super(Parameter, self).__new__(self, parameter)

    def __init__(self, parameter, description=None):
        self._parameter = parameter
        self._description = "Unknown parameter description"
        if description is None:
            if parameter in descriptive_names.keys():
                self._description = descriptive_names[parameter]
        else:
            self._description = description

    @property
    def description(self):
        return self._description

    def __repr__(self):
        return repr(self._parameter)


class Parameters(List):
    """Class to store the list of parameters

    Parameters
    ----------
    args: tuple
        all arguments are passed to the list class
    **kwargs: dict
        all kwargs are passed to the list class

    Attributes
    ----------
    added: list
        list of parameters that have been appended to the original list
    """
    def __init__(self, *args, cls=Parameter, **kwargs):
        self._cls = cls
        if len(args) == 1:
            super(Parameters, self).__init__(*args, cls=Parameter, **kwargs)
        else:
            _args = list(args)
            _args[2] = Parameter
            super(Parameters, self).__init__(*_args, **kwargs)

    def __iter__(self, *args, **kwargs):
        _iter = super(Parameters, self).__iter__(*args, **kwargs)
        for _value in _iter:
            yield self._cls(_value)


class MultiAnalysisParameters(List):
    """Class to store a multidimensional list of parameters

    Parameters
    ----------
    args: tuple
        all arguments are passed to the list class
    **kwargs: dict
        all kwargs are passed to the list class

    Attributes
    ----------
    added: list
        list of parameters that have been appended to the original list
    """
    def __init__(self, *args, cls=Parameters, **kwargs):
        self._cls = cls
        if len(args) == 1:
            super(MultiAnalysisParameters, self).__init__(
                *args, cls=cls, **kwargs
            )
        else:
            _args = list(args)
            _args[2] = Parameters
            super(MultiAnalysisParameters, self).__init__(*_args, **kwargs)

    def __getitem__(self, *args, **kwargs):
        self.cls = None
        output = super(List, self).__getitem__(*args, **kwargs)
        self.cls = self._cls
        if isinstance(output[0], list):
            return [self.cls(value) for value in output]
        return self.cls(output)

# Licensed under an MIT style license -- see LICENSE.md Class to handle a single parameter      Parameters     ----------     parameter: str         name of the parameter     description: str, optional         text describing what parameter represents. Default, look to see if         pesummary has a descriptive name for parameter else 'Unknown parameter         description      Attributes     ----------     description: str         return text describing what parameter represents Class to store the list of parameters      Parameters     ----------     args: tuple         all arguments are passed to the list class     **kwargs: dict         all kwargs are passed to the list class      Attributes     ----------     added: list         list of parameters that have been appended to the original list Class to store a multidimensional list of parameters      Parameters     ----------     args: tuple         all arguments are passed to the list class     **kwargs: dict         all kwargs are passed to the list class      Attributes     ----------     added: list         list of parameters that have been appended to the original list