1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
|
import abc
from ctypes import Structure
from dataclasses import dataclass
import functools
from functools import cached_property
from functools import lru_cache
import sched
from typing import Generic
from typing import TypeVar
# https://github.com/mitmproxy/pdoc/issues/226
class Descriptor:
def __init__(self, func):
self.__doc__ = func.__doc__
def __get__(self, instance, owner):
return self if instance is None else getattr(instance, "_x", 0)
def __set__(self, instance, value):
instance._x = value
class Issue226:
@Descriptor
def size(self):
"""This is the size"""
# Testing function and object default values
def default_func():
pass
default_obj = object()
var_with_default_obj = default_obj
"""this shouldn't render the object address"""
var_with_default_func = default_func
"""this just renders like a normal function"""
def func_with_defaults(a=default_obj, b=default_func):
"""this shouldn't render object or function addresses"""
pass
# Testing classmethod links in code
class ClassmethodLink:
"""
You can either do
>>> ClassmethodLink.bar()
42
or
```python
ClassmethodLink.bar()
```
neither will be linked.
"""
@classmethod
def bar(cls):
return 42
# Testing generic bases
T = TypeVar("T")
class GenericParent(Generic[T]):
"""GenericParent"""
class NonGenericChild(GenericParent[str]):
"""NonGenericChild"""
# Testing docstring inheritance
class Base:
def __init__(self):
"""init"""
super().__init__()
def foo(self):
"""foo"""
pass
@classmethod
def bar(cls):
"""bar"""
pass
@staticmethod
def baz():
"""baz"""
pass
@property
def qux(self):
"""qux"""
return
@cached_property
def quux(self):
"""quux"""
return
quuux: int = 42
"""quuux"""
class Child(Base):
def __init__(self):
super().__init__()
def foo(self):
pass
@classmethod
def bar(cls):
pass
@staticmethod
def baz():
pass
@property
def qux(self):
return
@cached_property
def quux(self):
return
quuux: int = 42
# Testing that an attribute that is only annotated does not trigger a "submodule not found" warning.
only_annotated: int
# Testing that a private class in __all__ is displayed
class _Private:
"""private class"""
pass
def _do(self):
"""private method"""
# Testing a class attribute that is a lambda (which generates quirky sources)
class LambdaAttr:
# not really supported, but also shouldn't crash.
attr = lambda x: 42 # noqa
# Testing different docstring annotations
# fmt: off
def foo():
"""no indents"""
def bar():
"""no
indents"""
def baz():
"""one
indent"""
def qux():
"""
two
indents
"""
class Indented:
def foo(self):
"""no indents"""
def bar(self):
"""no
indents"""
def baz(self):
"""one
indent"""
def qux(self):
"""
two
indents
"""
@lru_cache()
def foo_decorated(self):
"""no indents"""
@lru_cache()
# comment
def foo_commented(self):
"""no indents"""
@lru_cache()
def bar_decorated(self):
"""no
indents"""
@lru_cache()
def baz_decorated(self):
"""one
indent"""
@lru_cache()
def qux_decorated(self):
"""
two
indents
"""
@lru_cache(
maxsize=42
)
def quux_decorated(self):
"""multi-line decorator, https://github.com/mitmproxy/pdoc/issues/246"""
def _protected_decorator(f):
return f
@_protected_decorator
def fun_with_protected_decorator():
"""This function has a protected decorator (name starting with a single `_`)."""
class UnhashableDataDescriptor:
def __get__(self):
pass
__hash__ = None # type: ignore
unhashable = UnhashableDataDescriptor()
class AbstractClass(metaclass=abc.ABCMeta):
"""This class shouldn't show a constructor as it's abstract."""
@abc.abstractmethod
def foo(self):
pass
# Adapted from https://github.com/mitmproxy/pdoc/issues/320
def make_adder(a: int):
def add_func(b: int) -> int:
"""This function adds two numbers."""
return a + b
return add_func
add_four = make_adder(4)
add_five = make_adder(5)
"""This function adds five."""
add_six = make_adder(6)
add_six.__doc__ = "This function adds six."
# Adapted from https://github.com/mitmproxy/pdoc/issues/335
def linkify_links():
"""
This docstring contains links that are also identifiers:
- [`linkify_links`](https://example.com/)
- [misc.linkify_links](https://example.com/)
- [`linkify_links()`](https://example.com/)
- [misc.linkify_links()](https://example.com/)
- [link in target](https://example.com/misc.linkify_links)
- [explicit linking](#AbstractClass.foo)
"""
class Issue352aMeta(type):
def __call__(cls, *args, **kwargs):
"""Meta.__call__"""
class Issue352a(metaclass=Issue352aMeta):
def __init__(self):
"""Issue352.__init__ should be preferred over Meta.__call__."""
class Issue352bMeta(type):
def __call__(cls, *args, **kwargs):
pass
class Issue352b(metaclass=Issue352bMeta):
"""No docstrings for the constructor here."""
class CustomCallMeta(type):
def __call__(cls, *args, **kwargs):
"""Custom docstring in metaclass.`__call__`"""
class CustomCall(metaclass=CustomCallMeta):
"""A class where the constructor is defined by its metaclass."""
class Headings:
"""
# Heading 1
Here is some text.
## Heading 2
Here is some text.
### Heading 3
Here is some text.
#### Heading 4
Here is some text.
##### Heading 5
Here is some text.
###### Heading 6
Here is some text.
"""
class CustomRepr:
def __repr__(self):
return "°<script>alert(1)</script>"
def repr_not_syntax_highlightable(x=CustomRepr()):
"""The default value for x fails to highlight with pygments."""
class ClassDecorator:
"""This is a class that wraps a function. It will be documented correctly."""
def __init__(self, func):
self._func = func
@ClassDecorator
def another_decorated_function(arg: str) -> str:
"""This is another decorated function. It will not be documented correctly."""
raise NotImplementedError
class SubclassRef:
class SubClass:
pass
def __init__(self, x: "SubClass"):
print(x)
class ClassAsAttribute:
static_attr_to_class = ClassDecorator
"""this is a static attribute that point to a Class (not an instance)"""
static_attr_to_instance = ClassDecorator(None)
"""this is a static attribute that point to an instance"""
class scheduler(sched.scheduler):
"""Test for broken links for inherited methods, https://github.com/mitmproxy/pdoc/issues/490"""
class __init__:
"""https://github.com/mitmproxy/pdoc/issues/519"""
def dynamically_modify_docstring1():
"""this should **not** be the docstring."""
def dynamically_modify_docstring2():
pass
dynamically_modify_docstring1.__doc__ = "https://github.com/mitmproxy/pdoc/issues/536"
dynamically_modify_docstring2.__doc__ = "https://github.com/mitmproxy/pdoc/issues/536"
def _docstring_modifier(fn):
fn.__doc__ = "https://github.com/mitmproxy/pdoc/issues/536"
return fn
@_docstring_modifier
def dynamically_modify_docstring3():
"""This should **not** be the docstring."""
@_docstring_modifier
def dynamically_modify_docstring4():
pass
class DocstringFromNew:
def __new__(cls, *args, **kwargs):
"""This is a class with a docstring inferred from `__new__`."""
class SingleDispatchMethodExample:
@functools.singledispatchmethod
def fancymethod(self, str_or_int: str | int):
"""A fancy method which is capable of handling either `str` or `int`.
:param str_or_int: string or integer to handle
"""
raise NotImplementedError(f"{type(str_or_int)=} not implemented!")
@fancymethod.register
def fancymethod_handle_str(self, str_to_handle: str):
"""Fancy method handles a string.
:param str_to_handle: string which will be handled
"""
print(f"{type(str_to_handle)} = '{str_to_handle}")
@fancymethod.register
def _fancymethod_handle_int(self, int_to_handle: int):
"""Fancy method handles int (not shown in doc).
:param int_to_handle: int which will be handled
"""
print(f"{type(int_to_handle)} = '{int_to_handle:x}'")
@dataclass(init=False)
class DataclassStructure(Structure):
"""DataclassStructure raises for `inspect.signature`."""
class MötörCrüe:
"A fictional band with Unicode-characters in its name."
def créer_naïveté(self):
"A function with Unicode-characters in its name."
def link_to_unicode():
"""The following link should be created properly:
- `MötörCrüe.créer_naïveté`
"""
__all__ = [
"Issue226",
"var_with_default_obj",
"var_with_default_func",
"func_with_defaults",
"ClassmethodLink",
"GenericParent",
"NonGenericChild",
"Child",
"only_annotated",
"_Private",
"LambdaAttr",
"foo",
"bar",
"baz",
"qux",
"Indented",
"fun_with_protected_decorator",
"unhashable",
"AbstractClass",
"add_four",
"add_five",
"add_six",
"linkify_links",
"Issue352a",
"Issue352b",
"CustomCall",
"Headings",
"repr_not_syntax_highlightable",
"ClassDecorator",
"another_decorated_function",
"SubclassRef",
"ClassAsAttribute",
"scheduler",
"__init__",
"dynamically_modify_docstring1",
"dynamically_modify_docstring2",
"dynamically_modify_docstring3",
"dynamically_modify_docstring4",
"DocstringFromNew",
"SingleDispatchMethodExample",
"DataclassStructure",
"MötörCrüe",
"link_to_unicode",
]
|