Coverage for tests/test_main.py: 100%

1import pickle 9 ctx1abcdefghi

2from typing import Annotated, get_type_hints 9 ctx1abcdefghi

3 

4from annotated_doc import Doc 9 ctx1abcdefghi

5 

6 

7def test_doc_basic() -> None: 9 ctx1abcdefghi

8 doc = Doc("This is a test documentation.") 9 ctx1jklmnopqr

9 assert doc.documentation == "This is a test documentation." 9 ctx1jklmnopqr

10 assert repr(doc) == "Doc('This is a test documentation.')" 9 ctx1jklmnopqr

11 assert hash(doc) == hash("This is a test documentation.") 9 ctx1jklmnopqr

12 assert doc == Doc("This is a test documentation.") 9 ctx1jklmnopqr

13 assert doc != Doc("Different documentation.") 9 ctx1jklmnopqr

14 assert doc != "Not a Doc instance" 9 ctx1jklmnopqr

15 

16 

17def test_annotation(): 9 ctx1abcdefghi

18 def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None: # pragma: no cover 9 ctx1stuvwxyzA

19 pass 

20 

21 hints = get_type_hints(hi, include_extras=True) 9 ctx1stuvwxyzA

22 doc_info: Doc = hints["name"].__metadata__[0] 9 ctx1stuvwxyzA

23 assert doc_info.documentation == "Who to say hi to" 9 ctx1stuvwxyzA

24 assert isinstance(doc_info, Doc) 9 ctx1stuvwxyzA

25 

26 

27def test_repr(): 9 ctx1abcdefghi

28 doc_info = Doc("Who to say hi to") 9 ctx123456789!

29 assert repr(doc_info) == "Doc('Who to say hi to')" 9 ctx123456789!

30 

31 

32def test_hashability(): 9 ctx1abcdefghi

33 doc_info = Doc("Who to say hi to") 9 ctx1TUVWXYZ01

34 assert isinstance(hash(doc_info), int) 9 ctx1TUVWXYZ01

35 assert hash(doc_info) != hash(Doc("Who not to say hi to")) 9 ctx1TUVWXYZ01

36 

37 

38def test_equality(): 9 ctx1abcdefghi

39 doc_info = Doc("Who to say hi to") 9 ctx1BCDEFGHIJ

40 # Equal to itself 

41 assert doc_info == doc_info 9 ctx1BCDEFGHIJ

42 # Equal to another instance with the same string 

43 assert doc_info == Doc("Who to say hi to") 9 ctx1BCDEFGHIJ

44 # Not equal to another instance with a different string 

45 assert doc_info != Doc("Who not to say hi to") 9 ctx1BCDEFGHIJ

46 

47 

48def test_pickle(): 9 ctx1abcdefghi

49 doc_info = Doc("Who to say hi to") 9 ctx1KLMNOPQRS

50 for proto in range(pickle.HIGHEST_PROTOCOL + 1): 9 ctx1KLMNOPQRS

51 pickled = pickle.dumps(doc_info, protocol=proto) 9 ctx1KLMNOPQRS

52 assert doc_info == pickle.loads(pickled) 9 ctx1KLMNOPQRS