tf.contrib.framework.deprecated_args
Stay organized with collections
Save and categorize content based on your preferences.
Decorator for marking specific function arguments as deprecated.
tf.contrib.framework.deprecated_args(
date, instructions, *deprecated_arg_names_or_tuples, **kwargs
)
This decorator logs a deprecation warning whenever the decorated function is
called with the deprecated argument. It has the following format:
Calling (from ) with is deprecated and will be
removed after . Instructions for updating:
If date is None, 'after ' is replaced with 'in a future version'.
includes the class name if it is a method.
It also edits the docstring of the function: ' (deprecated arguments)' is
appended to the first line of the docstring and a deprecation notice is
prepended to the rest of the docstring.
Args |
|---|
date
|
String or None. The date the function is scheduled to be removed.
Must be ISO 8601 (YYYY-MM-DD), or None.
|
instructions
|
String. Instructions on how to update code using the
deprecated function.
|
*deprecated_arg_names_or_tuples
|
String or 2-Tuple(String,
[ok_vals]). The string is the deprecated argument name.
Optionally, an ok-value may be provided. If the user provided
argument equals this value, the warning is suppressed.
|
**kwargs
|
If warn_once=False is passed, every call with a deprecated
argument will log a warning. The default behavior is to only warn the
first time the function is called with any given deprecated argument.
All other kwargs raise ValueError.
|
Returns |
|---|
|
Decorated function or method.
|
Raises |
|---|
ValueError
|
If date is not None or in ISO 8601 format, instructions are
empty, the deprecated arguments are not present in the function
signature, the second element of a deprecated_tuple is not a
list, or if a kwarg other than warn_once is passed.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.contrib.framework.deprecated_args\n\n\u003cbr /\u003e\n\n|--------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/util/deprecation.py#L336-L513) |\n\nDecorator for marking specific function arguments as deprecated. \n\n tf.contrib.framework.deprecated_args(\n date, instructions, *deprecated_arg_names_or_tuples, **kwargs\n )\n\nThis decorator logs a deprecation warning whenever the decorated function is\ncalled with the deprecated argument. It has the following format:\n\nCalling (from ) with is deprecated and will be removed after . Instructions for updating:\n\nIf `date` is None, 'after ' is replaced with 'in a future version'. includes the class name if it is a method.\n\nIt also edits the docstring of the function: ' (deprecated arguments)' is\nappended to the first line of the docstring and a deprecation notice is\nprepended to the rest of the docstring.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None. |\n| `instructions` | String. Instructions on how to update code using the deprecated function. |\n| `*deprecated_arg_names_or_tuples` | String or 2-Tuple(String, \\[ok_vals\\]). The string is the deprecated argument name. Optionally, an ok-value may be provided. If the user provided argument equals this value, the warning is suppressed. |\n| `**kwargs` | If `warn_once=False` is passed, every call with a deprecated argument will log a warning. The default behavior is to only warn the first time the function is called with any given deprecated argument. All other kwargs raise `ValueError`. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| Decorated function or method. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | If date is not None or in ISO 8601 format, instructions are empty, the deprecated arguments are not present in the function signature, the second element of a deprecated_tuple is not a list, or if a kwarg other than `warn_once` is passed. |\n\n\u003cbr /\u003e"]]
View source on GitHub