mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
4264be2b18
* orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task
31 lines
871 B
ReStructuredText
31 lines
871 B
ReStructuredText
:orphan:
|
|
|
|
Sanity Tests » no-wildcard-import
|
|
=================================
|
|
|
|
Using :code:`import *` is a bad habit which pollutes your namespace, hinders
|
|
debugging, and interferes with static analysis of code. For those reasons, we
|
|
do want to limit the use of :code:`import *` in the ansible code. Change our
|
|
code to import the specific names that you need instead.
|
|
|
|
Examples of unfixed code:
|
|
|
|
.. code-block:: python
|
|
|
|
from ansible.module_utils.six import *
|
|
if isinstance(variable, string_types):
|
|
do_something(variable)
|
|
|
|
from ansible.module_utils.basic import *
|
|
module = AnsibleModule()
|
|
|
|
Examples of fixed code:
|
|
|
|
.. code-block:: python
|
|
|
|
from ansible.module_utils import six
|
|
if isinstance(variable, six.string_types):
|
|
do_something(variable)
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
module = AnsibleModule()
|