cli2 3.4.0__tar.gz → 4.0.1__tar.gz

cli2-4.0.1/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.2
+Name: cli2
+Version: 4.0.1
+Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
+Home-page: https://yourlabs.io/oss/cli2
+Author: James Pic
+Author-email: jamespic@gmail.com
+License: MIT
+Keywords: cli
+Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
+Requires-Dist: docstring_parser
+Requires-Dist: pyyaml
+Requires-Dist: pygments
+Requires-Dist: structlog
+Provides-Extra: client
+Requires-Dist: httpx; extra == "client"
+Requires-Dist: truststore; extra == "client"
+Provides-Extra: test
+Requires-Dist: freezegun; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-httpx; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+.. image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
+   :target: https://yourlabs.io/oss/cli2/pipelines
+.. image:: https://codecov.io/gh/yourlabs/cli2/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/yourlabs/cli2
+.. image:: https://img.shields.io/pypi/v/cli2.svg
+   :target: https://pypi.python.org/pypi/cli2
+
+cli2: Python Automation Framework
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A Python command line and Ansible Action plugin framework that loves meta
+programming: do less and get more out of it, perfect for many kinds of DevOps
+gigs to automate everything.
+
+Batteries included, all of which are useful on their own:
+
+- beautiful CLI alternative to click, but much less verbose, allowing more
+  creative design patterns without any boilerplate thanks to introspection
+- which comes with a Sphinx extension to extensively document your CLIs
+- magic 12-factor configuration library
+- extremely beautiful structlog configuration for colorful and readable logging
+- httpx client wrapper that handles all kind of retries, data masking...
+- magic ORM for HTTP resources based on that client
+- Ansible Action plugin library with all the beautiful logging and a rich
+  testing library so that you can go straight to the point in pytest
+- a good old fcntl based locking
+- a command line to run any python function over a beautiful CLI
+
+`Documentation available on RTFD <https://cli2.rtfd.io>`_.

cli2-4.0.1/README.rst

@@ -0,0 +1,29 @@
+.. image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
+   :target: https://yourlabs.io/oss/cli2/pipelines
+.. image:: https://codecov.io/gh/yourlabs/cli2/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/yourlabs/cli2
+.. image:: https://img.shields.io/pypi/v/cli2.svg
+   :target: https://pypi.python.org/pypi/cli2
+
+cli2: Python Automation Framework
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A Python command line and Ansible Action plugin framework that loves meta
+programming: do less and get more out of it, perfect for many kinds of DevOps
+gigs to automate everything.
+
+Batteries included, all of which are useful on their own:
+
+- beautiful CLI alternative to click, but much less verbose, allowing more
+  creative design patterns without any boilerplate thanks to introspection
+- which comes with a Sphinx extension to extensively document your CLIs
+- magic 12-factor configuration library
+- extremely beautiful structlog configuration for colorful and readable logging
+- httpx client wrapper that handles all kind of retries, data masking...
+- magic ORM for HTTP resources based on that client
+- Ansible Action plugin library with all the beautiful logging and a rich
+  testing library so that you can go straight to the point in pytest
+- a good old fcntl based locking
+- a command line to run any python function over a beautiful CLI
+
+`Documentation available on RTFD <https://cli2.rtfd.io>`_.

cli2-4.0.1/cli2/__init__.py

@@ -0,0 +1,42 @@
+# flake8: noqa
+from .cli import (
+    cmd,
+    arg,
+    hide,
+    retrieve,
+    Argument,
+    Command,
+    Group,
+    EntryPoint,
+)
+from .asyncio import async_resolve
+from .colors import colors as c
+
+from .configuration import Configuration, cfg
+try:
+    from .client import (
+        ClientError,
+        ResponseError,
+        TokenGetError,
+        RefusedResponseError,
+        RetriesExceededError,
+        FieldError,
+        FieldValueError,
+        FieldExternalizeError,
+        Client,
+        DateTimeField,
+        Field,
+        Handler,
+        JSONStringField,
+        Model,
+        Paginator,
+        Related,
+    )
+except ImportError:
+    raise
+    # httpx not installed
+    pass
+from .display import diff, diff_data, render, print, highlight
+from .lock import Lock
+from .log import configure, log, get_logger
+from .table import Table

cli2-4.0.1/cli2/ansible/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+from .action import (
+    ansi_escape,
+    Option,
+    AnsibleError,
+    AnsibleOptionError,
+    ActionBase,
+)

cli2-3.4.0/cli2/ansible.py → cli2-4.0.1/cli2/ansible/action.py

@@ -1,19 +1,14 @@
 """
 Experimental: my base class for Ansible actions.
-
-TODO: Turn this into a cool framework.
 """
 
 import asyncio
 import cli2
 import copy
-import mock
 import os
 import re
 import traceback
 
-from cli2 import logging
-
 from ansible.plugins.action import ActionBase
 
 # colors:
@@ -154,14 +149,12 @@ class ActionBase(ActionBase):
     async def run_wrapped_async(self):
         self.verbosity = self.task_vars.get('ansible_verbosity', 0)
 
-        if 'LOG_LEVEL' in os.environ or 'DEBUG' in os.environ:
-            logging.configure()
-        else:
+        if 'LOG_LEVEL' not in os.environ and 'DEBUG' not in os.environ:
             if self.verbosity == 1:
                 os.environ['LOG_LEVEL'] = 'INFO'
             elif self.verbosity >= 2:
                 os.environ['LOG_LEVEL'] = 'DEBUG'
-            logging.configure()
+            cli2.configure()
 
         try:
             try:
@@ -174,6 +167,18 @@ class ActionBase(ActionBase):
 
             if isinstance(exc, AnsibleError):
                 self.result['error'] = exc.message
+            elif isinstance(exc, cli2.ResponseError):
+                self.result.update(dict(
+                    method=exc.method,
+                    url=exc.url,
+                    status_code=exc.status_code,
+                ))
+                key, value = self.client.response_log_data(exc.response)
+                if key:
+                    self.result[f'response_{key}'] = value
+                key, value = self.client.request_log_data(exc.request)
+                if key:
+                    self.result[f'request_{key}'] = value
             elif self.verbosity:
                 traceback.print_exc()
 
@@ -232,6 +237,7 @@ class ActionBase(ActionBase):
         :param client: Client instance, overrides the factory
         :param fail: Allow this test to fail without exception
         """
+        import mock
         obj = cls(*[mock.Mock()] * 6)
         obj.tmp = None
         obj.task_vars = mock.Mock()
@@ -265,9 +271,21 @@ class ActionBase(ActionBase):
         self._after_data = UNSET_DEFAULT
 
     def before_set(self, data, label='before'):
+        """
+        Set the data we're going to display the diff for at the end.
+
+        :param data: Dictionnary of data
+        :param label: Label to show in diff
+        """
         self._before_data = copy.deepcopy(data)
         self._before_label = label
 
     def after_set(self, data, label='after'):
+        """
+        Set the data we're going to display the diff for at the end.
+
+        :param data: Dictionnary of data
+        :param label: Label to show in diff
+        """
         self._after_data = copy.deepcopy(data)
         self._after_label = label

cli2-3.4.0/cli2/pytest_ansible.py → cli2-4.0.1/cli2/ansible/playbook.py

@@ -1,6 +1,5 @@
 import copy
 import os
-import pytest
 import re
 import shlex
 import shutil
@@ -214,8 +213,3 @@ class Playbook:
         if not exception:
             check_ansible_output_for_exception(result['exception'])
         return result
-
-
-@pytest.fixture
-def playbook(tmp_path, request):
-    return Playbook(tmp_path, name=request.node.originalname)

cli2-4.0.1/cli2/ansible/pytest.py

@@ -0,0 +1,7 @@
+import pytest
+from .playbook import Playbook
+
+
+@pytest.fixture
+def playbook(tmp_path, request):
+    return Playbook(tmp_path, name=request.node.originalname)