Загрузить файлы в «venv/Lib/site-packages/annotated_doc»
This commit is contained in:
3
venv/Lib/site-packages/annotated_doc/__init__.py
Normal file
3
venv/Lib/site-packages/annotated_doc/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
from .main import Doc as Doc
|
||||||
|
|
||||||
|
__version__ = "0.0.4"
|
||||||
36
venv/Lib/site-packages/annotated_doc/main.py
Normal file
36
venv/Lib/site-packages/annotated_doc/main.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
class Doc:
|
||||||
|
"""Define the documentation of a type annotation using `Annotated`, to be
|
||||||
|
used in class attributes, function and method parameters, return values,
|
||||||
|
and variables.
|
||||||
|
|
||||||
|
The value should be a positional-only string literal to allow static tools
|
||||||
|
like editors and documentation generators to use it.
|
||||||
|
|
||||||
|
This complements docstrings.
|
||||||
|
|
||||||
|
The string value passed is available in the attribute `documentation`.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from typing import Annotated
|
||||||
|
from annotated_doc import Doc
|
||||||
|
|
||||||
|
def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None:
|
||||||
|
print(f"Hi, {name}!")
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, documentation: str, /) -> None:
|
||||||
|
self.documentation = documentation
|
||||||
|
|
||||||
|
def __repr__(self) -> str:
|
||||||
|
return f"Doc({self.documentation!r})"
|
||||||
|
|
||||||
|
def __hash__(self) -> int:
|
||||||
|
return hash(self.documentation)
|
||||||
|
|
||||||
|
def __eq__(self, other: object) -> bool:
|
||||||
|
if not isinstance(other, Doc):
|
||||||
|
return NotImplemented
|
||||||
|
return self.documentation == other.documentation
|
||||||
BIN
venv/Lib/site-packages/annotated_doc/py.typed
Normal file
BIN
venv/Lib/site-packages/annotated_doc/py.typed
Normal file
Binary file not shown.
Reference in New Issue
Block a user