tests.pocketutils.core.test_dot_dict

Complexity

Total Complexity

28

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	TestDotDict.test_req()	0	12	2
A	TestDotDict.test_iter()	0	5	1
A	TestDotDict.test_keys()	0	3	1
B	TestDotDict.test_get_as()	0	32	6
A	TestDotDict.test_string()	0	8	1
A	TestDotDict.test_get_list_as()	0	8	2
A	TestDotDict.test_leaves()	0	3	1
A	TestDotDict.test_get()	0	26	4
A	TestDotDict.test_nested()	0	6	1
A	TestDotDict.test_bad()	0	10	5
A	TestDotDict.test_bytes()	0	5	1
A	TestDotDict.test_as_exactly()	0	6	2
A	TestDotDict.test_size()	0	5	1

from datetime import date, datetime, timezone

Missing module docstring

import pytest

Unable to import 'pytest'

from pocketutils.core.dot_dict import *

The usage of wildcard imports like pocketutils.core.dot_dict should generally be avoided.

pickle was imported with wildcard, but is not used.

orjson was imported with wildcard, but is not used.

PICKLE_PROTOCOL was imported with wildcard, but is not used.

T was imported with wildcard, but is not used.

copy was imported with wildcard, but is not used.

Path was imported with wildcard, but is not used.

PurePath was imported with wildcard, but is not used.

Any was imported with wildcard, but is not used.

ByteString was imported with wildcard, but is not used.

Callable was imported with wildcard, but is not used.

Mapping was imported with wildcard, but is not used.

Optional was imported with wildcard, but is not used.

Sequence was imported with wildcard, but is not used.

Tup was imported with wildcard, but is not used.

Type was imported with wildcard, but is not used.

TypeVar was imported with wildcard, but is not used.

Union was imported with wildcard, but is not used.

toml was imported with wildcard, but is not used.

The name core does not seem to exist in module pocketutils.

read_txt_or_gz was imported with wildcard, but is not used.

write_txt_or_gz was imported with wildcard, but is not used.

XKeyError was imported with wildcard, but is not used.

XTypeError was imported with wildcard, but is not used.

XValueError was imported with wildcard, but is not used.

PathLike was imported with wildcard, but is not used.

Iterable was imported with wildcard, but is not used.

sys was imported with wildcard, but is not used.

Collection was imported with wildcard, but is not used.

class TestDotDict:

Missing class docstring

    def test_keys(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict({"a": "0", "b": 1, "c": {"c1": 8, "c2": ["abc", "xyz"]}})

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert list(t.keys()) == ["a", "b", "c"]

    def test_bad(self):

Missing function or method docstring

This method could be written as a function/class method.

        with pytest.raises(ValueError):
            NestedDotDict({"a.b": "c"})
        with pytest.raises(ValueError):
            NestedDotDict({"a": {"b.c": "d"}})
        with pytest.raises(ValueError):
            # noinspection PyTypeChecker
            NestedDotDict({1: 2})
        with pytest.raises(ValueError):
            NestedDotDict({"a.b": {5: 2}})

    def test_iter(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=555)))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert len(t) == 1
        assert list(iter(t)) == ["a"]
        assert t.items() == [("a", {"b": 555})]

    def test_get(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=dict(c="hello"))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.get("a") == dict(b=dict(c="hello"))
        assert t.get("a.b") == dict(c="hello")
        assert t.get("a.b.c") == "hello"
        assert t["a"] == dict(b=dict(c="hello"))
        assert t["a.b"] == dict(c="hello")
        assert t["a.b.c"] == "hello"
        assert t.get("b") is None
        assert t.get("a.x") is None
        assert t.get("a.b.x") is None
        assert t.get("a.b.c.x") is None
        assert t.get("b", default="Q") == "Q"
        with pytest.raises(LookupError):
            # noinspection PyStatementEffect
            t["b"]

This statement seems to have no effect and could be removed.

        with pytest.raises(LookupError):
            # noinspection PyStatementEffect
            t["a.x"]

This statement seems to have no effect and could be removed.

        with pytest.raises(LookupError):
            # noinspection PyStatementEffect
            t["a.b.c.x"]

This statement seems to have no effect and could be removed.

        t = NestedDotDict({"a": {"1": "hello", "2": "ell", "3": "elle"}})

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t["a.1"] == "hello"
        assert t["a.2"] == "ell"
        assert t["a.3"] == "elle"

    def test_get_as(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            {
                "animal": "kitten",
                "size": 4.3,
                "number": 8,
                "birthday": "2020-01-17",
                "birthdayzulu": "2020-01-17Z",
                "birthdatetime": "2020-01-17T15:22:11",
                "birthdatetimezulu": "2020-01-17T15:22:11Z",
            }
        )
        assert t.get_as("animal", str) == "kitten"
        assert t.get_as("size", float) == 4.3
        assert t.get_as("size", str) == "4.3"
        assert t.get_as("number", int) == 8
        assert t.get_as("birthday", date) == date(2020, 1, 17)
        assert t.get_as("birthdatetime", datetime) == datetime(2020, 1, 17, 15, 22, 11)
        assert t.get_as("birthdatetimezulu", datetime) == datetime(
            2020, 1, 17, 15, 22, 11, tzinfo=timezone.utc
        )
        # parsing a date string as datetime is dangerous because it fills in 00:00:00
        with pytest.raises(ValueError):
            assert t.get_as("birthdayzulu", datetime)
        with pytest.raises(ValueError):
            assert t.get_as("birthday", datetime)
        with pytest.raises(ValueError):
            assert t.get_as("birthdayzulu", date)
        with pytest.raises(ValueError):
            t.get_as("birthdatetime", date)
        with pytest.raises(ValueError):
            t.get_as("animal", int)

    def test_get_list_as(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict({"kittens": ["dory", "johnson", "robin", "jack"], "ages": [3, 5, 7, 11]})

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.get_list_as("kittens", str) == ["dory", "johnson", "robin", "jack"]
        assert t.get_list_as("ages", int) == [3, 5, 7, 11]
        assert t.get_list_as("ages", str) == ["3", "5", "7", "11"]
        assert t.get_list_as("hobbies", str) is None
        with pytest.raises(ValueError):
            t.get_list_as("kittens", float)

    def test_req(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            {
                "kittens": ["dory", "johnson", "robin", "jack"],
                "ages": [3, 5, 7, 11],
                "carrots": "yes",
            }
        )
        assert t.req_as("carrots", str) == "yes"
        assert t.req_list_as("ages", int) == [3, 5, 7, 11]
        with pytest.raises(LookupError):
            t.req_list_as("hobbies", str)

    def test_nested(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            {"kittens": {"names": ["dory", "johnson", "robin", "jack"], "ages": [3, 5, 7, 11]}}
        )
        assert isinstance(t.get("kittens"), NestedDotDict)
        assert t.get_list_as("kittens.ages", int) == [3, 5, 7, 11]

    def test_leaves(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=1), b=2, c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.leaves() == {"a.b": 1, "b": 2, "c.a.a": 3}

    def test_string(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=1), b=2, c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert str(t) == str(t._x)

It seems like _x was declared protected and should not be accessed from this context.

        lines = t.pretty_str().splitlines()
        assert len(lines) == 5
        assert lines[0] == "{"
        assert lines[-1] == "}"
        assert lines[1] == '  "a.b": 1,'

    def test_size(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=1), b=2, c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.n_elements_total() == 3
        t = NestedDotDict(dict(a=dict(b=1), b=[1, 2, 3], c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.n_elements_total() == 5

    def test_bytes(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict(dict(a=dict(b=1), b=2, c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.n_bytes_total() == 84
        t = NestedDotDict(dict(a=dict(b=1), b=[1, 2, 3], c=dict(a=dict(a=3))))

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.n_bytes_total() == 140

    def test_as_exactly(self):

Missing function or method docstring

This method could be written as a function/class method.

        t = NestedDotDict({"zoo": {"animals": "jackets"}, "what": 0.1})

Variable name "t" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        assert t.exactly("zoo.animals", str) == "jackets"
        assert t.exactly("what", float) == 0.1
        with pytest.raises(TypeError):
            t.exactly("what", str)


if __name__ == "__main__":
    pytest.main()