typedload/setup.py 0000755 0001750 0001750 00000004116 13557752054 013631 0 ustar salvo salvo #!/usr/bin/python3
# typedload
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from distutils.core import setup
setup(
name='typedload',
version='1.20',
description='Load and dump data from json-like format into typed data structures',
long_description='''Load and dump json-like data into typed data structures.
This module provides an API to load dictionaries and lists (usually loaded
from json) into Python's NamedTuples, dataclass, sets, enums, and various
other typed data structures; respecting all the type-hints and performing
type checks or casts when needed.
It can also dump from typed data structures to json-like dictionaries and lists.
It is very useful for projects that use Mypy and deal with untyped data
like json, because it guarantees that the data will have the expected format.
''',
url='https://github.com/ltworf/typedload',
author='Salvo \'LtWorf\' Tomaselli',
author_email='tiposchi@tiscali.it',
license='GPLv3',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
],
keywords='typing types mypy json',
packages=['typedload', 'typedload.plugins'],
package_data={"typedload": ["py.typed"]},
)
typedload/Makefile 0000644 0001750 0001750 00000003205 13557262143 013545 0 ustar salvo salvo all: pypi
.PHONY: test
test:
python3 -m tests
.PHONY: mypy
mypy:
mypy --config-file mypy.conf typedload
pypi: setup.py typedload
mkdir -p dist pypi
./setup.py sdist
mv dist/typedload-`./setup.py --version`.tar.gz pypi
rmdir dist
gpg --detach-sign -a pypi/typedload-`./setup.py --version`.tar.gz
clean:
$(RM) -r pypi
$(RM) -r docs
$(RM) -r .mypy_cache
$(RM) MANIFEST
$(RM) -r `find . -name __pycache__`
$(RM) typedload_`./setup.py --version`.orig.tar.gz
$(RM) typedload_`./setup.py --version`.orig.tar.gz.asc
$(RM) -r deb-pkg
.PHONY: dist
dist: clean
cd ..; tar -czvvf typedload.tar.gz \
typedload/setup.py \
typedload/Makefile \
typedload/tests \
typedload/LICENSE \
typedload/CONTRIBUTING.md \
typedload/CHANGELOG \
typedload/README.md \
typedload/example.py \
typedload/mypy.conf \
typedload/typedload
mv ../typedload.tar.gz typedload_`./setup.py --version`.orig.tar.gz
gpg --detach-sign -a *.orig.tar.gz
.PHONY: upload
upload: pypi
twine upload pypi/typedload-`./setup.py --version`.tar.gz
deb-pkg: dist
mv typedload_`./setup.py --version`.orig.tar.gz* /tmp
cd /tmp; tar -xf typedload_*.orig.tar.gz
cp -r debian /tmp/typedload/
cd /tmp/typedload/; dpkg-buildpackage --changes-option=-S
mkdir deb-pkg
mv /tmp/typedload_* /tmp/python3-typedload_*.deb deb-pkg
$(RM) -r /tmp/typedload
docs:
install -d docs
pydoc3 -w typedload
pydoc3 -w typedload.datadumper
pydoc3 -w typedload.dataloader
pydoc3 -w typedload.exceptions
pydoc3 -w typedload.typechecks
pydoc3 -w typedload.plugins
pydoc3 -w typedload.plugins.attrload
pydoc3 -w typedload.plugins.attrdump
mv *.html docs
ln -s typedload.html docs/index.html
typedload/tests/ 0000755 0001750 0001750 00000000000 13610100343 013226 5 ustar salvo salvo typedload/tests/test_datadumper.py 0000644 0001750 0001750 00000010450 13444742153 017005 0 ustar salvo salvo # typedload
# Copyright (C) 2018 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
import datetime
from enum import Enum
from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
from typedload import datadumper, dump, load
class EnumA(Enum):
A: int = 1
B: str = '2'
C: Tuple[int, int] = (1, 2)
class NamedA(NamedTuple):
a: int
b: str
c: str = 'no'
class TestDumpLoad(unittest.TestCase):
def test_enum(self):
assert load(dump(EnumA.C), EnumA) == EnumA.C
class TestLegacyDump(unittest.TestCase):
def test_dump(self):
A = NamedTuple('A',[('a', int), ('b', str)])
assert dump(A(1, '12')) == {'a': 1, 'b': '12'}
class TestBasicDump(unittest.TestCase):
def test_dump_namedtuple(self):
dumper = datadumper.Dumper()
assert dumper.dump(NamedA(1, 'a')) == {'a': 1, 'b': 'a'}
assert dumper.dump(NamedA(1, 'a', 'yes')) == {'a': 1, 'b': 'a', 'c': 'yes'}
dumper.hidedefault = False
assert dumper.dump(NamedA(1, 'a')) == {'a': 1, 'b': 'a', 'c': 'no'}
def test_dump_dict(self):
dumper = datadumper.Dumper()
assert dumper.dump({EnumA.B: 'ciao'}) == {'2': 'ciao'}
def test_dump_set(self):
dumper = datadumper.Dumper()
assert dumper.dump(set(range(3))) == [0, 1, 2]
assert dumper.dump(frozenset(range(3))) == [0, 1, 2]
def test_dump_enums(self):
dumper = datadumper.Dumper()
assert dumper.dump(EnumA.A) == 1
assert dumper.dump(EnumA.B) == '2'
assert dumper.dump(EnumA.C) == [1, 2]
def test_dump_iterables(self):
dumper = datadumper.Dumper()
assert dumper.dump([1]) == [1]
assert dumper.dump((1, 2)) == [1, 2]
assert dumper.dump([(1, 1), (0, 0)]) == [[1, 1], [0, 0]]
assert dumper.dump({1, 2}) == [1, 2]
def test_basic_types(self):
# Casting enabled, by default
dumper = datadumper.Dumper()
assert dumper.dump(1) == 1
assert dumper.dump('1') == '1'
assert dumper.dump(None) == None
dumper.basictypes = {int, str}
assert dumper.dump('1') == '1'
assert dumper.dump(1) == 1
with self.assertRaises(ValueError):
assert dumper.dump(None) == None
assert dumper.dump(True) == True
def test_datetime(self):
dumper = datadumper.Dumper()
assert dumper.dump(datetime.date(2011, 12, 12)) == [2011, 12, 12]
assert dumper.dump(datetime.time(15, 41)) == [15, 41, 0, 0]
assert dumper.dump(datetime.datetime(2019, 5, 31, 12, 44, 22)) == [2019, 5, 31, 12, 44, 22, 0]
class TestHandlersDumper(unittest.TestCase):
def test_custom_handler(self):
class Q:
def __eq__(self, other):
return isinstance(other, Q)
dumper = datadumper.Dumper()
dumper.handlers.append((
lambda v: isinstance(v, Q),
lambda l, v: 12
))
assert dumper.dump(Q()) == 12
def test_broken_handler(self):
dumper = datadumper.Dumper()
dumper.handlers.insert(0, (lambda v: 'a' + v is None, lambda l, v: None))
with self.assertRaises(TypeError):
dumper.dump(1)
dumper.raiseconditionerrors = False
assert dumper.dump(1) == 1
def test_replace_handler(self):
dumper = datadumper.Dumper()
index = dumper.index([])
assert dumper.dump([11]) == [11]
dumper.handlers[index] = (dumper.handlers[index][0], lambda *args: 3)
assert dumper.dump([11]) == 3
class TestDumper(unittest.TestCase):
def test_kwargs(self):
with self.assertRaises(ValueError):
dump(1, handlers=[])
typedload/tests/__main__.py 0000644 0001750 0001750 00000003036 13566742617 015354 0 ustar salvo salvo # typedload
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
import unittest
import sys
print('Running tests using %s' % sys.version)
if sys.version_info.major != 3 or sys.version_info.minor < 5:
raise Exception('Only version 3.5 and above supported')
if sys.version_info.minor > 5:
from .test_dataloader import *
from .test_datadumper import *
from .test_dumpload import *
if sys.version_info.minor >= 7:
from .test_dataclass import *
if sys.version_info.minor >= 8:
from .test_literal import *
from .test_typeddict import *
from .test_legacytuples_dataloader import *
from .test_typechecks import *
# Run tests for the attr plugin only if it is loaded
try:
import attr
attr_module = True
except ImportError:
attr_module = False
if attr_module:
from .test_attrload import *
if __name__ == '__main__':
unittest.main()
typedload/tests/test_literal.py 0000644 0001750 0001750 00000002670 13557620705 016323 0 ustar salvo salvo # typedload
# Copyright (C) 2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from typing import Literal
import unittest
from typedload import dataloader, load, dump, typechecks
class TestLiteralLoad(unittest.TestCase):
def test_literalvalues(self):
assert isinstance(typechecks.literalvalues(Literal[1]), set)
assert typechecks.literalvalues(Literal[1]) == {1}
assert typechecks.literalvalues(Literal[1, 1]) == {1}
assert typechecks.literalvalues(Literal[1, 2]) == {1, 2}
def test_load(self):
l = Literal[1, 2, 'a']
assert load(1, l) == 1
assert load(2, l) == 2
assert load('a', l) == 'a'
def test_fail(self):
l = Literal[1, 2, 'a']
with self.assertRaises(ValueError):
load(3, l)
typedload/tests/test_dataloader.py 0000644 0001750 0001750 00000027776 13610023273 016770 0 ustar salvo salvo # typedload
# Copyright (C) 2018-2020 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
import argparse
import datetime
from enum import Enum
from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
from typedload import dataloader, load, exceptions
class TestRealCase(unittest.TestCase):
def test_stopboard(self):
class VehicleType(Enum):
ST = 'ST'
TRAM = 'TRAM'
BUS = 'BUS'
WALK = 'WALK'
BOAT = 'BOAT'
class BoardItem(NamedTuple):
name: str
type: VehicleType
date: str
time: str
stop: str
stopid: str
journeyid: str
sname: Optional[str] = None
track: str = ''
rtDate: Optional[str] = None
rtTime: Optional[str] = None
direction: Optional[str] = None
accessibility: str = ''
bgColor: str = '#0000ff'
fgColor: str = '#ffffff'
stroke: Optional[str] = None
night: bool = False
c = {
'JourneyDetailRef': {'ref': 'https://api.vasttrafik.se/bin/rest.exe/v2/journeyDetail?ref=859464%2F301885%2F523070%2F24954%2F80%3Fdate%3D2018-04-08%26station_evaId%3D5862002%26station_type%3Ddep%26format%3Djson%26'},
'accessibility': 'wheelChair',
'bgColor': '#00394d',
'date': '2018-04-08',
'direction': 'Kortedala',
'fgColor': '#fa8719',
'journeyid': '9015014500604285',
'name': 'Spårvagn 6',
'rtDate': '2018-04-08',
'rtTime': '12:27',
'sname': '6',
'stop': 'SKF, Göteborg',
'stopid': '9022014005862002',
'stroke': 'Solid',
'time': '12:17',
'track': 'B',
'type': 'TRAM'
}
loader = dataloader.Loader()
loader.load(c, BoardItem)
class TestUnion(unittest.TestCase):
def test_json(self):
'''
This test would normally be flaky, but with the scoring of
types in union, it should always work.
'''
Json = Union[int, float, str, bool, None, List['Json'], Dict[str, 'Json']]
data = [{},[]]
loader = dataloader.Loader()
loader.basiccast = False
loader.frefs = {'Json' : Json}
assert loader.load(data, Json) == data
def test_ComplicatedUnion(self):
class A(NamedTuple):
a: int
class B(NamedTuple):
a: str
class C(NamedTuple):
val: Union[A, B]
loader = dataloader.Loader()
loader.basiccast = False
assert type(loader.load({'val': {'a': 1}}, C).val) == A
assert type(loader.load({'val': {'a': '1'}}, C).val) == B
def test_optional(self):
loader = dataloader.Loader()
assert loader.load(1, Optional[int]) == 1
assert loader.load(None, Optional[int]) == None
assert loader.load('1', Optional[int]) == 1
with self.assertRaises(ValueError):
loader.load('ciao', Optional[int])
loader.basiccast = False
loader.load('1', Optional[int])
def test_union(self):
loader = dataloader.Loader()
loader.basiccast = False
assert loader.load(1, Optional[Union[int, str]]) == 1
assert loader.load('a', Optional[Union[int, str]]) == 'a'
assert loader.load(None, Optional[Union[int, str]]) == None
assert type(loader.load(1, Optional[Union[int, float]])) == int
assert type(loader.load(1.0, Optional[Union[int, float]])) == float
with self.assertRaises(ValueError):
loader.load('', Optional[Union[int, float]])
loader.basiccast = True
assert type(loader.load(1, Optional[Union[int, float]])) == int
assert type(loader.load(1.0, Optional[Union[int, float]])) == float
assert loader.load(None, Optional[str]) is None
class TestTupleLoad(unittest.TestCase):
def test_ellipsis(self):
loader = dataloader.Loader()
l = list(range(33))
t = tuple(l)
assert loader.load(l, Tuple[int, ...]) == t
assert loader.load('abc', Tuple[str, ...]) == ('a', 'b', 'c')
assert loader.load('a', Tuple[str, ...]) == ('a', )
def test_tuple(self):
loader = dataloader.Loader()
with self.assertRaises(ValueError):
assert loader.load([1], Tuple[int, int]) == (1, 2)
assert loader.load([1, 2, 3], Tuple[int, int]) == (1, 2)
loader.failonextra = True
# Now the same will fail
with self.assertRaises(ValueError):
loader.load([1, 2, 3], Tuple[int, int]) == (1, 2)
class TestNamedTuple(unittest.TestCase):
def test_simple(self):
class A(NamedTuple):
a: int
b: str
loader = dataloader.Loader()
r = A(1,'1')
assert loader.load({'a': 1, 'b': 1}, A) == r
assert loader.load({'a': 1, 'b': 1, 'c': 3}, A) == r
loader.failonextra = True
with self.assertRaises(ValueError):
loader.load({'a': 1, 'b': 1, 'c': 3}, A)
def test_simple_defaults(self):
class A(NamedTuple):
a: int = 1
b: str = '1'
loader = dataloader.Loader()
r = A(1,'1')
assert loader.load({}, A) == r
def test_nested(self):
class A(NamedTuple):
a: int
class B(NamedTuple):
a: A
loader = dataloader.Loader()
r = B(A(1))
assert loader.load({'a': {'a': 1}}, B) == r
with self.assertRaises(TypeError):
loader.load({'a': {'a': 1}}, A)
def test_fail(self):
class A(NamedTuple):
a: int
q: str
loader = dataloader.Loader()
with self.assertRaises(ValueError):
loader.load({'a': 3}, A)
class TestEnum(unittest.TestCase):
def test_load_difficult_enum(self):
class TestEnum(Enum):
A: int = 1
B: Tuple[int,int,int] = (1, 2, 3)
loader = dataloader.Loader()
assert loader.load(1, TestEnum) == TestEnum.A
assert loader.load((1, 2, 3), TestEnum) == TestEnum.B
assert loader.load([1, 2, 3], TestEnum) == TestEnum.B
assert loader.load([1, 2, 3, 4], TestEnum) == TestEnum.B
loader.failonextra = True
with self.assertRaises(ValueError):
loader.load([1, 2, 3, 4], TestEnum)
def test_load_enum(self):
loader = dataloader.Loader()
class TestEnum(Enum):
LABEL1 = 1
LABEL2 = '2'
assert loader.load(1, TestEnum) == TestEnum.LABEL1
assert loader.load('2', TestEnum) == TestEnum.LABEL2
with self.assertRaises(ValueError):
loader.load(2, TestEnum)
assert loader.load(['2', 1], Tuple[TestEnum, TestEnum]) == (TestEnum.LABEL2, TestEnum.LABEL1)
class TestForwardRef(unittest.TestCase):
def test_known_refs(self):
class Node(NamedTuple):
value: int = 1
next: Optional['Node'] = None
l = {'next': {}, 'value': 12}
loader = dataloader.Loader()
assert loader.load(l, Node) == Node(value=12,next=Node())
def test_disable(self):
class A(NamedTuple):
i: 'int'
loader = dataloader.Loader(frefs=None)
with self.assertRaises(Exception):
loader.load(3, A)
def test_add_fref(self):
class A(NamedTuple):
i: 'alfio'
loader = dataloader.Loader()
with self.assertRaises(ValueError):
loader.load({'i': 3}, A)
loader.frefs['alfio'] = int
assert loader.load({'i': 3}, A) == A(3)
class TestLoaderIndex(unittest.TestCase):
def test_removal(self):
loader = dataloader.Loader()
assert loader.load(3, int) == 3
loader.handlers.pop(loader.index(int))
with self.assertRaises(TypeError):
loader.load(3, int)
class TestExceptions(unittest.TestCase):
def test_list_exception(self):
loader = dataloader.Loader()
with self.assertRaises(exceptions.TypedloadTypeError):
loader.load(None, List[int])
def test_dict_exception(self):
loader = dataloader.Loader()
with self.assertRaises(exceptions.TypedloadAttributeError):
loader.load(None, Dict[int, int])
def test_index(self):
loader = dataloader.Loader()
try:
loader.load([1, 2, 3, 'q'], List[int])
except Exception as e:
assert e.trace[-1].annotation[1] == 3
try:
loader.load(['q', 2], Tuple[int,int])
except Exception as e:
assert e.trace[-1].annotation[1] == 0
try:
loader.load({'q': 1}, Dict[int,int])
except Exception as e:
assert e.trace[-1].annotation[1] == 'q'
def test_attrname(self):
class A(NamedTuple):
a: int
class B(NamedTuple):
a: A
b: int
loader = dataloader.Loader()
try:
loader.load({'a': 'q'}, A)
except Exception as e:
assert e.trace[-1].annotation[1] == 'a'
try:
loader.load({'a':'q','b': {'a': 1}}, B)
except Exception as e:
assert e.trace[-1].annotation[1] == 'a'
try:
loader.load({'a':3,'b': {'a': 'q'}}, B)
except Exception as e:
assert e.trace[-1].annotation[1] == 'a'
def test_typevalue(self):
loader = dataloader.Loader()
try:
loader.load([1, 2, 3, 'q'], List[int])
except Exception as e:
assert e.value == 'q'
assert e.type_ == int
class TestDatetime(unittest.TestCase):
def test_date(self):
loader = dataloader.Loader()
assert loader.load((2011, 1, 1), datetime.date) == datetime.date(2011, 1, 1)
assert loader.load((15, 33), datetime.time) == datetime.time(15, 33)
assert loader.load((15, 33, 0), datetime.time) == datetime.time(15, 33)
assert loader.load((2011, 1, 1), datetime.datetime) == datetime.datetime(2011, 1, 1)
assert loader.load((2011, 1, 1, 22), datetime.datetime) == datetime.datetime(2011, 1, 1, 22)
# Same but with lists
assert loader.load([2011, 1, 1], datetime.date) == datetime.date(2011, 1, 1)
assert loader.load([15, 33], datetime.time) == datetime.time(15, 33)
assert loader.load([15, 33, 0], datetime.time) == datetime.time(15, 33)
assert loader.load([2011, 1, 1], datetime.datetime) == datetime.datetime(2011, 1, 1)
assert loader.load([2011, 1, 1, 22], datetime.datetime) == datetime.datetime(2011, 1, 1, 22)
def test_exception(self):
loader = dataloader.Loader()
with self.assertRaises(TypeError):
loader.load((2011, ), datetime.datetime)
loader.load(33, datetime.datetime)
class TestDictEquivalence(unittest.TestCase):
def test_namespace(self):
loader = dataloader.Loader()
data = argparse.Namespace(a=12, b='33')
class A(NamedTuple):
a: int
b: int
c: int = 1
assert loader.load(data, A) == A(12, 33, 1)
assert loader.load(data, Dict[str, int]) == {'a': 12, 'b': 33}
def test_nonamespace(self):
loader = dataloader.Loader(dictequivalence=False)
data = argparse.Namespace(a=1)
with self.assertRaises(AttributeError):
loader.load(data, Dict[str, int])
typedload/tests/test_typechecks.py 0000644 0001750 0001750 00000011037 13566742617 017035 0 ustar salvo salvo # typedload
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Dict, FrozenSet, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
import sys
if sys.version_info.minor >= 8 :
from typing import Literal
from typedload import typechecks
class TestChecks(unittest.TestCase):
def test_is_literal(self):
if sys.version_info.minor >= 8 :
l = Literal[1, 2, 3]
assert typechecks.is_literal(l)
assert not typechecks.is_literal(3)
assert not typechecks.is_literal(int)
assert not typechecks.is_literal(str)
assert not typechecks.is_literal(None)
assert not typechecks.is_literal(List[int])
def test_is_not_typeddict(self):
assert not typechecks.is_typeddict(int)
assert not typechecks.is_typeddict(3)
assert not typechecks.is_typeddict(str)
assert not typechecks.is_typeddict({})
assert not typechecks.is_typeddict(dict)
assert not typechecks.is_typeddict(set)
assert not typechecks.is_typeddict(None)
assert not typechecks.is_typeddict(List[str])
def test_is_list(self):
assert typechecks.is_list(List)
assert typechecks.is_list(List[int])
assert typechecks.is_list(List[str])
assert not typechecks.is_list(list)
assert not typechecks.is_list(Tuple[int, str])
assert not typechecks.is_list(Dict[int, str])
assert not typechecks.is_list([])
def test_is_dict(self):
assert typechecks.is_dict(Dict[int, int])
assert typechecks.is_dict(Dict)
assert typechecks.is_dict(Dict[str, str])
assert not typechecks.is_dict(Tuple[str, str])
assert not typechecks.is_dict(Set[str])
def test_is_set(self):
assert typechecks.is_set(Set[int])
assert typechecks.is_set(Set)
def test_is_frozenset_(self):
assert not typechecks.is_frozenset(Set[int])
assert typechecks.is_frozenset(FrozenSet[int])
assert typechecks.is_frozenset(FrozenSet)
def test_is_tuple(self):
assert typechecks.is_tuple(Tuple[str, int, int])
assert typechecks.is_tuple(Tuple)
assert not typechecks.is_tuple(tuple)
assert not typechecks.is_tuple((1,2))
def test_is_union(self):
assert typechecks.is_union(Optional[int])
assert typechecks.is_union(Optional[str])
assert typechecks.is_union(Union[bytes, str])
assert typechecks.is_union(Union[str, int, float])
def test_is_nonetype(self):
assert typechecks.is_nonetype(type(None))
assert not typechecks.is_nonetype(List[int])
def test_is_enum(self):
class A(Enum):
BB = 3
assert typechecks.is_enum(A)
assert not typechecks.is_enum(Set[int])
def test_is_namedtuple(self):
A = NamedTuple('A', [
('val', int),
])
assert typechecks.is_namedtuple(A)
assert not typechecks.is_namedtuple(Tuple)
assert not typechecks.is_namedtuple(tuple)
assert not typechecks.is_namedtuple(Tuple[int, int])
def test_is_forwardref(self):
try:
# Since 3.7
from typing import ForwardRef # type: ignore
except ImportError:
from typing import _ForwardRef as ForwardRef # type: ignore
assert typechecks.is_forwardref(ForwardRef('SomeType'))
def test_uniontypes(self):
assert typechecks.uniontypes(Optional[bool]) == {typechecks.NONETYPE, bool}
assert typechecks.uniontypes(Optional[int]) == {typechecks.NONETYPE, int}
assert typechecks.uniontypes(Optional[Union[int, float]]) == {typechecks.NONETYPE, float, int}
assert typechecks.uniontypes(Optional[Union[int, str, Optional[float]]]) == {typechecks.NONETYPE, str, int, float}
with self.assertRaises(ValueError):
typechecks.uniontypes(Union[int])
typedload/tests/test_legacytuples_dataloader.py 0000644 0001750 0001750 00000021014 13441563303 021531 0 ustar salvo salvo # typedload
# Copyright (C) 2018 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Dict, FrozenSet, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
from typedload import dataloader, load
class TestLegacy_oldsyntax(unittest.TestCase):
def test_legacyload(self):
A = NamedTuple('A', [('a', int), ('b', str)])
assert load({'a': 101, 'b': 'ciao'}, A) == A(101, 'ciao')
def test_nestedlegacyload(self):
A = NamedTuple('A', [('a', int), ('b', str)])
B = NamedTuple('B', [('a', A), ('b', List[A])])
assert load({'a': {'a': 101, 'b': 'ciao'}, 'b': []}, B) == B(A(101, 'ciao'), [])
assert load(
{'a': {'a': 101, 'b': 'ciao'}, 'b': [{'a': 1, 'b': 'a'},{'a': 0, 'b': 'b'}]},
B
) == B(A(101, 'ciao'), [A(1, 'a'),A(0, 'b')])
class TestUnion_oldsyntax(unittest.TestCase):
def test_ComplicatedUnion(self):
A = NamedTuple('A', [('a', int)])
B = NamedTuple('B', [('a', str)])
C = NamedTuple('C', [('val', Union[A, B])])
loader = dataloader.Loader()
loader.basiccast = False
assert type(loader.load({'val': {'a': 1}}, C).val) == A
assert type(loader.load({'val': {'a': '1'}}, C).val) == B
def test_optional(self):
loader = dataloader.Loader()
assert loader.load(1, Optional[int]) == 1
assert loader.load(None, Optional[int]) == None
assert loader.load('1', Optional[int]) == 1
with self.assertRaises(ValueError):
loader.load('ciao', Optional[int])
loader.basiccast = False
loader.load('1', Optional[int])
def test_union(self):
loader = dataloader.Loader()
loader.basiccast = False
assert loader.load(1, Optional[Union[int, str]]) == 1
assert loader.load('a', Optional[Union[int, str]]) == 'a'
assert loader.load(None, Optional[Union[int, str]]) == None
assert type(loader.load(1, Optional[Union[int, float]])) == int
assert type(loader.load(1.0, Optional[Union[int, float]])) == float
with self.assertRaises(ValueError):
loader.load('', Optional[Union[int, float]])
loader.basiccast = True
assert type(loader.load(1, Optional[Union[int, float]])) == int
assert type(loader.load(1.0, Optional[Union[int, float]])) == float
assert loader.load(None, Optional[str]) is None
class TestNamedTuple_oldsyntax(unittest.TestCase):
def test_simple(self):
A = NamedTuple('A', [('a', int), ('b', str)])
loader = dataloader.Loader()
r = A(1,'1')
assert loader.load({'a': 1, 'b': 1}, A) == r
assert loader.load({'a': 1, 'b': 1, 'c': 3}, A) == r
loader.failonextra = True
with self.assertRaises(ValueError):
loader.load({'a': 1, 'b': 1, 'c': 3}, A)
def test_nested(self):
A = NamedTuple('A', [('a', int)])
B = NamedTuple('B', [('a', A)])
loader = dataloader.Loader()
r = B(A(1))
assert loader.load({'a': {'a': 1}}, B) == r
with self.assertRaises(TypeError):
loader.load({'a': {'a': 1}}, A)
def test_fail(self):
A = NamedTuple('A', [('a', int), ('q', str)])
loader = dataloader.Loader()
with self.assertRaises(ValueError):
loader.load({'a': 3}, A)
class TestSet(unittest.TestCase):
def test_load_set(self):
loader = dataloader.Loader()
r = {(1, 1), (2, 2), (0, 0)}
assert loader.load(zip(range(3), range(3)), Set[Tuple[int,int]]) == r
assert loader.load([1, '2', 2], Set[int]) == {1, 2}
def test_load_frozen_set(self):
loader = dataloader.Loader()
assert loader.load(range(4), FrozenSet[float]) == frozenset((0.0, 1.0, 2.0, 3.0))
class TestDict(unittest.TestCase):
def test_load_dict(self):
loader = dataloader.Loader()
class State(Enum):
OK = 'ok'
FAILED = 'failed'
v = {'1': 'ok', '15': 'failed'}
r = {1: State.OK, 15: State.FAILED}
assert loader.load(v, Dict[int, State]) == r
def test_load_nondict(self):
class SimDict():
def items(self):
return zip(range(12), range(12))
loader = dataloader.Loader()
assert loader.load(SimDict(), Dict[str, int]) == {str(k): v for k,v in zip(range(12), range(12))}
with self.assertRaises(AttributeError):
loader.load(33, Dict[int, str])
class TestTuple(unittest.TestCase):
def test_load_list_of_tuples(self):
t = List[Tuple[str, int, Tuple[int, int]]]
v = [
['a', 12, [1, 1]],
['b', 15, [3, 2]],
]
r = [
('a', 12, (1, 1)),
('b', 15, (3, 2)),
]
loader = dataloader.Loader()
assert loader.load(v, t) == r
def test_load_nested_tuple(self):
loader = dataloader.Loader()
assert loader.load([1, 2, 3, [1, 2]], Tuple[int,int,int,Tuple[str,str]]) == (1, 2, 3, ('1', '2'))
def test_load_tuple(self):
loader = dataloader.Loader()
assert loader.load([1, 2, 3], Tuple[int,int,int]) == (1, 2, 3)
assert loader.load(['2', False, False], Tuple[int, bool]) == (2, False)
with self.assertRaises(ValueError):
loader.load(['2', False], Tuple[int, bool, bool])
loader.failonextra = True
assert loader.load(['2', False, False], Tuple[int, bool]) == (2, False)
class TestLoader(unittest.TestCase):
def test_kwargs(self):
with self.assertRaises(ValueError):
load(1, str, basiccast=False)
load(1, int, handlers=[])
class TestBasicTypes(unittest.TestCase):
def test_basic_casting(self):
# Casting enabled, by default
loader = dataloader.Loader()
assert loader.load(1, int) == 1
assert loader.load(1.1, int) == 1
assert loader.load(False, int) == 0
assert loader.load('ciao', str) == 'ciao'
assert loader.load('1', float) == 1.0
with self.assertRaises(ValueError):
loader.load('ciao', float)
def test_list_basic(self):
loader = dataloader.Loader()
assert loader.load(range(12), List[int]) == list(range(12))
assert loader.load(range(12), List[str]) == [str(i) for i in range(12)]
def test_extra_basic(self):
# Add more basic types
loader = dataloader.Loader()
with self.assertRaises(TypeError):
assert loader.load(b'ciao', bytes) == b'ciao'
loader.basictypes.add(bytes)
assert loader.load(b'ciao', bytes) == b'ciao'
def test_none_basic(self):
loader = dataloader.Loader()
loader.load(None, type(None))
with self.assertRaises(ValueError):
loader.load(12, type(None))
def test_basic_nocasting(self):
# Casting enabled, by default
loader = dataloader.Loader()
loader.basiccast = False
assert loader.load(1, int) == 1
assert loader.load(True, bool) == True
assert loader.load(1.5, float) == 1.5
with self.assertRaises(ValueError):
loader.load(1.1, int)
loader.load(False, int)
loader.load('ciao', str)
loader.load('1', float)
class TestHandlers(unittest.TestCase):
def test_custom_handler(self):
class Q:
def __eq__(self, other):
return isinstance(other, Q)
loader = dataloader.Loader()
loader.handlers.append((
lambda t: t == Q,
lambda l, v, t: Q()
))
assert loader.load('test', Q) == Q()
def test_broken_handler(self):
loader = dataloader.Loader()
loader.handlers.insert(0, (lambda t: 33 + t is None, lambda l, v, t: None))
with self.assertRaises(TypeError):
loader.load(1, int)
loader.raiseconditionerrors = False
assert loader.load(1, int) == 1
typedload/tests/test_dumpload.py 0000644 0001750 0001750 00000002721 13262110503 016450 0 ustar salvo salvo # typedload
# Copyright (C) 2018 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
from typedload import dump, load
class Result(Enum):
PASS = True
FAIL = False
class Student(NamedTuple):
name: str
id: int
email: Optional[str] = None
class ExamResults(NamedTuple):
results: List[Tuple[Student, Result]]
class TestDumpLoad(unittest.TestCase):
def test_dump_load_results(self):
results = ExamResults(
[
(Student('Anna', 1), Result.PASS),
(Student('Alfio', 2), Result.PASS),
(Student('Iano', 3, 'iano@iano.it'), Result.PASS),
]
)
assert load(dump(results), ExamResults) == results
typedload/tests/test_typeddict.py 0000644 0001750 0001750 00000002534 13566742617 016666 0 ustar salvo salvo # typedload
# Copyright (C) 2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from typing import TypedDict
import unittest
from typedload import dataloader, load, dump, typechecks
class Person(TypedDict):
name: str
age: float
class A(TypedDict):
val: str
class TestTypeddictLoad(unittest.TestCase):
def test_loadperson(self):
o = {'name': 'pino', 'age': 1.1}
assert load(o, Person) == o
assert load({'val': 3}, A) == {'val': '3'}
with self.assertRaises(ValueError):
o.pop('age')
load(o, Person)
def test_is_typeddict(self):
assert typechecks.is_typeddict(A)
assert typechecks.is_typeddict(Person)
typedload/tests/test_attrload.py 0000644 0001750 0001750 00000012516 13460011657 016472 0 ustar salvo salvo # typedload
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
import attr
from typedload import attrload, attrdump, exceptions, typechecks
from typedload import datadumper
from typedload.plugins import attrdump as attrplugin
class Hair(Enum):
BROWN = 'brown'
BLACK = 'black'
BLONDE = 'blonde'
WHITE = 'white'
@attr.s
class Person:
name = attr.ib(default='Turiddu', type=str)
address = attr.ib(type=Optional[str], default=None)
@attr.s
class DetailedPerson(Person):
hair = attr.ib(type=Hair, default=Hair.BLACK)
@attr.s
class Students:
course = attr.ib(type=str)
students = attr.ib(type=List[Person])
@attr.s
class Mangle:
value = attr.ib(type=int, metadata={'name': 'va.lue'})
class TestAttrDump(unittest.TestCase):
def test_basicdump(self):
assert attrdump(Person()) == {}
assert attrdump(Person('Alfio')) == {'name': 'Alfio'}
assert attrdump(Person('Alfio', '33')) == {'name': 'Alfio', 'address': '33'}
def test_norepr(self):
@attr.s
class A:
i = attr.ib(type=int)
j = attr.ib(type=int, repr=False)
assert attrdump(A(1,1)) == {'i': 1}
def test_dumpdefault(self):
dumper = datadumper.Dumper()
attrplugin.add2dumper(dumper)
dumper.hidedefault = False
assert dumper.dump(Person()) == {'name': 'Turiddu', 'address': None}
def test_nesteddump(self):
assert attrdump(
Students('advanced coursing', [
Person('Alfio'),
Person('Carmelo', 'via mulino'),
])) == {
'course': 'advanced coursing',
'students': [
{'name': 'Alfio'},
{'name': 'Carmelo', 'address': 'via mulino'},
]
}
class TestAttrload(unittest.TestCase):
def test_condition(self):
assert typechecks.is_attrs(Person)
assert typechecks.is_attrs(Students)
assert typechecks.is_attrs(Mangle)
assert typechecks.is_attrs(DetailedPerson)
assert not typechecks.is_attrs(int)
assert not typechecks.is_attrs(List[int])
assert not typechecks.is_attrs(Union[str, int])
assert not typechecks.is_attrs(Tuple[str, int])
def test_basicload(self):
assert attrload({'name': 'gino'}, Person) == Person('gino')
assert attrload({}, Person) == Person('Turiddu')
def test_nestenum(self):
assert attrload({'hair': 'white'}, DetailedPerson) == DetailedPerson(hair=Hair.WHITE)
def test_nested(self):
assert attrload(
{
'course': 'advanced coursing',
'students': [
{'name': 'Alfio'},
{'name': 'Carmelo', 'address': 'via mulino'},
]
},
Students,
) == Students('advanced coursing', [
Person('Alfio'),
Person('Carmelo', 'via mulino'),
])
def test_uuid(self):
import uuid
@attr.s
class A:
a = attr.ib(type=int)
uuid_value = attr.ib(type=str, init=False)
def __attrs_post_init__(self):
self.uuid_value = str(uuid.uuid4())
assert type(attrload({'a': 1}, A).uuid_value) == str
assert attrload({'a': 1}, A) != attrload({'a': 1}, A)
class TestMangling(unittest.TestCase):
def test_load_metanames(self):
a = {'va.lue': 12}
b = a.copy()
assert attrload(a, Mangle) == Mangle(12)
assert a == b
def test_dump_metanames(self):
assert attrdump(Mangle(12)) == {'va.lue': 12}
class TestAttrExceptions(unittest.TestCase):
def test_wrongtype(self):
try:
attrload(3, Person)
except exceptions.TypedloadTypeError:
pass
data = {
'course': 'how to be a corsair',
'students': [
{'name': 'Alfio'},
3
]
}
try:
attrload(data, Students)
except exceptions.TypedloadTypeError as e:
assert e.trace[-1].annotation[1] == 1
def test_index(self):
try:
attrload(
{
'course': 'advanced coursing',
'students': [
{'name': 'Alfio'},
{'name': 'Carmelo', 'address': 'via mulino'},
[],
]
},
Students,
)
except Exception as e:
assert e.trace[-2].annotation[1] == 'students'
assert e.trace[-1].annotation[1] == 2
typedload/tests/test_dataclass.py 0000644 0001750 0001750 00000007161 13454272707 016627 0 ustar salvo salvo # typedload
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from dataclasses import dataclass, field
from enum import Enum
from typing import Dict, List, NamedTuple, Optional, Set, Tuple, Union
import unittest
from typedload import dataloader, load, dump, typechecks
class TestDataclassLoad(unittest.TestCase):
def test_is_dataclass(self):
@dataclass
class A:
pass
class B(NamedTuple):
pass
assert typechecks.is_dataclass(A)
assert not typechecks.is_dataclass(List[int])
assert not typechecks.is_dataclass(Tuple[int, int])
assert not typechecks.is_dataclass(B)
def test_factory_load(self):
@dataclass
class A:
a: List[int] = field(default_factory=list)
assert load({'a': [1, 2, 3]}, A) == A([1, 2, 3])
assert load({'a': []}, A) == A()
assert load({}, A) == A()
def test_load(self):
@dataclass
class A:
a: int
b: str
assert load({'a': 101, 'b': 'ciao'}, A) == A(101, 'ciao')
def test_nestedload(self):
@dataclass
class A:
a: int
b: str
@dataclass
class B:
a: A
b: List[A]
assert load({'a': {'a': 101, 'b': 'ciao'}, 'b': []}, B) == B(A(101, 'ciao'), [])
assert load(
{'a': {'a': 101, 'b': 'ciao'}, 'b': [{'a': 1, 'b': 'a'},{'a': 0, 'b': 'b'}]},
B
) == B(A(101, 'ciao'), [A(1, 'a'),A(0, 'b')])
def test_defaultvalue(self):
@dataclass
class A:
a: int
b: Optional[str] = None
assert load({'a': 1}, A) == A(1)
assert load({'a': 1, 'b': 'io'}, A) == A(1, 'io')
class TestDataclassUnion(unittest.TestCase):
def test_ComplicatedUnion(self):
@dataclass
class A:
a: int
@dataclass
class B:
a: str
@dataclass
class C:
val: Union[A, B]
loader = dataloader.Loader()
loader.basiccast = False
assert type(loader.load({'val': {'a': 1}}, C).val) == A
assert type(loader.load({'val': {'a': '1'}}, C).val) == B
class TestDataclassDump(unittest.TestCase):
def test_dump(self):
@dataclass
class A:
a: int
b: int = 0
assert dump(A(12)) == {'a': 12}
assert dump(A(12), hidedefault=False) == {'a': 12, 'b': 0}
def test_factory_dump(self):
@dataclass
class A:
a: int
b: List[int] = field(default_factory=list)
assert dump(A(3)) == {'a': 3}
assert dump(A(12), hidedefault=False) == {'a': 12, 'b': []}
class TestDataclassMangle(unittest.TestCase):
def test_mangle_load(self):
@dataclass
class Mangle:
value: int = field(metadata={'name': 'va.lue'})
assert load({'va.lue': 1}, Mangle) == Mangle(1)
assert dump(Mangle(1)) == {'va.lue': 1}
typedload/LICENSE 0000644 0001750 0001750 00000124357 13266302104 013113 0 ustar salvo salvo This software is released under the GNU General Public License 3.
An exception to this is granted to Cyxtera Technologies, Inc., which
is allowed to use this software under the GNU Lesser General Public
License 3. Because the author works there.
Verbatim text of GNU GPL 3 and GNU LGPL 3 follows.
=====================================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
============================================================================
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
typedload/CONTRIBUTING.md 0000644 0001750 0001750 00000001013 13266302104 014316 0 ustar salvo salvo All contributions must pass the test suite and must generate no warnings with the latest available version of mypy.
The best way of sending changes is to use git-send-mail to tiposchi@tiscali.it
It is acceptable also to use github's pull request functionality.
Contributors must accept that their changes can use both GPL3 and LGPL3. Currently the license is GPL3 with one exception being made for the company where I work. In the future more LGPL3 exception could be made, but no other license than those will be used.
typedload/CHANGELOG 0000644 0001750 0001750 00000004164 13610023273 013311 0 ustar salvo salvo 1.20
* Drop support for Python 3.5.2 (3.5 series is still supported)
* Support TypedDict
* More precise type annotation of TypedloadException and Annotation fields
* Deprecate the plugin to handle attr.s and make it always supported.
This means that there will be no need for special code.
* Fix datetime loader raising exceptions with the wrong type
1.19
* Add support for Literal.
1.18
* Improved documentation
* Debian builds are now done source only
1.17
* Prefer the same type in union loading
1.16
* New uniontypes() function.
* Make list and dictionary loaders raise the correct exceptions
* Able to load from argparse.Namespace
1.15
* Add support for FrozenSet[T].
* Define __all__ for typechecks.
* Add name mangling support in dataclass, to match attrs.
* Add support for datetime.date, datetime.time, datetime.datetime
1.14
* Add support for Tuple[t, ...]
1.13
* Fix bug in loading attr classes and passing random crap.
Now the proper exception is raised.
* New module to expose the internal type checks functions
1.12
* Support fields with factory for dataclass
1.11
* Fixed problem when printing sub-exceptions of failed unions
* Improve documentation
1.10
* Make mypy happy again
1.9
* Support ForwardRef
* Add a new Exception type with more details on the error (no breaking API changes)
1.8
* Make mypy happy again
1.7
* Make mypy happy again
1.6
* Run tests on older python as well
* Support for dataclass (Since python 3.7)
* Added methods to find the appropriate handlers
1.5
* Improve handling of unions
* Better continuous integration
* Support python 3.7
1.4
* Add support for name mangling in attr plugin
* Parameters can be passed as kwargs
* Improved exception message for NamedTuple loading
1.3
* Add support for Python < 3.5.3
1.2
* Ship the plugins in pypy
1.1
* Able to load and dump old style NamedTuple
* Support for Python 3.5
* Target to run mypy in makefile
* Refactor to support plugins. The API is still compatible.
* Plugin for the attr module, seems useful in Python 3.5
1.0
* Has a setting to hide default fields or not, in dumps
* Better error reporting
* Add file for PEP 561
0.9
* Initial release
typedload/README.md 0000644 0001750 0001750 00000005451 13573147077 013377 0 ustar salvo salvo typedload
=========
Load and dump json-like data into typed data structures in Python3, enforcing
a schema on the data.
This module provides an API to load dictionaries and lists (usually loaded
from json) into Python's NamedTuples, dataclass, sets, enums, and various
other typed data structures; respecting all the type-hints and performing
type checks or casts when needed.
It can also dump from typed data structures to json-like dictionaries and lists.
It is very useful for projects that use Mypy and deal with untyped data
like json, because it guarantees that the data will follow the specified schema.
Note that it is released with a GPL license and it cannot be used inside non
GPL software.
Example
=======
For example this dictionary, loaded from a json:
```python
data = {
'users': [
{
'username': 'salvo',
'shell': 'bash',
'sessions': ['pts/4', 'tty7', 'pts/6']
},
{
'username': 'lop'
}
],
}
```
Can be treated more easily if loaded into this type:
```python
class User(NamedTuple):
username: str
shell: str = 'bash'
sessions: List[str] = []
class Logins(NamedTuple):
users: List[User]
```
And the data can be loaded into the structure with this:
```python
t_data = typedload.load(data, Logins)
```
And then converted back:
```python
data = typedload.dump(t_data)
```
Supported types
===============
Since this is not magic, not all types are supported.
The following things are supported:
* Basic python types (int, str, bool, float, NoneType)
* NamedTuple
* Enum
* Optional[SomeType]
* List[SomeType]
* Dict[TypeA, TypeB]
* Tuple[TypeA, TypeB, TypeC]
* Set[SomeType]
* Union[TypeA, TypeB]
* dataclass (requires Python 3.7)
* attr.s
* ForwardRef (Refer to the type in its own definition)
* Literal (requires Python 3.8)
* TypedDict (requires Python 3.8)
* datetime.date, datetime.time, datetime.datetime
Advantage when using Mypy
=========================
```python
# This is treated as Any, no checks done.
data = json.load(f)
# This is treated as Dict[str, int]
# but there will be runtime errors if the data does not
# match the expected format
data = json.load(f) # type: Dict[str, int]
# This is treated as Dict[str, int] and an exception is
# raised if the actual data is not Dict[str, int]
data = typedload.load(json.load(f), Dict[str, int])
```
So when using Mypy, it makes sense to make sure that the type is correct,
rather than hoping the data will respect the format.
Documentation
=============
The documentation can be generated by running:
```
make docs
```
And it will be located inside the `docs` directory.
See the file `example.py` to see a basic usecase for this module.
The tests are harder to read but provide more in depth examples of
the capabilities of this module.
typedload/example.py 0000744 0001750 0001750 00000007231 13262355545 014120 0 ustar salvo salvo #!/usr/bin/python3
# typedload
# Copyright (C) 2018 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
#This is a basic example on how to use the typedload library.
#Json data is downloaded from the internet and then loaded into
#Python data structures (dictionaries, lists, strings, and so on).
#This example queries Yahoo weather and prints the forecast.
import json
import sys
from typing import Any, Dict, List, NamedTuple, Optional
import urllib.request
import typedload
def get_url(city: Optional[str]) -> str:
"""
Get the URL for the Yahoo weather API for a
given city
"""
if not city:
city = 'Catania'
return "https://query.yahooapis.com/v1/public/yql?q=sele" \
"ct%20*%20from%20weather.forecast%20where%20w" \
"oeid%20in%20(select%20woeid%20from%20geo.pla" \
"ces(1)%20where%20text%3D%22" + city + "%22)%" \
"20and%20u%3D'c'&format=json&env=store%3A%2F%" \
"2Fdatatables.org%2Falltableswithkeys"
def get_data(city: Optional[str]) -> Dict[str, Any]:
"""
Use the Yahoo weather API to get weather information
"""
req = urllib.request.Request(get_url(city))
with urllib.request.urlopen(req) as f:
response = f.read()
answer = response.decode('ascii')
data = json.loads(answer)
r = data['query']['results']['channel'] # Remove some useless nesting
return r
class Units(NamedTuple):
distance: str
pressure: str
speed: str
temperature: str
class Astronomy(NamedTuple):
sunrise: str
sunset: str
class Atmosphere(NamedTuple):
humidity: int
pressure: float
rising: int
visibility: float
class Forecast(NamedTuple):
date: str
day: str
high: int
low: int
text: str
class Condition(NamedTuple):
date: str
temp: int
text: str
class Item(NamedTuple):
forecast: List[Forecast]
condition: Condition
title: str
class Wind(NamedTuple):
chill: int
direction: int
speed: float
class Weather(NamedTuple):
item: Item
units: Units
astronomy: Astronomy
atmosphere: Atmosphere
wind: Wind
def main():
raw_data = get_data(sys.argv[1] if len(sys.argv) == 2 else None)
weather = typedload.load(raw_data, Weather)
print(weather.item.title)
print()
print('Sunrise %s\t Sunset %s' % (weather.astronomy.sunrise, weather.astronomy.sunset))
print()
print('%s %s%s' % (weather.item.condition.text, weather.item.condition.temp, weather.units.temperature))
print()
print('Wind: %d%s' % (weather.wind.speed, weather.units.speed))
print('Humidity: %s%%' % (weather.atmosphere.humidity, ))
print('Pressure: %s%s' % (weather.atmosphere.pressure, weather.units.pressure))
print('Visibility: %s%s' % (weather.atmosphere.humidity, weather.units.distance))
print()
print('Forecast')
for i in weather.item.forecast:
print('%s\tMin: %2s%s\tMax: %2s%s\t%s' % (i.day, i.low, weather.units.temperature, i.high, weather.units.temperature, i.text))
if __name__ == '__main__':
main()
typedload/mypy.conf 0000644 0001750 0001750 00000000223 13342553647 013753 0 ustar salvo salvo [mypy]
python_version=3.5
warn_unused_ignores=True
warn_redundant_casts=True
strict_optional=True
scripts_are_modules=True
check_untyped_defs=True
typedload/typedload/ 0000755 0001750 0001750 00000000000 13610100343 014051 5 ustar salvo salvo typedload/typedload/py.typed 0000644 0001750 0001750 00000000000 13266213301 015544 0 ustar salvo salvo typedload/typedload/plugins/ 0000755 0001750 0001750 00000000000 13610100343 015532 5 ustar salvo salvo typedload/typedload/plugins/attrload.py 0000644 0001750 0001750 00000001570 13573147077 017750 0 ustar salvo salvo """
DEPRECATED: This does nothing
"""
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
def add2loader(l) -> None:
"""
DEPRECATED: Calls to this can be safely removed.
"""
pass
typedload/typedload/plugins/__init__.py 0000644 0001750 0001750 00000000000 13342553647 017656 0 ustar salvo salvo typedload/typedload/plugins/attrdump.py 0000644 0001750 0001750 00000001600 13573147077 017770 0 ustar salvo salvo """
DEPRECATED: This module does nothing.
"""
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
def add2dumper(l) -> None:
"""
DEPRECATED: Calls to this can be safely removed.
"""
pass
typedload/typedload/exceptions.py 0000644 0001750 0001750 00000011052 13567156327 016633 0 ustar salvo salvo """
typedload
Exceptions
"""
# Copyright (C) 2018 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Any, List, NamedTuple, Optional, Type, Union
class AnnotationType(Enum):
"""
The types of annotation, used by different loaders.
FIELD is the name of a field
INDEX is the numerical index of a value, in subscriptable objects-
"""
FIELD = 'field'
INDEX = 'index'
FORWARDREF = 'forwardref'
KEY = 'key'
VALUE = 'value'
UNION = 'union'
Annotation = NamedTuple('Annotation', [
('annotation_type', AnnotationType),
('value', Union[str, int, Type]),
])
TraceItem = NamedTuple('TraceItem', [
('value', Any),
('type_', Type),
('annotation', Optional[Annotation]),
])
class TypedloadException(Exception):
"""
Exception which exposes some extra fields.
trace:
It is a list of all the recursive invocations of load(), with the
parameters used.
Very useful to locate the issue.
The annotation is used by complex loaders that call load() more than
once, to indicate in which step the error occurred.
For example a list loader will use it to indicate the index which had
the exception, and a NamedTuple loader will use it to indicate the name
of the field which generated the exception.
value:
contains the value that could not be loaded.
type_:
contains the type in which the value could not be loaded.
exceptions:
A list of exceptions that happened during the loading.
This is for now only used by the Union loader, to list all the
exceptions that occurred during the various attempts.
"""
def __init__(
self,
description: str,
trace: Optional[List[TraceItem]] = None,
value=None,
type_: Optional[Type] = None,
exceptions: Optional[List[Exception]] = None) -> None:
super().__init__(description)
self.trace = trace if trace else []
self.value = value
self.type_ = type_
self.exceptions = exceptions if exceptions else []
def __str__(self) -> str:
def compress_value(v: Any) -> str:
v = str(v)
if len(v) > 80:
return v[:77] + '...'
return v
e = '%s\nValue: %s\nType: %s\n' % (
super().__str__(),
compress_value(self.value),
self.type_
)
if self.trace:
e += '\nLoad trace:\n'
path = [] # type: List[str]
for i in self.trace:
e += 'Type: %s ' % i.type_
if i.annotation:
e += 'Annotation: (%s %s) ' % (i.annotation[0], i.annotation[1])
path.append('[%d]' % i.annotation[1] if isinstance(i.annotation[1], int) else str(i.annotation[1]))
else:
path.append(str(None))
e += 'Value: %s\n' % compress_value(i.value)
if path:
if path[0] == str(None):
path[0] = ''
e += 'Path: ' + '.'.join(path) + '\n'
return e
class TypedloadValueError(TypedloadException, ValueError):
"""
Exception class, subclass of ValueError.
See the documentation of TypedloadException for more details.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
class TypedloadTypeError(TypedloadException, TypeError):
"""
Exception class, subclass of TypeError.
See the documentation of TypedloadException for more details.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
class TypedloadAttributeError(TypedloadException, AttributeError):
"""
Exception class, subclass of AttributeError.
See the documentation of TypedloadException for more details.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
typedload/typedload/datadumper.py 0000644 0001750 0001750 00000016203 13573147077 016602 0 ustar salvo salvo """
typedload
This module is the inverse of dataloader. It converts typed
data structures to things that json can serialize.
"""
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
import datetime
from enum import Enum
from typing import *
from .exceptions import TypedloadValueError
from .typechecks import is_attrs
__all__ = [
'Dumper',
]
NONETYPE = type(None) # type: Type[Any]
class Dumper:
def __init__(self, **kwargs):
"""
This dumps data structures recursively using only
basic types, lists and dictionaries.
A value dumped in this way from a typed data structure
can be loaded back using dataloader.
hidedefault: Enabled by default.
When enabled, does not include fields that have the
same value as the default in the dump.
raiseconditionerrors: Enabled by default.
Raises exceptions when evaluating a condition from an
handler. When disabled, the exceptions are not raised
and the condition is considered False.
handlers: This is the list that the dumper uses to
perform its task.
The type is:
List[
Tuple[
Callable[[Any], bool],
Callable[['Dumper', Any], Any]
]
]
The elements are: Tuple[Condition, Dumper]
Condition(value) -> Bool
Dumper(dumper, value) -> simpler_value
In most cases, it is sufficient to append new elements
at the end, to handle more types.
These parameters can be set as named arguments in the constructor
or they can be set later on.
The constructor will accept any named argument, but only the documented
ones have any effect. This is to allow custom handlers to have their
own parameters as well.
There is support for:
* Basic python types (int, str, bool, float, NoneType)
* NamedTuple
* Enum
* List[SomeType]
* Dict[TypeA, TypeB]
* Tuple[TypeA, TypeB, TypeC]
* Set[SomeType]
"""
self.basictypes = {int, bool, float, str, NONETYPE}
self.hidedefault = True
# Raise errors if the condition fails
self.raiseconditionerrors = True
self.handlers = [
(lambda value: type(value) in self.basictypes, lambda l, value: value),
(lambda value: isinstance(value, tuple) and hasattr(value, '_fields') and hasattr(value, '_asdict'), _namedtupledump),
(lambda value: '__dataclass_fields__' in dir(value), _dataclassdump),
(lambda value: isinstance(value, (list, tuple, set, frozenset)), lambda l, value: [l.dump(i) for i in value]),
(lambda value: isinstance(value, Enum), lambda l, value: l.dump(value.value)),
(lambda value: isinstance(value, Dict), lambda l, value: {l.dump(k): l.dump(v) for k, v in value.items()}),
(lambda value: isinstance(value, (datetime.date, datetime.time)), _datetimedump),
(is_attrs, _attrdump),
] # type: List[Tuple[Callable[[Any], bool],Callable[['Dumper', Any], Any]]]
for k, v in kwargs.items():
setattr(self, k, v)
def index(self, value: Any) -> int:
"""
Returns the index in the handlers list
that matches the given value.
If no condition matches, ValueError is raised.
"""
for i, cond in ((j[0], j[1][0]) for j in enumerate(self.handlers)):
try:
match = cond(value)
except:
if self.raiseconditionerrors:
raise
match = False
if match:
return i
raise TypedloadValueError('Unable to dump %s' % value, value=value)
def dump(self, value: Any) -> Any:
"""
Dump the typed data structure into its
untyped equivalent.
"""
index = self.index(value)
func = self.handlers[index][1]
return func(self, value)
def _attrdump(d, value) -> Dict[str, Any]:
r = {}
for attr in value.__attrs_attrs__:
attrval = getattr(value, attr.name)
if not attr.repr:
continue
if not (d.hidedefault and attrval == attr.default):
name = attr.metadata.get('name', attr.name)
r[name] = d.dump(attrval)
return r
def _datetimedump(l, value: Union[datetime.time, datetime.date, datetime.datetime]):
# datetime is subclass of date
if isinstance(value, datetime.date) and not isinstance(value, datetime.datetime):
return [value.year, value.month, value.day]
if value.tzinfo is not None:
raise NotImplemented('Dumping of tzdata object is not supported')
if isinstance(value, datetime.time):
return [value.hour, value.minute, value.second, value.microsecond]
# datetime.datetime
return [value.year, value.month, value.day, value.hour, value.minute, value.second, value.microsecond]
def _namedtupledump(l, value):
field_defaults = getattr(value, '_field_defaults', {})
# Named tuple, skip default values
return {
k: l.dump(v) for k, v in value._asdict().items()
if not l.hidedefault or k not in field_defaults or field_defaults[k] != v
}
def _dataclassdump(l, value):
import dataclasses
fields = set(value.__dataclass_fields__.keys())
field_defaults = {k: v.default for k,v in value.__dataclass_fields__.items() if not isinstance (v.default, dataclasses._MISSING_TYPE)}
field_factories = {k: v.default_factory() for k,v in value.__dataclass_fields__.items() if not isinstance (v.default_factory, dataclasses._MISSING_TYPE)}
defaults = {**field_defaults, **field_factories} # Merge the two dictionaries
r = {
f: l.dump(getattr(value, f)) for f in fields
if not l.hidedefault or f not in defaults or defaults[f] != getattr(value, f)
}
#Name mangling
# Prepare the list of the needed name changes
transforms = [] # type: List[Tuple[str, str]]
for field in fields:
if value.__dataclass_fields__[field].metadata:
name = value.__dataclass_fields__[field].metadata.get('name')
if name:
transforms.append((field, name))
# Do the needed name changes
if transforms:
for pyname, dataname in transforms:
if pyname in r:
tmp = r[pyname]
del r[pyname]
r[dataname] = tmp
return r
typedload/typedload/__init__.py 0000644 0001750 0001750 00000011510 13573147077 016207 0 ustar salvo salvo """
typedload
=========
This library loads Python data structures into
typed data structures, enforcing a schema.
The main purpose is to load things that come from
json, bson or similar into NamedTuple or Dataclass.
For example this Json:
{
'users': [
{
'username': 'salvo',
'shell': 'bash',
'sessions': ['pts/4', 'tty7', 'pts/6']
},
{
'username': 'lop'
}
],
}
Can be treated more easily if loaded into this:
class User(NamedTuple):
username: str
shell: str = 'bash'
sessions: List[str] = []
class Logins(NamedTuple):
users: List[User]
And can then be loaded with
typedload.load(data, Logins)
Simple API
==========
typedload.load() and typedload.dump() are functions to quickly load and dump
data using the default objects.
They create a new loader/dumper object with default parameters, and
discard it after.
Classes
=======
The loader and dumper classes expose a number of attributes that can be
customised to tweak their behaviour.
Handlers
========
An important way to tweak the behaviour of a loader or dumper object is
to modify the handlers list.
The handlers' list items are tuples for two functions. The signatures are
different for loader or dumper.
The first function returns a boolean, and if the value is true, the object
will call the second function and return its result.
Basically a loader and a dumper class have no functionality (but come with
a default list of handlers).
So, to add support for a new type, it is sufficient to write a function that
outputs the desired value, and a function that decides when to call that.
The index() function returns the position of handlers in the list, so that
it is possible to remove them or add new handlers before or after a given
handler.
The pointer to the loader or dumper object is passed, so that the attributes
in use for that particular object are available.
For example, if we want to add a special loader that when loading the int 42
into a string returns 'quarantadue', we can do this:
from typedload.dataloader import Loader
l = Loader()
l.handlers.insert(
l.index(str), # This will place this entry before the string handler
(
lambda x: x == str,
lambda loader, value, type_: str(value) if value != 42 else 'quarantadue'
)
)
Then this will happen:
In [15]: l.load(12, str)
Out[15]: '12'
In [16]: l.load(42, str)
Out[16]: 'quarantadue'
This can of course be used also for use cases that make sense.
The handlers must generate exceptions from the typedload.exceptions
module.
Name mangling
=============
Name mangling is supported in datatypes with metadata (dataclass, attrs) by
having a 'name' key in the metadata.
@attr.s
class Example:
attribute = attr.ib(type=int, metadata={'name': 'att.rib.ute:name'}
@dataclass
class Example():
attribute: str = field(metadata={'name': 'att.rib.ute:name'})
The dictionary key for 'attribute' will be 'att.rib.ute:name'.
This is very useful for keys that use invalid or reserved characters that
can't be used in variable names.
Another common application is to convert camelCase into not_camel_case.
"""
# Copyright (C) 2018-2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from typing import Any, Type, TypeVar
__all__ = [
'dataloader',
'load',
'datadumper',
'dump',
'attrload',
'attrdump',
'typechecks',
]
T = TypeVar('T')
def load(value: Any, type_: Type[T], **kwargs) -> T:
"""
Quick function call to load data into a type.
It is useful to avoid creating the Loader object,
in case only the default parameters are used.
"""
from . import dataloader
loader = dataloader.Loader(**kwargs)
return loader.load(value, type_)
def dump(value: Any, **kwargs) -> Any:
"""
Quick function to dump a data structure into
something that is compatible with json or
other programs and languages.
It is useful to avoid creating the Dumper object,
in case only the default parameters are used.
"""
from . import datadumper
dumper = datadumper.Dumper(**kwargs)
return dumper.dump(value)
attrload = load # DEPRECATED
attrdump = dump # DEPRECATED
typedload/typedload/dataloader.py 0000644 0001750 0001750 00000045101 13610023273 016532 0 ustar salvo salvo """
typedload
Module to load data into typed data structures
"""
# Copyright (C) 2018-2020 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
import datetime
from enum import Enum
from typing import *
from .exceptions import *
from .typechecks import *
__all__ = [
'Loader',
]
T = TypeVar('T')
class _FakeNamedTuple(tuple):
"""
This class simulates a Python3.6 NamedTuple
instance.
It has the same hidden fields, so the same
loader for the NamedTuple.
It needs to be created with fields, field_types, field_defaults
"""
def __new__(cls, fields):
return super(_FakeNamedTuple, cls).__new__(cls, tuple(fields))
@property
def _fields(self):
return self[0]
@property
def __annotations__(self):
return self[1]
@property
def _field_defaults(self):
return self[2]
def __call__(self, **kwargs):
try:
return self[3](**kwargs)
except TypeError as e:
raise TypedloadTypeError(str(e), type_=self[3], value=kwargs)
except Exception as e:
raise TypedloadException(str(e), type_=self[3], value=kwargs)
class Loader:
"""
A loader object that recursively loads data into
the desired type.
basictypes: a set of types that are considered as
building blocks for everything else and do not
need to be converted further.
If you are not loading from json, you probably
want to add bytes to the set.
failonextra: Disabled by default.
When enabled, the loader will raise exceptions if
there are fields in the data that are not being used
by the type.
basiccast: Enabled by default.
When disabled, instead of trying to perform casts,
exceptions will be raised.
Since many json seem to encode numbers as strings,
to avoid extra complications this functionality is
provided.
If you know that your original data is encoded
properly, it is better to disable this.
dictequivalence: Enabled by default.
Automatically convert dict-like classes to dictionary
when loading. This enables them to be loaded into other
classes.
At the moment it supports:
argparse.Namespace
raiseconditionerrors: Enabled by default.
Raises exceptions when evaluating a condition from an
handler. When disabled, the exceptions are not raised
and the condition is considered False.
handlers: This is the list that the loader uses to
perform its task.
The type is:
List[
Tuple[
Callable[[Type[T]], bool],
Callable[['Loader', Any, Type[T]], T]
]
]
The elements are: Tuple[Condition,Loader]
Condition(type) -> Bool
Loader(loader, value, type) -> type
In most cases, it is sufficient to append new elements
at the end, to handle more types.
frefs: Dictionary to resolve ForwardRef.
Something like
class Node(NamedTuple):
next: Optional['Node']
requires a ForwardRef (also in python3.7), which means that the type
is stored as string and must be resolved at runtime.
This dictionary contains the names of the types as keys, and the
actual types as values.
A loader object by default starts with an empty dictionary and
fills it with the types it encounters, but it is possible to
manually add more types to the dictionary.
Setting this to None disables any support for ForwardRef.
Reusing the same loader object on unrelated types might cause
failures, if the types are different but use the same names.
These parameters can be set as named arguments in the constructor
or they can be set later on.
The constructor will accept any named argument, but only the documented
ones have any effect. This is to allow custom handlers to have their
own parameters as well.
There is support for:
* Basic python types (int, str, bool, float, NoneType)
* NamedTuple
* Enum
* Optional[SomeType]
* List[SomeType]
* Dict[TypeA, TypeB]
* Tuple[TypeA, TypeB, TypeC]
* Tuple[SomeType, ...]
* Set[SomeType]
* Union[TypeA, TypeB]
* ForwardRef
* Literal
* Dataclass
Using unions is complicated. If the types in the union are too
similar to each other, it is easy to obtain an unexpected type.
"""
def __init__(self, **kwargs):
# Types that do not need conversion
self.basictypes = {int, bool, float, str, NONETYPE}
# If true, it attempts to do casting of basic types
# otherwise an exception is raised
self.basiccast = True
# Raise errors if the value has more data than the
# type expects.
# By default the extra data is ignored.
self.failonextra = False
# Raise errors if the condition fails
self.raiseconditionerrors = True
# Forward refs dictionary
self.frefs = {} # type: Optional[Dict[str, Type]]
# Enable conversion of dict-like things to dicts, before loading
self.dictequivalence = True
# The list of handlers to use to load the data.
# It gets iterated in order, and the first condition
# that matches is used to load the value.
self.handlers = [
(is_nonetype, _noneload),
(is_union, _unionload),
(lambda type_: type_ in self.basictypes, _basicload),
(is_enum, _enumload),
(is_tuple, _tupleload),
(is_list, _listload),
(is_dict, _dictload),
(is_set, _setload),
(is_frozenset, _frozensetload),
(is_namedtuple, _namedtupleload),
(is_dataclass, _namedtupleload),
(is_forwardref, _forwardrefload),
(is_literal, _literalload),
(is_typeddict, _namedtupleload),
(lambda type_: type_ in {datetime.date, datetime.time, datetime.datetime}, _datetimeload),
(is_attrs, _attrload),
] # type: List[Tuple[Callable[[Any], bool], Callable[[Loader, Any, Type], Any]]]
for k, v in kwargs.items():
setattr(self, k, v)
def index(self, type_: Type[T]) -> int:
"""
Returns the index in the handlers list
that matches the given type.
If no condition matches, ValueError is raised.
"""
for i, cond in ((q[0], q[1][0]) for q in enumerate(self.handlers)):
try:
match = cond(type_)
except:
if self.raiseconditionerrors:
raise
match = False
if match:
return i
raise ValueError('No matching condition found')
def load(self, value: Any, type_: Type[T], *, annotation: Optional[Annotation] = None) -> T:
"""
Loads value into the typed data structure.
TypeError is raised if there is no known way to treat type_,
otherwise all errors raise a ValueError.
"""
try:
index = self.index(type_)
except ValueError:
raise TypedloadTypeError(
'Cannot deal with value of type %s' % type_,
value=value,
type_=type_
)
# Add type to known types, to resolve ForwardRef later on
if self.frefs is not None and hasattr(type_, '__name__'):
tname = type_.__name__
if tname not in self.frefs:
self.frefs[tname] = type_
func = self.handlers[index][1]
if self.dictequivalence:
# Convert argparse.Namespace to dictionary
if hasattr(value, '_get_kwargs'):
value = {k: v for k,v in value._get_kwargs()}
try:
return cast(T, func(self, value, type_))
except Exception as e:
assert isinstance(e, TypedloadException)
e.trace.insert(0, TraceItem(value, type_, annotation))
raise e
def _forwardrefload(l: Loader, value: Any, type_: type) -> Any:
"""
This resolves a ForwardRef.
It just looks up the type in the dictionary of known types
and loads the value using that.
"""
if l.frefs is None:
raise TypedloadException('ForwardRef resolving is disabled for the loader', value=value, type_=type_)
tname = type_.__forward_arg__ # type: ignore
t = l.frefs.get(tname)
if t is None:
raise TypedloadValueError(
"ForwardRef '%s' unknown" % tname,
value=value,
type_=type_
)
return l.load(value, t, annotation=Annotation(AnnotationType.FORWARDREF, tname))
def _literalload(l: Loader, value: Any, type_: type) -> Any:
"""
Checks if the value is within the allowed literals and
returns it.
"""
if value in literalvalues(type_):
return value
raise TypedloadValueError('Not one of the allowed values in %s' % type_, value=value, type_=type_)
def _basicload(l: Loader, value: Any, type_: type) -> Any:
"""
This converts a value into a basic type.
In theory it does nothing, but it performs type checking
and raises if conditions fail.
It also attempts casting, if enabled.
"""
if type(value) != type_:
if l.basiccast:
try:
return type_(value)
except ValueError as e:
raise TypedloadValueError(str(e), value=value, type_=type_)
except TypeError as e:
raise TypedloadTypeError(str(e), value=value, type_=type_)
except Exception as e:
raise TypedloadException(str(e), value=value, type_=type_)
else:
raise TypedloadValueError('Not of type %s' % type_, value=value, type_=type_)
return value
def _listload(l: Loader, value, type_) -> List:
"""
This loads into something like List[int]
"""
t = type_.__args__[0]
try:
return [l.load(v, t, annotation=Annotation(AnnotationType.INDEX, i)) for i, v in enumerate(value)]
except TypeError as e:
if isinstance(e, TypedloadException):
raise
raise TypedloadTypeError(str(e), value=value, type_=type_)
def _dictload(l: Loader, value, type_) -> Dict:
"""
This loads into something like Dict[str,str]
Recursively loads both keys and values.
"""
key_type, value_type = type_.__args__
try:
return {
l.load(k, key_type, annotation=Annotation(AnnotationType.KEY, k)): l.load(v, value_type, annotation=Annotation(AnnotationType.VALUE, v))
for k, v in value.items()}
except AttributeError as e:
raise TypedloadAttributeError(str(e), type_=type_, value=value)
def _setload(l: Loader, value, type_) -> Set:
"""
This loads into something like Set[int]
"""
t = type_.__args__[0]
return {l.load(i, t) for i in value}
def _frozensetload(l: Loader, value, type_) -> FrozenSet:
"""
This loads into something like FrozenSet[int]
"""
t = type_.__args__[0]
return frozenset(l.load(i, t) for i in value)
def _tupleload(l: Loader, value, type_) -> Tuple:
"""
This loads into something like Tuple[int,str]
"""
if HAS_TUPLEARGS:
args = type_.__args__
else:
args = type_.__tuple_params__
if len(args) == 2 and args[1] == ...: # Tuple[something, ...]
return tuple(l.load(i, args[0]) for i in value)
else: # Tuple[something, something, somethingelse]
if l.failonextra and len(value) > len(args):
raise TypedloadValueError('Value is too long for type %s' % type_, value=value, type_=type_)
elif len(value) < len(args):
raise TypedloadValueError('Value is too short for type %s' % type_, value=value, type_=type_)
return tuple(l.load(v, t, annotation=Annotation(AnnotationType.INDEX, i)) for i, (v, t) in enumerate(zip(value, args)))
def _namedtupleload(l: Loader, value: Dict[str, Any], type_) -> Tuple:
"""
This loads a Dict[str, Any] into a NamedTuple.
"""
if not hasattr(type_, '__dataclass_fields__'):
fields = set(type_.__annotations__.keys())
optional_fields = set(getattr(type_, '_field_defaults', {}).keys())
type_hints = type_.__annotations__
else:
#dataclass
import dataclasses
fields = set(type_.__dataclass_fields__.keys())
optional_fields = {k for k,v in type_.__dataclass_fields__.items() if not (isinstance(getattr(v, 'default', dataclasses._MISSING_TYPE()), dataclasses._MISSING_TYPE) and isinstance(getattr(v, 'default_factory', dataclasses._MISSING_TYPE()), dataclasses._MISSING_TYPE))}
type_hints = {k: v.type for k,v in type_.__dataclass_fields__.items()}
#Name mangling
# Prepare the list of the needed name changes
transforms = [] # type: List[Tuple[str, str]]
for field in fields:
if type_.__dataclass_fields__[field].metadata:
name = type_.__dataclass_fields__[field].metadata.get('name')
if name:
transforms.append((field, name))
# Do the needed name changes
if transforms:
value = value.copy()
for pyname, dataname in transforms:
if dataname in value:
tmp = value[dataname]
del value[dataname]
value[pyname] = tmp
necessary_fields = fields.difference(optional_fields)
try:
vfields = set(value.keys())
except AttributeError as e:
raise TypedloadAttributeError(str(e), value=value, type_=type_)
if necessary_fields.intersection(vfields) != necessary_fields:
raise TypedloadValueError(
'Value does not contain fields: %s which are necessary for type %s' % (
necessary_fields.difference(vfields),
type_
),
value=value,
type_=type_,
)
fieldsdiff = vfields.difference(fields)
if l.failonextra and len(fieldsdiff):
extra = ', '.join(fieldsdiff)
raise TypedloadValueError(
'Dictionary has unrecognized fields: %s and cannot be loaded into %s' % (extra, type_),
value=value,
type_=type_,
)
params = {}
for k, v in value.items():
if k not in fields:
continue
params[k] = l.load(
v,
type_hints[k],
annotation=Annotation(AnnotationType.FIELD, k),
)
return type_(**params)
def _unionload(l: Loader, value, type_) -> Any:
"""
Loads a value into a union.
Basically this iterates all the types inside the
union, until one that doesn't raise an exception
is found.
If no suitable type is found, an exception is raised.
"""
try:
args = uniontypes(type_)
except AttributeError:
raise TypedloadAttributeError('The typing API for this Python version is unknown')
value_type = type(value)
# Do not convert basic types, if possible
if value_type in args.intersection(l.basictypes):
return value
exceptions = []
# Give a score to the types
sorted_args = [] # type: List[Type]
for t in args:
if (value_type == list and is_list(t)) or \
(value_type == dict and is_dict(t)) or \
(value_type == frozenset and is_frozenset(t)) or \
(value_type == set and is_set(t)) or \
(value_type == tuple and is_tuple(t)):
sorted_args.insert(0, t)
else:
sorted_args.append(t)
# Try all types
for t in sorted_args:
try:
return l.load(value, t, annotation=Annotation(AnnotationType.UNION, t))
except Exception as e:
exceptions.append(e)
raise TypedloadValueError(
'Value could not be loaded into %s' % type_,
value=value,
type_=type_,
exceptions=exceptions
)
def _enumload(l: Loader, value, type_) -> Enum:
"""
This loads something into an Enum.
It tries with basic types first.
If that fails, it tries to look for type annotations inside the
Enum, and tries to use those to load the value into something
that is compatible with the Enum.
Of course if that fails too, a ValueError is raised.
"""
try:
# Try naïve conversion
return type_(value)
except:
pass
# Try with the typing hints
for _, t in get_type_hints(type_).items():
try:
return type_(l.load(value, t))
except:
pass
raise TypedloadValueError(
'Value could not be loaded into %s' % type_,
value=value,
type_=type_
)
def _noneload(l: Loader, value, type_) -> None:
"""
Loads a value that can only be None,
so it fails if it isn't
"""
if value is None:
return None
raise TypedloadValueError('Not None', value=value, type_=type_)
def _datetimeload(l: Loader, value, type_) -> Union[datetime.date, datetime.time, datetime.datetime]:
try:
return type_(*value)
except TypeError as e:
raise TypedloadTypeError(str(e))
def _attrload(l, value, type_):
if not isinstance(value, dict):
raise TypedloadTypeError('Expected dictionary, got %s' % type(value), type_=type_, value=value)
value = value.copy()
names = []
defaults = {}
types = {}
for attribute in type_.__attrs_attrs__:
names.append(attribute.name)
types[attribute.name] = attribute.type
defaults[attribute.name] = attribute.default
# Manage name mangling
if 'name' in attribute.metadata:
dataname = attribute.metadata['name']
pyname = attribute.name
if dataname in value:
tmp = value[dataname]
del value[dataname]
value[pyname] = tmp
t = _FakeNamedTuple((
tuple(names),
types,
defaults,
type_,
))
return _namedtupleload(l, value, t)
typedload/typedload/typechecks.py 0000644 0001750 0001750 00000013454 13610100170 016572 0 ustar salvo salvo """
typedload
Module to check types, mostly from the typing module.
For example is_list(List) and is_list(List[int])
return True.
It is not the same as isinstance(), it wants types, not instances.
It is expected that is_list(list) returns False, since it shouldn't be used for
type hints.
The module is useful because there is no public API to do those checks, and it
protects the user from the ever changing internal representation used in
different versions of Python.
"""
# Copyright (C) 2019 Salvo "LtWorf" Tomaselli
#
# typedload is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# author Salvo "LtWorf" Tomaselli
from enum import Enum
from typing import Any, Tuple, Union, Set, List, Dict, Type, FrozenSet
__all__ = [
'is_attrs',
'is_dataclass',
'is_dict',
'is_enum',
'is_forwardref',
'is_frozenset',
'is_list',
'is_literal',
'is_namedtuple',
'is_nonetype',
'is_set',
'is_tuple',
'is_union',
'is_typeddict',
'uniontypes',
'literalvalues',
'NONETYPE',
'HAS_TUPLEARGS',
'HAS_UNIONSUBCLASS',
]
try:
# Since 3.7
from typing import ForwardRef # type: ignore
except ImportError:
from typing import _ForwardRef as ForwardRef # type: ignore
try:
# Since 3.8
from typing import Literal, _TypedDictMeta # type: ignore
except ImportError:
Literal = None
_TypedDictMeta = None
def _issubclass(t1, t2) -> bool:
"""
Wrapper around _issubclass to circumvent python 3.7 changing API
"""
try:
return issubclass(t1, t2)
except TypeError:
return False
HAS_TUPLEARGS = hasattr(Tuple[int, int], '__args__')
NONETYPE = type(None) # type: Type[Any]
HAS_UNIONSUBCLASS = False
def is_tuple(type_: Type[Any]) -> bool:
'''
Tuple[int, str]
Tuple
'''
if HAS_TUPLEARGS:
# The tuple, Tuple thing is a difference between 3.6 and 3.7
# In 3.6 and before, Tuple had an __extra__ field, while Tuple[something]
# would have the normal __origin__ field.
#
# Those apply for Dict, List, Set, Tuple
return _generic_type_check(type_, tuple, Tuple)
else:
# Old python
return _issubclass(type_, Tuple) and _issubclass(type_, tuple) == False
def is_union(type_: Type[Any]) -> bool:
'''
Union[A, B]
Union
Optional[A]
'''
return getattr(type_, '__origin__', None) == Union
def is_nonetype(type_: Type[Any]) -> bool:
'''
type_ == type(None)
'''
return type_ == NONETYPE
def _generic_type_check(type_: Type[Any], native, from_typing):
return getattr(type_, '__origin__', None) in {native, from_typing} or getattr(type_, '__extra__', None) == native
def is_list(type_: Type[Any]) -> bool:
'''
List[A]
List
'''
return _generic_type_check(type_, list, List)
def is_dict(type_: Type[Any]) -> bool:
'''
Dict[A, B]
Dict
'''
return _generic_type_check(type_, dict, Dict)
def is_set(type_: Type[Any]) -> bool:
'''
Set[A]
Set
'''
return _generic_type_check(type_, set, Set)
def is_frozenset(type_: Type[Any]) -> bool:
'''
FrozenSet[A]
FrozenSet
'''
return _generic_type_check(type_, frozenset, FrozenSet)
def is_enum(type_: Type[Any]) -> bool:
'''
Check if the class is a subclass of Enum
'''
return _issubclass(type_, Enum)
def is_namedtuple(type_: Type[Any]) -> bool:
'''
Generated with typing.NamedTuple
'''
return _issubclass(type_, tuple) and hasattr(type_, '__annotations__') and hasattr(type_, '_fields')
def is_dataclass(type_: Type[Any]) -> bool:
'''
dataclass (Introduced in Python3.7
'''
return hasattr(type_, '__dataclass_fields__')
def is_forwardref(type_: Type[Any]) -> bool:
'''
Check if it's a ForwardRef.
They are unresolved types passed as strings, supposed to
be resolved into types at a later moment
'''
return type(type_) == ForwardRef
def is_attrs(type_: Type[Any]) -> bool:
'''
Check if the type is obtained with an
@attr.s decorator
'''
return hasattr(type_, '__attrs_attrs__')
def uniontypes(type_: Type[Any]) -> Set[Type[Any]]:
'''
Returns the types of a Union.
Raises ValueError if the argument is not a Union
and AttributeError when running on an unsupported
Python version.
'''
if not is_union(type_):
raise ValueError('Not a Union: ' + str(type_))
if hasattr(type_, '__args__'):
return set(type_.__args__)
elif hasattr(type_, '__union_params__'):
return set(type_.__union_params__)
raise AttributeError('The typing API for this Python version is unknown')
def literalvalues(type_: Type[Any]) -> Set[Any]:
'''
Returns the values of a Literal
Raises ValueError if the argument is not a Literal
'''
if not is_literal(type_):
raise ValueError('Not a Literal: ' + str(type_))
return set(type_.__args__)
def is_literal(type_: Type[Any]) -> bool:
'''
Check if the type is a typing.Literal
'''
return getattr(type_, '__origin__', None) == Literal and Literal != None
def is_typeddict(type_: Type[Any]) -> bool:
'''
Check if it is a typing.TypedDict
'''
if _TypedDictMeta:
return isinstance(type_, _TypedDictMeta)
return False