Coverage for src/annotated_doc/main.py: 100%

1class Doc: 9 ctx1abnocpqdr

2 """Define the documentation of a type annotation using `Annotated`, to be 

3 used in class attributes, function and method parameters, return values, 

4 and variables. 

5 

6 The value should be a positional-only string literal to allow static tools 

7 like editors and documentation generators to use it. 

8 

9 This complements docstrings. 

10 

11 The string value passed is available in the attribute `documentation`. 

12 

13 Example: 

14 

15 ```Python 

16 from typing import Annotated 

17 from annotated_doc import Doc 

18 

19 def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None: 

20 print(f"Hi, {name}!") 

21 ``` 

22 """ 

23 

24 def __init__(self, documentation: str, /) -> None: 9 ctx1abnocpqdr

25 self.documentation = documentation 58 ctx1aKesLtMbNfuOvPQgwRxSThyUzVcWiAXBYZjC0D12kE3F4d5lG6H78mI9J!

26 

27 def __repr__(self) -> str: 9 ctx1abnocpqdr

28 return f"Doc({self.documentation!r})" 18 ctx1eMfPgShViYj1k4l7m!

29 

30 def __hash__(self) -> int: 9 ctx1abnocpqdr

31 return hash(self.documentation) 31 ctx1aKeLbNfOQgRThUcWiXZj02k3d5l68m9

32 

33 def __eq__(self, other: object) -> bool: 9 ctx1abnocpqdr

34 if not isinstance(other, Doc): 31 ctx1aestbfuvgwxhyzciABjCDkEFdlGHmIJ

35 return NotImplemented 9 ctx1efghijklm

36 return self.documentation == other.documentation 31 ctx1aestbfuvgwxhyzciABjCDkEFdlGHmIJ