tf.contrib.framework.deprecated_arg_values
Stay organized with collections
Save and categorize content based on your preferences.
Decorator for marking specific function argument values as deprecated.
tf.contrib.framework.deprecated_arg_values(
date, instructions, warn_once=True, **deprecated_kwargs
)
This decorator logs a deprecation warning whenever the decorated function is
called with the deprecated argument values. 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'.
will include 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.
|
warn_once
|
If True, warn only the first time this function is called with
deprecated argument values. Otherwise, every call (with a deprecated
argument value) will log a warning.
|
**deprecated_kwargs
|
The deprecated argument values.
|
Returns |
|---|
|
Decorated function or method.
|
Raises |
|---|
ValueError
|
If date is not None or in ISO 8601 format, or instructions are
empty.
|
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_arg_values\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#L516-L580) |\n\nDecorator for marking specific function argument values as deprecated. \n\n tf.contrib.framework.deprecated_arg_values(\n date, instructions, warn_once=True, **deprecated_kwargs\n )\n\nThis decorator logs a deprecation warning whenever the decorated function is\ncalled with the deprecated argument values. 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'. will include 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| `warn_once` | If `True`, warn only the first time this function is called with deprecated argument values. Otherwise, every call (with a deprecated argument value) will log a warning. |\n| `**deprecated_kwargs` | The deprecated argument values. |\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, or instructions are empty. |\n\n\u003cbr /\u003e"]]
View source on GitHub