module documentation
Support for twisted.python.deprecate
.
Class |
|
No class docstring; 2/2 methods documented |
Function | deprecated |
Change a @deprecated to a display string. |
Function | get |
With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator. |
Function | setup |
Undocumented |
Function | version |
Change an AST Version() to a real one. |
Variable | _deprecated |
Undocumented |
Variable | _deprecation |
Undocumented |
Variable | _deprecation |
Undocumented |
Variable | _incremental_ |
Undocumented |
def deprecatedToUsefulText(ctx:
model.Documentable
, name: str
, deprecated: ast.Call
) -> Tuple[ str, str]
:
(source)
¶
Change a @deprecated to a display string.
Parameters | |
ctx:model.Documentable | The context in which the deprecation is evaluated. |
name:str | The name of the thing we're deprecating. |
deprecated:ast.Call | AST call to twisted.python.deprecate.deprecated or twisted.python.deprecate.deprecatedProperty . |
Returns | |
Tuple[ | The version and text to use in the deprecation warning. |
Raises | |
ValueError or TypeError | If something is wrong. |
With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.
Change an AST Version() to a real one.
Raises | |
ValueError | If the incremental.Version call is invalid. |
Note | |
Only use required arguments, ignores arguments release_candidate, prerelease, post, dev. |