ansible/docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst

:orphan:

boilerplate
===========

Most Python files should include the following boilerplate:

.. code-block:: python

    from __future__ import (absolute_import, division, print_function)
    __metaclass__ = type
Split the metaclass == type and from future boilerplate code. The metaclass boilerplate is safe to apply en masse. The future import boilerplate needs code to be inspected to be sure that there aren't any py2isms that need to be fixed. Split these two checks so that we can fix them independently Be explicit about which files are grandfathered so we can fix them up one by one 2019-07-02 18:36:37 +02:00			`:orphan:`

Remove redundant "Sanity Tests »" from page title. The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant. 2019-07-26 17:51:09 +02:00			`boilerplate`
			`===========`
Initial ansible-test sanity docs. (#26775) * Rename no-iterkeys test for consistency. * Require docs for all ansible-test sanity tests. * Initial ansible-test sanity docs. * Fix capitalization of Python. * Fix sanity code smell test false positives. * Fix another code-smell false positive. 2017-07-14 15:24:45 +02:00
code-smell test changes * Create get_exception and wildcard import code-smell tests * Add more detail to boilerplate and no-basestring descriptions * Remove the no-list-cmp test as the pylint undefined-variable test covers it 2017-08-02 01:18:27 +02:00			`Most Python files should include the following boilerplate:`
Initial ansible-test sanity docs. (#26775) * Rename no-iterkeys test for consistency. * Require docs for all ansible-test sanity tests. * Initial ansible-test sanity docs. * Fix capitalization of Python. * Fix sanity code smell test false positives. * Fix another code-smell false positive. 2017-07-14 15:24:45 +02:00
			`.. code-block:: python`

			`from __future__ import (absolute_import, division, print_function)`
			`__metaclass__ = type`