summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst')
-rw-r--r--docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst
new file mode 100644
index 0000000..fdaf07b
--- /dev/null
+++ b/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst
@@ -0,0 +1,31 @@
+:orphan:
+
+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()