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
|
"""Example module
This is a description
"""
import asyncio
import collections.abc
import typing
from typing import ClassVar, Dict, Iterable, Generic, List, TypeVar, Union, overload
from example2 import B
T = TypeVar("T")
U = TypeVar("U")
software = "sphin'x"
more_software = 'sphinx"autoapi'
interesting_string = "interesting\"fun'\\'string"
code_snippet = """The following is some code:
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function, unicode_literals
# from future.builtins.disabled import *
# from builtins import *
print("chunky o'block")
"""
max_rating: int = 10
is_valid: bool
if max_rating > 100:
is_valid = False
else:
is_valid = True
ratings: List[int] = [0, 1, 2, 3, 4, 5]
rating_names: Dict[int, str] = {0: "zero", 1: "one"}
def f(start: int, end: int) -> Iterable[int]:
"This is f"
i = start
while i < end:
yield i
i += 1
mixed_list: List[Union[str, int]] = [1, "two", 3]
"This is mixed"
def f2(not_yet_a: "A") -> int: ...
def f3(imported: B) -> B: ...
class MyGeneric(Generic[T, U]): ...
@overload
def overloaded_func(a: float) -> float: ...
@typing.overload
def overloaded_func(a: str) -> str: ...
def overloaded_func(a: Union[float, str]) -> Union[float, str]:
"""Overloaded function"""
return a * 2
@overload
def undoc_overloaded_func(a: str) -> str: ...
def undoc_overloaded_func(a: str) -> str:
return a * 2
class A:
"""class A"""
is_an_a: ClassVar[bool] = True
not_assigned_to: ClassVar[str]
def __init__(self):
self.instance_var: bool = True
"""This is an instance_var."""
self.subobject: object = object()
self.subobject.subobject_variable = 1
local_variable_typed: int = 0
local_variable_untyped = 2
async def async_method(self, wait: bool) -> int:
if wait:
await asyncio.sleep(1)
return 5
@property
def my_prop(self) -> str:
"""My property."""
return "prop"
def my_method(self) -> str:
"""My method."""
return "method"
@overload
def overloaded_method(self, a: float) -> float: ...
@typing.overload
def overloaded_method(self, a: str) -> str: ...
def overloaded_method(self, a: Union[float, str]) -> Union[float, str]:
"""Overloaded method"""
return a * 2
@overload
def undoc_overloaded_method(self, a: float) -> float: ...
def undoc_overloaded_method(self, a: float) -> float:
return a * 2
@typing.overload
@classmethod
def overloaded_class_method(cls, a: float) -> float: ...
@overload
@classmethod
def overloaded_class_method(cls, a: str) -> str: ...
@classmethod
def overloaded_class_method(cls, a: Union[float, str]) -> Union[float, str]:
"""Overloaded class method"""
return a * 2
class C:
@overload
def __init__(self, a: int) -> None: ...
@typing.overload
def __init__(self, a: float) -> None: ...
def __init__(self, a: str): ...
class D(C):
class Da: ...
class DB(Da): ...
...
async def async_function(wait: bool) -> int:
"""Blah.
Args:
wait: Blah
"""
if wait:
await asyncio.sleep(1)
return 5
global_a: A = A()
class SomeMetaclass(type): ...
class MyException(Exception):
pass
class My123(collections.abc.Sequence):
def __getitem__(self, i):
if i < len(self):
return i
raise IndexError(i)
def __len__(self):
return 3
class InheritBaseError(Exception):
"""The base exception."""
def __init__(self):
self.my_message = "one"
"""My message."""
super().__init__(self.my_message)
class InheritError(InheritBaseError):
"""The middle exception."""
def __init__(self):
self.my_other_message = "two"
"""My other message."""
super().__init__()
class SubInheritError(InheritError):
"""The last exception."""
class DuplicateInheritError(InheritBaseError):
"""Not the base exception."""
def __init__(self):
self.my_message = "three"
super().__init__()
|