| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module telemetry.decorators</title> |
| <meta charset="utf-8"> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.decorators</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/decorators.py">telemetry/decorators.py</a></font></td></tr></table> |
| <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br> |
| # Use of this source code is governed by a BSD-style license that can be<br> |
| # found in the LICENSE file.<br> |
| # pylint: disable=W0212</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="datetime.html">datetime</a><br> |
| <a href="functools.html">functools</a><br> |
| </td><td width="25%" valign=top><a href="inspect.html">inspect</a><br> |
| <a href="os.html">os</a><br> |
| </td><td width="25%" valign=top><a href="types.html">types</a><br> |
| <a href="warnings.html">warnings</a><br> |
| </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="telemetry.decorators.html#Deprecated">Deprecated</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Deprecated">class <strong>Deprecated</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Deprecated-__call__"><strong>__call__</strong></a>(self, target)</dt></dl> |
| |
| <dl><dt><a name="Deprecated-__init__"><strong>__init__</strong></a>(self, year, month, day, extra_guidance<font color="#909090">=''</font>)</dt></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#eeaa77"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt><a name="-Cache"><strong>Cache</strong></a>(obj)</dt><dd><tt>Decorator for caching read-only properties.<br> |
| <br> |
| Example usage (always returns the same Foo instance):<br> |
| @Cache<br> |
| def CreateFoo():<br> |
| return Foo()<br> |
| <br> |
| If CreateFoo() accepts parameters, a separate cached value is maintained<br> |
| for each unique parameter combination.<br> |
| <br> |
| Cached methods maintain their cache for the lifetime of the /instance/, while<br> |
| cached functions maintain their cache for the lifetime of the /module/.</tt></dd></dl> |
| <dl><dt><a name="-Disabled"><strong>Disabled</strong></a>(*args)</dt><dd><tt>Decorator for disabling tests/benchmarks.<br> |
| <br> |
| <br> |
| If args are given, the test will be disabled if ANY of the args match the<br> |
| browser type, OS name or OS version:<br> |
| @<a href="#-Disabled">Disabled</a>('canary') # Disabled for canary browsers<br> |
| @<a href="#-Disabled">Disabled</a>('win') # Disabled on Windows.<br> |
| @<a href="#-Disabled">Disabled</a>('win', 'linux') # Disabled on both Windows and Linux.<br> |
| @<a href="#-Disabled">Disabled</a>('mavericks') # Disabled on Mac Mavericks (10.9) only.<br> |
| @<a href="#-Disabled">Disabled</a>('all') # Unconditionally disabled.</tt></dd></dl> |
| <dl><dt><a name="-Enabled"><strong>Enabled</strong></a>(*args)</dt><dd><tt>Decorator for enabling tests/benchmarks.<br> |
| <br> |
| The test will be enabled if ANY of the args match the browser type, OS name<br> |
| or OS version:<br> |
| @<a href="#-Enabled">Enabled</a>('canary') # Enabled only for canary browsers<br> |
| @<a href="#-Enabled">Enabled</a>('win') # Enabled only on Windows.<br> |
| @<a href="#-Enabled">Enabled</a>('win', 'linux') # Enabled only on Windows or Linux.<br> |
| @<a href="#-Enabled">Enabled</a>('mavericks') # Enabled only on Mac Mavericks (10.9).</tt></dd></dl> |
| <dl><dt><a name="-IsEnabled"><strong>IsEnabled</strong></a>(test, possible_browser)</dt><dd><tt>Returns True iff |test| is enabled given the |possible_browser|.<br> |
| <br> |
| Use to respect the @Enabled / @Disabled decorators.<br> |
| <br> |
| Args:<br> |
| test: A function or class that may contain _disabled_strings and/or<br> |
| _enabled_strings attributes.<br> |
| possible_browser: A PossibleBrowser to check whether |test| may run against.</tt></dd></dl> |
| <dl><dt><a name="-Isolated"><strong>Isolated</strong></a>(*args)</dt><dd><tt>Decorator for noting that tests must be run in isolation.<br> |
| <br> |
| The test will be run by itself (not concurrently with any other tests)<br> |
| if ANY of the args match the browser type, OS name, or OS version.</tt></dd></dl> |
| <dl><dt><a name="-ShouldBeIsolated"><strong>ShouldBeIsolated</strong></a>(test, possible_browser)</dt></dl> |
| <dl><dt><a name="-ShouldSkip"><strong>ShouldSkip</strong></a>(test, possible_browser)</dt><dd><tt>Returns whether the test should be skipped and the reason for it.</tt></dd></dl> |
| </td></tr></table> |
| </body></html> |
