arelle-release 2.37.17__py3-none-any.whl → 2.37.19__py3-none-any.whl

tests/unit_tests/arelle/test_frozen_ordered_set.py

@@ -0,0 +1,315 @@
+from collections.abc import Iterable
+
+import pytest
+
+from arelle.PythonUtil import FrozenOrderedSet, OrderedSet
+
+
+class TestFrozenOrderedSet:
+    def test_empty_initialization(self):
+        fos = FrozenOrderedSet()
+        assert len(fos) == 0
+        assert not fos
+        assert list(fos) == []
+
+    def test_initialization_with_list(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+        assert list(fos) == [1, 2, 3]
+        assert len(fos) == 3
+
+    def test_initialization_with_tuple(self):
+        fos = FrozenOrderedSet((4, 5, 6))
+        assert list(fos) == [4, 5, 6]
+
+    def test_initialization_with_string(self):
+        fos = FrozenOrderedSet("abc")
+        assert list(fos) == ["a", "b", "c"]
+
+    def test_initialization_with_set(self):
+        fos = FrozenOrderedSet({7, 8, 9})
+        assert len(fos) == 3
+        assert 7 in fos
+        assert 8 in fos
+        assert 9 in fos
+
+    def test_initialization_with_ordered_set(self):
+        fos = FrozenOrderedSet(OrderedSet([7, 8, 9]))
+        assert len(fos) == 3
+        assert 7 in fos
+        assert 8 in fos
+        assert 9 in fos
+
+    def test_initialization_with_duplicates(self):
+        fos = FrozenOrderedSet([1, 2, 2, 3, 1, 4])
+        assert list(fos) == [1, 2, 3, 4]
+        assert len(fos) == 4
+
+    def test_contains(self):
+        fos = FrozenOrderedSet([1, 2, 3, "a", "b"])
+
+        assert 1 in fos
+        assert 2 in fos
+        assert 3 in fos
+
+        assert 4 not in fos
+        assert None not in fos
+
+    def test_len(self):
+        assert len(FrozenOrderedSet()) == 0
+        assert len(FrozenOrderedSet([1])) == 1
+        assert len(FrozenOrderedSet([1, 2, 3])) == 3
+        assert len(FrozenOrderedSet([1, 1, 2, 2, 3])) == 3
+
+    def test_iteration(self):
+        fos = FrozenOrderedSet(["first", "second", "third"])
+        result = []
+        for item in fos:
+            result.append(item)
+        assert result == ["first", "second", "third"]
+
+    def test_reversed_iteration(self):
+        fos = FrozenOrderedSet(["first", "second", "third"])
+        result = list(reversed(fos))
+        assert result == ["third", "second", "first"]
+
+    def test_repr(self):
+        # Empty set
+        fos_empty = FrozenOrderedSet()
+        assert repr(fos_empty) == "FrozenOrderedSet()"
+
+        # Non-empty set
+        fos = FrozenOrderedSet([1, 2, 3])
+        assert repr(fos) == "FrozenOrderedSet((1, 2, 3))"
+
+        # With strings
+        fos_str = FrozenOrderedSet(["a", "b"])
+        assert repr(fos_str) == "FrozenOrderedSet(('a', 'b'))"
+
+    def test_equality_with_frozen_ordered_set(self):
+        fos1 = FrozenOrderedSet([1, 2, 3])
+        fos2 = FrozenOrderedSet([1, 2, 3])
+        fos3 = FrozenOrderedSet([3, 2, 1])
+        fos4 = FrozenOrderedSet([1, 2, 3, 4])
+
+        assert fos1 == fos2
+        assert fos1 != fos3
+        assert fos1 != fos4
+        assert FrozenOrderedSet() == FrozenOrderedSet()
+
+    def test_equality_with_ordered_set(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+        os1 = OrderedSet([1, 2, 3])
+        os2 = OrderedSet([3, 2, 1])
+
+        assert fos == os1
+        assert fos != os2
+
+    def test_equality_with_other_iterables(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        assert fos == {1, 2, 3}
+        assert fos == {3, 2, 1}
+        assert fos == [1, 2, 3]
+        assert fos == [3, 2, 1]
+        assert fos == (1, 2, 3)
+        assert fos == (3, 2, 1)
+        assert fos != [1, 2, 4]
+        assert fos != {1, 2, 4}
+
+    def test_equality_with_non_iterables(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        assert fos != 42
+        assert fos != "123"
+        assert fos != None
+
+    def test_hashable(self):
+        fos1 = FrozenOrderedSet([1, 2, 3])
+        fos2 = FrozenOrderedSet([1, 2, 3])
+        fos3 = FrozenOrderedSet([3, 2, 1])
+
+        assert hash(fos1) == hash(fos2)
+        assert hash(fos1) != hash(fos3)
+
+        d = {fos1: "value1", fos3: "value3"}
+        assert d[fos1] == "value1"
+        assert d[fos2] == "value1"
+        assert d[fos3] == "value3"
+
+        s = {fos1, fos2, fos3}
+        assert len(s) == 2
+
+    def test_hash_consistency(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+        hash1 = hash(fos)
+        hash2 = hash(fos)
+        hash3 = hash(fos)
+
+        assert hash1 == hash2
+        assert hash2 == hash3
+
+    def test_immutability(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        assert not hasattr(fos, "add")
+        assert not hasattr(fos, "remove")
+        assert not hasattr(fos, "discard")
+        assert not hasattr(fos, "pop")
+        assert not hasattr(fos, "clear")
+        assert not hasattr(fos, "update")
+
+    def test_set_operations_type_compatibility(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        assert isinstance(fos, Iterable)
+
+    def test_with_unhashable_types(self):
+        with pytest.raises(TypeError):
+            FrozenOrderedSet([[1, 2], [3, 4]])
+
+        with pytest.raises(TypeError):
+            FrozenOrderedSet([{1: 2}, {3: 4}])
+
+    def test_order_preservation_complex(self):
+        fos = FrozenOrderedSet([3, 1, 4, 1, 5, 9, 2, 6, 5])
+        expected_order = [3, 1, 4, 5, 9, 2, 6]
+        assert list(fos) == expected_order
+
+    def test_boolean_evaluation(self):
+        assert not FrozenOrderedSet()
+        assert FrozenOrderedSet([1])
+        assert FrozenOrderedSet([0])
+        assert FrozenOrderedSet([None])
+
+    def test_large_dataset(self):
+        large_list = list(range(1000))
+        fos = FrozenOrderedSet(large_list)
+
+        assert len(fos) == 1000
+        assert list(fos) == large_list
+        assert 500 in fos
+        assert 1000 not in fos
+
+    def test_nested_iteration(self):
+        fos = FrozenOrderedSet(["a", "b", "c"])
+
+        iter1 = iter(fos)
+        iter2 = iter(fos)
+
+        assert next(iter1) == "a"
+        assert next(iter2) == "a"
+        assert next(iter1) == "b"
+        assert next(iter2) == "b"
+
+    def test_edge_cases_empty_string_and_zero(self):
+        fos = FrozenOrderedSet(["", 0, False, None])
+
+        assert len(fos) == 3
+        assert "" in fos
+        assert 0 in fos
+        assert False in fos
+        assert None in fos
+
+        assert list(fos) == ["", 0, None]
+
+    def test_generator_as_input(self):
+
+        def gen():
+            yield 1
+            yield 2
+            yield 3
+            yield 2
+
+        fos = FrozenOrderedSet(gen())
+        assert list(fos) == [1, 2, 3]
+        assert len(fos) == 3
+
+    def test_comparison_with_different_types(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        assert fos != "not_iterable_comparison"
+        assert fos == frozenset([3, 2, 1])
+
+    def test_index_access(self):
+        fos = FrozenOrderedSet([10, 20, 30, 40, 50])
+
+        assert fos[0] == 10
+        assert fos[1] == 20
+        assert fos[2] == 30
+        assert fos[3] == 40
+        assert fos[4] == 50
+
+        assert fos[-1] == 50
+        assert fos[-2] == 40
+        assert fos[-3] == 30
+        assert fos[-4] == 20
+        assert fos[-5] == 10
+
+    def test_index_access_empty_set(self):
+        fos = FrozenOrderedSet()
+
+        with pytest.raises(IndexError):
+            fos[0]
+
+        with pytest.raises(IndexError):
+            fos[-1]
+
+    def test_index_access_out_of_bounds(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        with pytest.raises(IndexError):
+            fos[3]
+
+        with pytest.raises(IndexError):
+            fos[10]
+
+        with pytest.raises(IndexError):
+            fos[-4]
+
+        with pytest.raises(IndexError):
+            fos[-10]
+
+    def test_index_access_single_element(self):
+        fos = FrozenOrderedSet([42])
+
+        assert fos[0] == 42
+        assert fos[-1] == 42
+
+        with pytest.raises(IndexError):
+            fos[1]
+
+        with pytest.raises(IndexError):
+            fos[-2]
+
+    def test_index_access_with_strings(self):
+        fos = FrozenOrderedSet(["apple", "banana", "cherry"])
+
+        assert fos[0] == "apple"
+        assert fos[1] == "banana"
+        assert fos[2] == "cherry"
+        assert fos[-1] == "cherry"
+        assert fos[-2] == "banana"
+        assert fos[-3] == "apple"
+
+    def test_index_access_with_duplicates_removed(self):
+        fos = FrozenOrderedSet([5, 3, 5, 1, 3, 7])
+
+        assert fos[0] == 5
+        assert fos[1] == 3
+        assert fos[2] == 1
+        assert fos[3] == 7
+
+        with pytest.raises(IndexError):
+            fos[4]
+
+    def test_index_access_invalid_type(self):
+        fos = FrozenOrderedSet([1, 2, 3])
+
+        with pytest.raises(TypeError):
+            fos["invalid"]  # type: ignore[assignment]
+
+        with pytest.raises(TypeError):
+            fos[1.5]  # type: ignore[assignment]
+
+        with pytest.raises(TypeError):
+            fos[None]  # type: ignore[assignment]

tests/unit_tests/arelle/test_import.py

@@ -17,6 +17,37 @@ KNOWN_FAILURES = frozenset([
     'arelle.archive.plugin.validate.XFsyntax.xf',
     'arelle.formula.FormulaEvaluator',
 ])
+
+# OIM Taxonomy uses typing features not available in Python 3.9 and earlier.
+# Python 3.9 support will be dropped before this plugin is fully supported.
+if sys.version_info < (3, 10):
+    KNOWN_FAILURES |= frozenset([
+        'arelle.plugin.OimTaxonomy.__init__',
+        'arelle.plugin.OimTaxonomy.ModelValueMore',
+        'arelle.plugin.OimTaxonomy.ValidateDTS',
+        'arelle.plugin.OimTaxonomy.ViewXbrlTxmyObj',
+        'arelle.plugin.OimTaxonomy.XbrlAbstract',
+        'arelle.plugin.OimTaxonomy.XbrlConcept',
+        'arelle.plugin.OimTaxonomy.XbrlConst',
+        'arelle.plugin.OimTaxonomy.XbrlCube',
+        'arelle.plugin.OimTaxonomy.XbrlDimension',
+        'arelle.plugin.OimTaxonomy.XbrlDts',
+        'arelle.plugin.OimTaxonomy.XbrlEntity',
+        'arelle.plugin.OimTaxonomy.XbrlGroup',
+        'arelle.plugin.OimTaxonomy.XbrlImportedTaxonomy',
+        'arelle.plugin.OimTaxonomy.XbrlLabel',
+        'arelle.plugin.OimTaxonomy.XbrlNetwork',
+        'arelle.plugin.OimTaxonomy.XbrlProperty',
+        'arelle.plugin.OimTaxonomy.XbrlReference',
+        'arelle.plugin.OimTaxonomy.XbrlReport',
+        'arelle.plugin.OimTaxonomy.XbrlTableTemplate',
+        'arelle.plugin.OimTaxonomy.XbrlTaxonomy',
+        'arelle.plugin.OimTaxonomy.XbrlTaxonomyObject',
+        'arelle.plugin.OimTaxonomy.XbrlTransform',
+        'arelle.plugin.OimTaxonomy.XbrlTypes',
+        'arelle.plugin.OimTaxonomy.XbrlUnit',
+    ])
+
 # Don't test common third party plugins which may be copied into a developer's workspace.
 IGNORE_MODULE_PREFIXES = (
     'arelle.plugin.EDGAR',

tests/unit_tests/arelle/test_ordered_set.py

@@ -0,0 +1,272 @@
+
+import pytest
+
+from arelle.PythonUtil import OrderedSet
+
+
+class TestOrderedSet:
+
+    def test_init_empty(self):
+        os = OrderedSet()
+        assert len(os) == 0
+        assert list(os) == []
+        assert bool(os) is False
+
+    def test_init_with_iterable(self):
+        os = OrderedSet([1, 2, 3, 2, 1])
+        assert len(os) == 3
+        assert list(os) == [1, 2, 3]
+
+    def test_add_duplicate_order(self):
+        os = OrderedSet()
+        os.add(1)
+        os.add(2)
+        os.add(1)
+        assert list(os) == [1, 2]
+        assert len(os) == 2
+
+    def test_contains(self):
+        os = OrderedSet([1, 2, 3])
+        assert 1 in os
+        assert 2 in os
+        assert 3 in os
+        assert 4 not in os
+        assert "1" not in os
+
+    def test_update(self):
+        os = OrderedSet([1, 2])
+        os.update([3, 4, 2, 5])
+        assert list(os) == [1, 2, 3, 4, 5]
+
+    def test_update_with_string(self):
+        os = OrderedSet(['a', 'b'])
+        os.update("bcd")
+        assert list(os) == ['a', 'b', 'c', 'd']
+
+    def test_discard(self):
+        os = OrderedSet([1, 2, 3, 4])
+        os.discard(2)
+        assert list(os) == [1, 3, 4]
+
+        # Discarding non-existent element should not raise error
+        non_existent_element = 10
+        os.discard(non_existent_element)
+        assert list(os) == [1, 3, 4]
+
+    def test_discard_from_empty(self):
+        os = OrderedSet()
+        os.discard(1)
+        assert len(os) == 0
+
+    def test_pop_last(self):
+        os = OrderedSet([1, 2, 3, 4])
+        result = os.pop()
+        assert result == 4
+        assert list(os) == [1, 2, 3]
+
+    def test_pop_first(self):
+        os = OrderedSet([1, 2, 3, 4])
+        result = os.pop(last=False)
+        assert result == 1
+        assert list(os) == [2, 3, 4]
+
+    def test_pop_empty_set(self):
+        os = OrderedSet()
+        with pytest.raises(KeyError, match="set is empty"):
+            os.pop()
+
+    def test_iteration(self):
+        os = OrderedSet([1, 2, 3])
+        result = []
+        for item in os:
+            result.append(item)
+        assert result == [1, 2, 3]
+
+    def test_reversed_iteration(self):
+        os = OrderedSet([1, 2, 3])
+        result = list(reversed(os))
+        assert result == [3, 2, 1]
+
+    def test_len(self):
+        os = OrderedSet()
+        assert len(os) == 0
+
+        os.add(1)
+        assert len(os) == 1
+
+        os.add(2)
+        assert len(os) == 2
+
+        os.add(1)  # Duplicate
+        assert len(os) == 2
+
+    def test_bool(self):
+        os = OrderedSet()
+        assert bool(os) is False
+
+        os.add(1)
+        assert bool(os) is True
+
+    def test_repr_empty(self):
+        os = OrderedSet()
+        assert repr(os) == "OrderedSet()"
+
+    def test_repr_with_elements(self):
+        os = OrderedSet([1, 2, 3])
+        assert repr(os) == "OrderedSet([1, 2, 3])"
+
+    def test_eq_with_ordered_set(self):
+        os1 = OrderedSet([1, 2, 3])
+        os2 = OrderedSet([1, 2, 3])
+        os3 = OrderedSet([3, 2, 1])
+        os4 = OrderedSet([1, 2])
+
+        assert os1 == os2
+        assert os1 != os3
+        assert os1 != os4
+
+    def test_eq_with_regular_set(self):
+        os = OrderedSet([1, 2, 3])
+        s = {1, 2, 3}
+        s_different = {1, 2}
+
+        assert os == s
+        assert os != s_different
+
+    def test_eq_with_list(self):
+        os = OrderedSet([1, 2, 3])
+        lst = [1, 2, 3]
+
+        assert os == lst
+
+    def test_eq_with_non_iterable(self):
+        os = OrderedSet([1, 2, 3])
+        assert os != 42
+        assert os != "hello"
+
+    def test_order_preservation(self):
+        os = OrderedSet()
+        items = [5, 1, 3, 2, 4]
+        for item in items:
+            os.add(item)
+        assert list(os) == items
+
+    def test_order_preservation_with_duplicates(self):
+        os = OrderedSet()
+        os.add(1)
+        os.add(2)
+        os.add(3)
+        os.add(2)
+        assert list(os) == [1, 2, 3]
+
+    def test_complex_operations(self):
+        os = OrderedSet([1, 2, 3, 4, 5])
+
+        os.discard(3)
+        os.discard(5)
+        assert list(os) == [1, 2, 4]
+
+        os.add(6)
+        os.add(0)
+        assert list(os) == [1, 2, 4, 6, 0]
+
+        os.update([7, 2, 8])
+        assert list(os) == [1, 2, 4, 6, 0, 7, 8]
+
+        last = os.pop()
+        first = os.pop(last=False)
+        assert last == 8
+        assert first == 1
+        assert list(os) == [2, 4, 6, 0, 7]
+
+    def test_empty_set_operations(self):
+        os = OrderedSet()
+
+        assert list(os) == []
+        assert list(reversed(os)) == []
+
+        os.update([])
+        assert len(os) == 0
+
+    def test_single_element_operations(self):
+        os = OrderedSet([42])
+
+        assert len(os) == 1
+        assert 42 in os
+        assert list(os) == [42]
+        assert list(reversed(os)) == [42]
+
+        result = os.pop()
+        assert result == 42
+        assert len(os) == 0
+
+    def test_unhashable_types_not_supported(self):
+        os = OrderedSet()
+        with pytest.raises(TypeError):
+            os.add([1, 2, 3])
+
+        with pytest.raises(TypeError):
+            os.add({1: 2})
+
+    def test_index_access_basic(self):
+        os = OrderedSet([1, 2, 3, 4, 5])
+
+        assert os[0] == 1
+        assert os[1] == 2
+        assert os[2] == 3
+        assert os[3] == 4
+        assert os[4] == 5
+
+        assert os[-1] == 5
+        assert os[-2] == 4
+        assert os[-3] == 3
+        assert os[-4] == 2
+        assert os[-5] == 1
+
+    def test_index_access_out_of_bounds(self):
+        os = OrderedSet([1, 2, 3])
+
+        with pytest.raises(IndexError):
+            os[3]
+        with pytest.raises(IndexError):
+            os[10]
+
+        with pytest.raises(IndexError):
+            os[-4]
+        with pytest.raises(IndexError):
+            os[-10]
+
+    def test_index_access_empty_set(self):
+        os = OrderedSet()
+
+        with pytest.raises(IndexError):
+            os[0]
+        with pytest.raises(IndexError):
+            os[-1]
+
+    def test_index_access_single_element(self):
+        os = OrderedSet([42])
+
+        assert os[0] == 42
+        assert os[-1] == 42
+
+        with pytest.raises(IndexError):
+            os[1]
+        with pytest.raises(IndexError):
+            os[-2]
+
+    def test_index_access_after_modifications(self):
+        os = OrderedSet([1, 2, 3, 4])
+
+        os.discard(2)
+        assert os[0] == 1
+        assert os[1] == 3
+        assert os[2] == 4
+
+        os.add(5)
+        assert os[3] == 5
+
+        os.pop()
+        assert len(os) == 3
+        with pytest.raises(IndexError):
+            os[3]