sofar 1.2.1__py3-none-any.whl

tests/test_io.py

@@ -0,0 +1,349 @@
+import sofar as sf
+from sofar.utils import (_get_conventions,
+                         _verify_convention_and_version,
+                         _atleast_nd,
+                         _nd_newaxis)
+from sofar.io import (_format_value_for_netcdf,
+                      _format_value_from_netcdf)
+import os
+import pathlib
+from tempfile import TemporaryDirectory
+import pytest
+import numpy as np
+import numpy.testing as npt
+from netCDF4 import Dataset
+from packaging.version import parse
+
+
+def test_read_write_sofa():
+
+    temp_dir = TemporaryDirectory()
+    filename = os.path.join(temp_dir.name, "test.sofa")
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+
+    # test defaults
+    sf.write_sofa(filename, sofa)
+    sofa = sf.read_sofa(filename)
+    assert hasattr(sofa, "_api")
+
+    # test with path object
+    sf.write_sofa(pathlib.Path(filename), sofa)
+    sofa = sf.read_sofa(pathlib.Path(filename))
+    assert hasattr(sofa, "_api")
+
+    # reading without updating API
+    sofa = sf.read_sofa(filename, verify=False)
+    assert not hasattr(sofa, "_api")
+
+    # read non-existing file
+    with pytest.raises(ValueError, match="test.sofa does not exist"):
+        sf.read_sofa("test.sofa")
+
+    # read file of unknown convention
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+    sf.write_sofa(filename, sofa)
+    with Dataset(filename, "r+", format="NETCDF4") as file:
+        file.SOFAConventions = "Funky"
+    with pytest.raises(ValueError, match="Convention 'Funky' does not exist"):
+        sf.read_sofa(filename)
+
+    # read file of unknown version (stored in file)
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+    sf.write_sofa(filename, sofa)
+    with Dataset(filename, "r+", format="NETCDF4") as file:
+        file.SOFAConventionsVersion = "0.1"
+    # ValueError when version should be matched
+    with pytest.raises(ValueError,
+                       match="v0.1 is not a valid SOFA Convention"):
+        sf.read_sofa(filename)
+
+    # read file containing a variable with wrong shape
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+    sf.write_sofa(filename, sofa)
+    # create variable with wrong shape
+    with Dataset(filename, "r+", format="NETCDF4") as file:
+        file.createDimension('A', 10)
+        var = file.createVariable("Data_IR", "f8", ('I', 'A'))
+        var[:] = np.zeros((1, 10)).astype("double")
+    # reading data with update API generates an error
+    with pytest.raises(ValueError, match="The SOFA object could not be"):
+        sf.read_sofa(filename)
+    # data can be read without updating API
+    sf.read_sofa(filename, verify=False)
+
+
+def test_read_sofa_custom_data():
+    """Test if sofa files with custom data are loaded correctly."""
+
+    temp_dir = TemporaryDirectory()
+    filename = os.path.join(temp_dir.name, "test.sofa")
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+
+    # GLOBAL attribute
+    sofa.add_attribute('GLOBAL_Warming', 'critical')
+    sf.write_sofa(filename, sofa)
+    sofa = sf.read_sofa(filename)
+    assert sofa.GLOBAL_Warming == 'critical'
+
+
+def test_read_netcdf():
+    tmp = TemporaryDirectory()
+    files = [os.path.join(tmp.name, "invalid.sofa"),
+             os.path.join(tmp.name, "invalid.netcdf")]
+
+    # create data with invalid SOFA convention and version
+    sofa = sf.Sofa("GeneralTF")
+    sofa.protected = False
+    sofa.GLOBAL_SOFAConventions = "MadeUp"
+    sofa.protected = True
+
+    # test reading
+    for file in files:
+        # write data
+        sf.io._write_sofa(file, sofa, verify=False)
+        # can not be read with read_sofa
+        with pytest.raises(ValueError, match="Convention 'MadeUp' does not"):
+            sf.read_sofa(file)
+        sofa_read = sf.read_sofa_as_netcdf(file)
+        sf.equals(sofa, sofa_read)
+
+
+def test_write_sofa_outdated_version():
+    """Test the warning for writing SOFA files with outdated versions."""
+
+    # generate test data and directory
+    tmp = TemporaryDirectory()
+    sofa = sf.Sofa("GeneralTF", version="1.0")
+
+    # write with outdated version
+    with pytest.warns(UserWarning, match="Writing SOFA object with outdated"):
+        sf.write_sofa(os.path.join(tmp.name, "outdated.sofa"), sofa)
+
+
+def test_write_sofa_compression():
+    """Test writing SOFA files with compression."""
+
+    # create temporary directory
+    temp_dir = TemporaryDirectory()
+
+    # create test data
+    sofa = sf.Sofa('SimpleFreeFieldHRIR')
+    sofa.Data_IR = np.zeros((1, 2, 2048))
+    sofa.Data_IR[0, 0] = np.array([1, 0, -1, 0] * 512)
+
+    filesize = None
+
+    for compression in range(10):
+        # write with current compression level
+        filename = os.path.join(temp_dir.name, f"test_{0}.sofa")
+        sf.write_sofa(filename, sofa, compression=compression)
+
+        # get and compare the file sizes
+        print(f"Assessing compression level {compression}")
+        if compression > 0:
+            assert os.stat(filename).st_size <= filesize
+        filesize = os.stat(filename).st_size
+
+
+# mandatory=True can not be tested because some conventions have default values
+# that have optional variables as dependencies
+@pytest.mark.parametrize("mandatory", [(False)])
+def test_roundtrip(mandatory):
+    """"
+    Cyclic test of create, write, read functions.
+
+    1. create_sofa
+    2. write_sofa
+    3. read_sofa
+    4. compare SOFA from 1. and 3.
+    """
+
+    temp_dir = TemporaryDirectory()
+    names_versions = _get_conventions(return_type="name_version")
+
+    _, _, deprecations, _ = sf.Sofa._verification_rules()
+
+    for name, version in names_versions:
+        print(f"Testing: {name} {version}")
+
+        # writing deprecated and proposed conventions is not tested
+        if name in deprecations["GLOBAL:SOFAConventions"] or \
+                parse(version) < parse('1.0'):
+            sofa = sf.Sofa(name, mandatory, version, verify=False)
+            # non stable conventions are not verified
+            if parse(version) >= parse('1.0'):
+                with pytest.warns(UserWarning, match="deprecations"):
+                    sofa.verify(mode="read")
+        else:
+            # test full round-trip for other conventions
+            file = os.path.join(temp_dir.name, name + ".sofa")
+            sofa = sf.Sofa(name, mandatory, version)
+            sf.write_sofa(file, sofa)
+            sofa_r = sf.read_sofa(file)
+            identical = sf.equals(sofa, sofa_r, verbose=True, exclude="DATE")
+            assert identical
+
+
+def test_roundtrip_multidimensional_string_variable():
+    """
+    Test writing and reading multidimensional string variables (Writing
+    string variables with one dimension is done in the other roundtrip test).
+    """
+
+    temp_dir = TemporaryDirectory()
+    file = os.path.join(temp_dir.name, "HeadphoneIR.sofa")
+
+    sofa = sf.Sofa("SimpleHeadphoneIR")
+    # add dummy matrix that contains 4 measurements
+    sofa.Data_IR = np.zeros((4, 2, 10))
+    # add (4, 1) string variable
+    sofa.SourceManufacturer = [["someone"], ["else"], ["did"], ["this"]]
+    # remove other string variables for simplicity
+    delattr(sofa, "SourceModel")
+    delattr(sofa, "ReceiverDescriptions")
+    delattr(sofa, "EmitterDescriptions")
+    delattr(sofa, "MeasurementDate")
+
+    # read write and assert
+    sf.write_sofa(file, sofa)
+    sofa_r = sf.read_sofa(file)
+
+    identical = sf.equals(sofa, sofa_r, exclude="DATE")
+    assert identical
+
+
+def test_format_value_for_netcdf():
+
+    # string and None dimensions (a.k.a NETCDF attribute)
+    value, dtype = _format_value_for_netcdf(
+        "string", "test_attr", "attribute", None, 12)
+    assert value == "string"
+    assert dtype == "attribute"
+
+    # int that should be converted to a string
+    value, dtype = _format_value_for_netcdf(
+        1, "test_attr", "attribute", None, 12)
+    assert value == "1"
+    assert dtype == "attribute"
+
+    # float that should be converted to a string
+    value, dtype = _format_value_for_netcdf(
+        0.2, "test_attr", "attribute", None, 12)
+    assert value == "0.2"
+    assert dtype == "attribute"
+
+    # string and IS dimensions
+    value, dtype = _format_value_for_netcdf(
+        "string", "TestVar", "string", "IS", 12)
+    assert value == np.array("string", dtype="S12")
+    assert dtype == "S1"
+    assert value.ndim == 2
+
+    # single entry array and none Dimensions
+    value, dtype = _format_value_for_netcdf(
+        ["string"], "TestVar", "string", "IS", 12)
+    assert value == np.array(["string"], dtype="S12")
+    assert dtype == "S1"
+    assert value.ndim == 2
+
+    # array of strings
+    value, dtype = _format_value_for_netcdf(
+        [["a"], ["bc"]], "TestVar", "string", "MS", 12)
+    assert all(value == np.array([["a"], ["bc"]], "S12"))
+    assert dtype == "S1"
+    assert value.ndim == 2
+
+    # test with list
+    value, dtype = _format_value_for_netcdf(
+        [0, 0], "TestVar", "double", "MR", 12)
+    npt.assert_allclose(value, np.array([0, 0])[np.newaxis, ])
+    assert dtype == "f8"
+    assert value.ndim == 2
+
+    # test with numpy array
+    value, dtype = _format_value_for_netcdf(
+        np.array([0, 0]), "TestVar", "double", "MR", 12)
+    npt.assert_allclose(value, np.array([0, 0])[np.newaxis, ])
+    assert dtype == "f8"
+    assert value.ndim == 2
+
+    # unknown data type
+    with pytest.raises(ValueError, match="Unknown type int for TestVar"):
+        value, dtype = _format_value_for_netcdf(1, "TestVar", "int", "MR", 12)
+
+
+def test_format_value_from_netcdf():
+
+    # single string (emulate NetCDF binary format)
+    value_in = np.array(["s", "t", "r"], dtype="S1")
+    value = _format_value_from_netcdf(value_in, "Some_Attribute")
+    assert value == "str"
+
+    # array of strings (emulate NetCDF binary format)
+    value_in = np.array([["s", "t", "r", "1"], ["s", "t", "r", "2"]],
+                        dtype="S1")
+    value = _format_value_from_netcdf(value_in, "Some_Attribute")
+    assert all(value == np.array(["str1", "str2"], dtype="U"))
+
+    # single string (emulate NetCDF ascii encoding)
+    value_in = np.array(["str"], dtype="U")
+    value = _format_value_from_netcdf(value_in, "Some_Attribute")
+    assert value == "str"
+
+    # array of strings (emulate NetCDF binary format)
+    value_in = np.array(["str1", "str2"], dtype="U")
+    value = _format_value_from_netcdf(value_in, "Some_Attribute")
+    assert all(value == np.array(["str1", "str2"], dtype="U"))
+
+    # numerical array that can be scalar
+    value = _format_value_from_netcdf(
+        np.array([44100], dtype="float"), "Data_SamplingRate")
+    assert value == 44100.
+
+    # numerical array that can not be scalar
+    value = _format_value_from_netcdf(
+        np.array([44100], dtype="float"), "Data_IR")
+    assert value == np.array(44100., dtype="float")
+
+    # masked array with missing data
+    array = np.ma.masked_array([1, 2], mask=[0, 1], dtype="float")
+    with pytest.warns(UserWarning, match="Entry Data_IR contains missing"):
+        value = _format_value_from_netcdf(array, "Data_IR")
+    npt.assert_allclose(value, array)
+
+    # test with invalid data dtype
+    with pytest.raises(TypeError, match="Data_IR: value.dtype is complex"):
+        _format_value_from_netcdf(
+            np.array([44100], dtype="complex"), "Data_IR")
+
+
+def test_verify_convention_and_version():
+
+    # test with existing convention and version (no error returns None)
+    out = _verify_convention_and_version("1.0", "GeneralTF")
+    assert out is None
+
+    # test assertions
+    with pytest.raises(ValueError, match="Convention 'Funky' does not exist"):
+        _verify_convention_and_version("1.0", "Funky")
+    with pytest.raises(ValueError,
+                       match="v1.1 is not a valid SOFA Convention"):
+        _verify_convention_and_version("1.1", "GeneralTF")
+
+
+def test_atleast_nd():
+    # test with single dimension array
+    for ndim in range(1, 6):
+        array = _atleast_nd(1, ndim)
+        assert array.ndim == ndim
+        assert array.flatten() == np.array([1])
+
+    # test with two-dimensional array
+    for ndim in range(1, 6):
+        array = _atleast_nd(np.atleast_2d(1), ndim)
+        assert array.ndim == max(2, ndim)
+        assert array.flatten() == np.array([1])
+
+
+def test_nd_newaxis():
+    assert _nd_newaxis([1, 2, 3, 4, 5, 6], 2).shape == (6, 1)

tests/test_sofa.py

@@ -0,0 +1,353 @@
+"""Tests for sofar.Sofa (test for Sofa.verifycontained in test_sofa_verify)."""
+import sofar as sf
+import os
+from tempfile import TemporaryDirectory
+import pytest
+import numpy as np
+
+
+def test_create_sofa_object(capfd):
+    # test assertion for type of convention parameter
+    with pytest.raises(TypeError, match="Convention must be a string"):
+        sf.Sofa(1)
+    # test assertion for invalid conventions
+    with pytest.raises(ValueError, match="Convention 'invalid' not found"):
+        sf.Sofa("invalid")
+
+    # test creation with defaults
+    sofa = sf.Sofa("GeneralTF")
+    assert isinstance(sofa, sf.Sofa)
+    assert sofa.GLOBAL_SOFAConventionsVersion == "2.0"
+    assert hasattr(sofa, '_convention')
+    assert hasattr(sofa, '_dimensions')
+    assert hasattr(sofa, '_api')
+
+    # assert __repr__
+    print(sofa)
+    out, _ = capfd.readouterr()
+    assert out == "sofar.SOFA object: GeneralTF 2.0\n"
+
+    # test returning only mandatory fields
+    sofa_all = sf.Sofa("GeneralTF")
+    sofa_man = sf.Sofa("GeneralTF", mandatory=True)
+    assert len(sofa_all.__dict__) > len(sofa_man.__dict__)
+
+    # test version parameter
+    sofa = sf.Sofa("GeneralTF", version="1.0")
+    assert str(sofa.GLOBAL_SOFAConventionsVersion) == "1.0"
+
+    # test invalid version
+    with pytest.raises(ValueError, match="Version 0.25 not found. Available"):
+        sf.Sofa("GeneralTF", version="0.25")
+
+    # test without updating the api
+    sofa = sf.Sofa("GeneralTF", verify=False)
+    assert hasattr(sofa, '_convention')
+    assert not hasattr(sofa, '_dimensions')
+    assert not hasattr(sofa, '_api')
+
+
+def test_set_attributes_of_sofa_object():
+    sofa = sf.Sofa("GeneralTF")
+
+    # set attribute
+    assert (sofa.ListenerPosition == [0, 0, 0]).all()
+    sofa.ListenerPosition = np.array([1, 1, 1])
+    assert (sofa.ListenerPosition == [1, 1, 1]).all()
+
+    # set read only attribute
+    with pytest.raises(TypeError, match="GLOBAL_Version is a read only"):
+        sofa.GLOBAL_Version = 1
+
+    # set non-existing attribute
+    with pytest.raises(TypeError, match="new is an invalid attribute"):
+        sofa.new = 1
+
+
+def test_delete_attribute_from_sofa_object():
+    sofa = sf.Sofa("GeneralTF")
+
+    # delete optional attribute
+    delattr(sofa, "GLOBAL_ApplicationName")
+
+    # delete mandatory attribute
+    with pytest.raises(TypeError, match="GLOBAL_Version is a mandatory"):
+        delattr(sofa, "GLOBAL_Version")
+
+    # delete not existing attribute
+    with pytest.raises(TypeError, match="new is not an attribute"):
+        delattr(sofa, "new")
+
+
+def test_copy_sofa_object():
+    sofa_org = sf.Sofa("GeneralTF")
+    sofa_cp = sofa_org.copy()
+
+    assert sf.equals(sofa_org, sofa_cp, verbose=False)
+    assert id(sofa_org) != id(sofa_cp)
+
+
+def test_list_dimensions(capfd):
+
+    # test FIR Data
+    sofa = sf.Sofa("GeneralFIR")
+    _ = sofa.list_dimensions
+    out, _ = capfd.readouterr()
+    assert "N = 1 samples (set by Data_IR of dimension MRN)" in out
+
+    # test TF Data
+    sofa = sf.Sofa("GeneralTF")
+    _ = sofa.list_dimensions
+    out, _ = capfd.readouterr()
+    assert "N = 1 frequencies (set by Data_Real of dimension MRN)" in out
+
+    # test SOS Data
+    sofa = sf.Sofa("SimpleFreeFieldHRSOS")
+    _ = sofa.list_dimensions
+    out, _ = capfd.readouterr()
+    assert "N = 6 SOS coefficients (set by Data_SOS of dimension MRN)" in out
+
+    # test non spherical harmonics data
+    sofa = sf.Sofa("GeneralFIR")
+    _ = sofa.list_dimensions
+    out, _ = capfd.readouterr()
+    assert "E = 1 emitter" in out
+    assert "R = 1 receiver" in out
+
+    sofa.EmitterPosition_Type = "spherical harmonics"
+    sofa.ReceiverPosition_Type = "spherical harmonics"
+    sofa.EmitterPosition_Units = "degree, degree, metre"
+    sofa.ReceiverPosition_Units = "degree, degree, metre"
+    _ = sofa.list_dimensions
+    out, _ = capfd.readouterr()
+    assert "E = 1 emitter spherical harmonics coefficients" in out
+    assert "R = 1 receiver spherical harmonics coefficients" in out
+
+    # test assertion in case of variables with wrong type or shape
+    sofa = sf.Sofa("GeneralFIR")
+    sofa.Data_IR = "test"
+    with pytest.raises(ValueError, match="Dimensions can not be shown"):
+        _ = sofa.list_dimensions
+    sofa.Data_IR = [1, 2, 3, 4]
+    with pytest.raises(ValueError, match="Dimensions can not be shown"):
+        _ = sofa.list_dimensions
+
+
+def test_get_dimension():
+    """Test getting the size of dimensions."""
+
+    # test FIR Data
+    sofa = sf.Sofa("GeneralFIR")
+    size = sofa.get_dimension("N")
+    assert size == 1
+
+    # test with wrong dimension
+    with pytest.raises(ValueError, match="Q is not a valid dimension"):
+        size = sofa.get_dimension("Q")
+
+
+def test_info(capfd):
+
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+
+    # test with wrong info string
+    with pytest.raises(
+            ValueError, match="info='invalid' is invalid"):
+        sofa.info("invalid")
+
+    # test with default parameter
+    sofa.info()
+    out, _ = capfd.readouterr()
+    assert "showing all entries" in out
+
+    # test listing all entry names
+    for info in ["all", "mandatory", "optional", "read only", "data"]:
+        sofa.info(info)
+        out, _ = capfd.readouterr()
+        assert f"showing {info} entries" in out
+
+    # list information for specific entry
+    sofa.info("ListenerPosition")
+    out, _ = capfd.readouterr()
+    assert "ListenerPosition\n    type: double" in out
+    assert "ListenerPosition_Type\n    type: attribute" in out
+    assert "ListenerPosition_Units\n    type: attribute" in out
+
+
+def test_inspect(capfd):
+
+    temp_dir = TemporaryDirectory()
+    file = os.path.join(temp_dir.name, "info.txt")
+
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+
+    # inspect file
+    sofa.inspect(file)
+
+    # check terminal output
+    out, _ = capfd.readouterr()
+    assert "GLOBAL_SOFAConventions : SimpleFreeFieldHRIR" in out
+    assert ("ReceiverPosition : (R=2, C=3, I=1)\n"
+            "  [[ 0.    0.09  0.  ]\n"
+            "   [ 0.   -0.09  0.  ]]") in out
+
+    # check text file
+    with open(file, "r") as f_id:
+        text = f_id.readlines()
+    assert out == "".join(text)
+
+
+def test_add_entry():
+
+    sofa = sf.Sofa("GeneralTF")
+
+    tmp_dir = TemporaryDirectory()
+
+    # test adding a single variable entry
+    sofa.add_variable("Temperature", 25.1, "double", "MI")
+    entry = {"flags": None, "dimensions": "MI", "type": "double",
+             "default": None, "comment": ""}
+    assert sofa.Temperature == 25.1
+    assert sofa._custom["Temperature"] == entry
+    assert sofa._convention["Temperature"] == entry
+
+    # test adding string variable, global and local attributes
+    sofa.add_variable("Mood", "good", "string", "MS")
+    assert sofa.Mood == "good"
+    sofa.add_attribute("GLOBAL_Mood", "good")
+    assert sofa.GLOBAL_Mood == "good"
+    sofa.add_attribute("Temperature_Units", "degree celsius")
+    assert sofa.Temperature_Units == "degree celsius"
+
+    # check if everything can be verified and written, and read correctly
+    sf.write_sofa(os.path.join(tmp_dir.name, "tmp.sofa"), sofa)
+    sofa_read = sf.read_sofa(os.path.join(tmp_dir.name, "tmp.sofa"))
+    assert sf.equals(sofa, sofa_read)
+
+    # test deleting an entry
+    delattr(sofa, "Temperature_Units")
+    assert not hasattr(sofa, "Temperature_Units")
+    assert "Temperature_Units" not in sofa._custom
+
+    # test adding missing entry defined in convention
+    sofa.protected = False
+    delattr(sofa, "ListenerPosition")
+    sofa.protected = True
+    sofa.add_variable("ListenerPosition", [0, 0, 0], "double", "IC")
+    assert "ListenerPosition" not in sofa._custom
+
+    # test assertions
+    # add existing entry
+    with pytest.raises(ValueError, match="Entry Temperature already exists"):
+        sofa.add_variable("Temperature", 25.1, "double", "MI")
+    # entry violating the naming convention
+    with pytest.raises(ValueError, match="underscores '_' in the name"):
+        sofa.add_variable("Temperature_Celsius", 25.1, "double", "MI")
+    with pytest.raises(ValueError, match="The name of Data"):
+        sofa.add_attribute("Data_Time_measured", "midnight")
+    # entry with wrong type
+    with pytest.raises(ValueError, match="dtype is float but must be"):
+        sofa.add_variable("TemperatureCelsius", 25.1, "float", "MI")
+    # variable without dimensions
+    with pytest.raises(ValueError, match="dimensions must be provided"):
+        sofa.add_variable("TemperatureCelsius", 25.1, "double", None)
+    # invalid dimensions
+    with pytest.warns(UserWarning, match="Added custom dimension T"):
+        sofa.add_variable("TemperatureCelsius", [25.1, 25.2], "double", "T")
+    # attribute with missing variable
+    with pytest.raises(ValueError, match="Adding Attribute Variable"):
+        sofa.add_attribute("Variable_Unit", "celsius")
+
+
+@pytest.mark.parametrize(("mandatory", "optional"),
+                         [(True, False), (False, True), (True, True)])
+@pytest.mark.parametrize("verbose", [True, False])
+def test_add_missing(
+        mandatory, optional, verbose, capfd):
+
+    sofa = sf.Sofa("GeneralTF")
+
+    # attributes for testing
+    man = "GLOBAL_AuthorContact"
+    opt = "GLOBAL_History"
+
+    # remove data before adding it again
+    sofa.protected = False
+    sofa.delete(man)
+    sofa.delete(opt)
+    sofa.protected = False
+
+    # add missing data
+    sofa.add_missing(mandatory, optional, verbose)
+    out, _ = capfd.readouterr()
+
+    if mandatory and optional:
+        assert hasattr(sofa, man) and hasattr(sofa, opt)
+    elif mandatory:
+        assert hasattr(sofa, man) and not hasattr(sofa, opt)
+    elif optional:
+        assert not hasattr(sofa, man) and hasattr(sofa, opt)
+
+    if verbose:
+        if mandatory and optional:
+            assert man in out and opt in out
+        elif mandatory:
+            assert man in out and opt not in out
+        elif optional:
+            assert man not in out and opt in out
+    else:
+        assert out == ""
+
+
+def test_delete_entry():
+
+    sofa = sf.Sofa("SimpleHeadphoneIR")
+    assert hasattr(sofa, "GLOBAL_History")
+    assert hasattr(sofa, "SourceManufacturer")
+    # delete one optional attribute and variable
+    sofa.delete("GLOBAL_History")
+    sofa.delete("SourceManufacturer")
+    # check if data were removed
+    assert not hasattr(sofa, "GLOBAL_History")
+    assert not hasattr(sofa, "SourceManufacturer")
+
+
+def test__get_size_and_shape_of_string_var():
+
+    # test with string
+    S, shape = sf.Sofa._get_size_and_shape_of_string_var("four", "key")
+    assert S == 4
+    assert shape == (1, 1)
+
+    # test with single string list
+    S, shape = sf.Sofa._get_size_and_shape_of_string_var(["four"], "key")
+    assert S == 4
+    assert shape == (1, )
+
+    # test with list of strings
+    S, shape = sf.Sofa._get_size_and_shape_of_string_var(
+        ["four", "fivee"], "key")
+    assert S == 5
+    assert shape == (2, )
+
+    # test with numpy strings array
+    S, shape = sf.Sofa._get_size_and_shape_of_string_var(
+        np.array(["four", "fivee"], dtype="S256"), "key")
+    assert S == 5
+    assert shape == (2, )
+
+    # test with wrong type
+    with pytest.raises(TypeError, match="key must be a string"):
+        sf.Sofa._get_size_and_shape_of_string_var(1, "key")
+
+
+def test___mandatory():
+    assert sf.Sofa._mandatory("rm")
+    assert not sf.Sofa._mandatory("r")
+    assert not sf.Sofa._mandatory(None)
+
+
+def test___readonly():
+    assert sf.Sofa._read_only("rm")
+    assert not sf.Sofa._read_only("m")
+    assert not sf.Sofa._read_only(None)