cli2 4.0.7__tar.gz → 4.0.10__tar.gz

{cli2-4.0.7/cli2.egg-info → cli2-4.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cli2
-Version: 4.0.7
+Version: 4.0.10
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-4.0.7 → cli2-4.0.10}/cli2/__init__.py

@@ -38,7 +38,7 @@ except ImportError:
     pass
 from .display import diff, diff_data, render, print, highlight
 from .lock import Lock
-from .log import configure, log, get_logger
+from .log import configure, log
 from .table import Table
 
 

{cli2-4.0.7 → cli2-4.0.10}/cli2/client.py

@@ -10,7 +10,6 @@ import json
 import math
 import os
 import ssl
-import structlog
 import yaml
 
 from datetime import datetime
@@ -26,6 +25,7 @@ from . import display
 from .asyncio import async_resolve
 from .cli import Command, Group, cmd, hide
 from .colors import colors
+from .log import log
 
 
 class Paginator:
@@ -690,6 +690,7 @@ class ModelMetaclass(type):
     def __new__(cls, name, bases, attributes):
         if 'Paginator' in attributes:
             attributes['paginator'] = attributes['Paginator']
+
         cls = super().__new__(cls, name, bases, attributes)
         client = getattr(cls, 'client', None)
         if client:
@@ -700,11 +701,6 @@ class ModelMetaclass(type):
         client_class = getattr(cls, '_client_class', None)
         if client_class:
             client_class.models.append(cls)
-            client_cli = getattr(client_class, 'cli', None)
-            if client_cli:
-                group = ModelGroup(cls)
-                if len(group) > 1:
-                    cls.cli = client_cli[cls.__name__.lower()] = group
 
         cls._fields = dict()
 
@@ -939,6 +935,8 @@ class Model(metaclass=ModelMetaclass):
 
 
 class ClientMetaclass(type):
+    cli_kwargs = dict()
+
     def __new__(cls, name, bases, attributes):
         if 'Paginator' in attributes:
             attributes['paginator'] = attributes['Paginator']
@@ -947,22 +945,29 @@ class ClientMetaclass(type):
         # bind ourself as _client_class to any inherited model
         cls.Model = type('Model', (Model,), dict(_client_class=cls))
         cls.models = []
-
-        cli_kwargs = dict(
-            name=cls.__name__.lower().replace('client', '') or 'client',
-            doc=inspect.getdoc(cls),
-            overrides=dict(
-                cls=dict(factory=lambda: cls),
-                self=dict(factory=lambda: cls())
-            ),
-        )
-        if new_kwargs := getattr(cls, 'cli2', None):
-            cli_kwargs.update(new_kwargs)
-        cli_kwargs.update(cls.__dict__.get('cli_kwargs', dict()))
-        cls.cli = Group(**cli_kwargs)
-        cls.cli.load(cls)
         return cls
 
+    @property
+    def cli(cls):
+        if '_cli' not in cls.__dict__:
+            cli_kwargs = dict(
+                name=cls.__name__.lower().replace('client', '') or 'client',
+                doc=inspect.getdoc(cls),
+                overrides=dict(
+                    cls=dict(factory=lambda: cls),
+                    self=dict(factory=lambda: cls())
+                ),
+            )
+            cli_kwargs.update(cls.cli_kwargs)
+            cli = Group(**cli_kwargs)
+            cli.load(cls)
+            for model in cls.models:
+                group = ModelGroup(model)
+                if len(group) > 1:
+                    cli[model.__name__.lower()] = group
+            cls._cli = cli
+        return cls._cli
+
 
 class Handler:
     """
@@ -1024,11 +1029,14 @@ class Handler:
         self.backoff = self.backoff_default if backoff is None else backoff
 
     async def __call__(self, client, response, tries, mask, log):
+        seconds = tries * self.backoff
+
         if isinstance(response, Exception):
             if tries >= self.tries:
                 raise response
             # httpx session is rendered unusable after a TransportError
             if isinstance(response, httpx.TransportError):
+                await asyncio.sleep(seconds)
                 log.warn('reconnect', error=repr(response))
                 await client.client_reset()
             return
@@ -1045,7 +1053,6 @@ class Handler:
         if tries >= self.tries:
             raise RetriesExceededError(client, response, tries, mask)
 
-        seconds = tries * self.backoff
         kwargs = dict(
             status_code=response.status_code,
             tries=tries,
@@ -1209,8 +1216,10 @@ class Client(metaclass=ClientMetaclass):
     .. py:attribute:: cli
 
         Generated :py:class:`~cli2.cli.Group` for this client.
+        Uses :py:attr:`cli_kwargs` to pass kwargs to the generated group.
+        Note that this is a cached property.
 
-    .. py:attribute:: cli2
+    .. py:attribute:: cli_kwargs
 
         Dict of overrides for the generated :py:class:`~cli2.cli.Group`.
         Example:
@@ -1218,7 +1227,7 @@ class Client(metaclass=ClientMetaclass):
         .. code-block:: python
 
             class YourClient(cli2.Client):
-                cli2 = dict(cmdclass=YourCommandClass)
+                cli_kwargs = dict(cmdclass=YourCommandClass)
 
     .. py:attribute:: debug
 
@@ -1256,7 +1265,6 @@ class Client(metaclass=ClientMetaclass):
                 truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT),
             )
 
-        self.logger = structlog.get_logger('cli2')
         self.token_getting = False
         self.token = None
 
@@ -1493,13 +1501,13 @@ class Client(metaclass=ClientMetaclass):
             extensions=extensions,
         )
 
-        log = self.logger.bind(method=method, url=str(request.url))
+        _log = log.bind(method=method, url=str(request.url))
         if not quiet or self.debug:
             key, value = self.request_log_data(request, mask, quiet)
             kwargs = dict()
             if value:
                 kwargs[key] = value
-            log.debug('request', **kwargs)
+            _log.debug('request', **kwargs)
 
         response = await self.send(
             request,
@@ -1512,13 +1520,13 @@ class Client(metaclass=ClientMetaclass):
             follow_redirects=follow_redirects,
         )
 
-        _log = dict(status_code=response.status_code)
+        kwargs = dict(status_code=response.status_code)
         if not quiet or self.debug:
             key, value = self.response_log_data(response, mask)
             if value:
-                _log[key] = value
+                kwargs[key] = value
 
-        log.info('response', **_log)
+        _log.info('response', **kwargs)
 
         return response
 

{cli2-4.0.7 → cli2-4.0.10}/cli2/log.py

@@ -70,9 +70,6 @@ class YAMLFormatter:
         return '\n' + value
 
 
-configured = False
-
-
 def configure():
     LOG_LEVEL = os.getenv('LOG_LEVEL', 'WARNING').upper()
 
@@ -200,17 +197,6 @@ def configure():
         ],
     )
 
-    global configured
-    configured = True
-
-
-def get_logger():
-    """
-    Return the beautiful and configured cli2 logger.
-    """
-    if not configured:
-        configure()
-    return structlog.get_logger('cli2')
-
 
-log = get_logger()
+configure()
+log = structlog.get_logger('cli2')

{cli2-4.0.7 → cli2-4.0.10/cli2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cli2
-Version: 4.0.7
+Version: 4.0.10
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-4.0.7 → cli2-4.0.10}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='4.0.7',
+    version='4.0.10',
     setup_requires='setupmeta',
     install_requires=[
         'docstring_parser',

{cli2-4.0.7 → cli2-4.0.10}/tests/test_client.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 import cli2
+import cli2.client
 import httpx
 import inspect
 import mock
@@ -37,6 +38,17 @@ def client_class():
 
 @pytest.mark.asyncio
 async def test_client_cli(client_class, httpx_mock):
+    class TestModel(client_class.Model):
+        url_list = '/'
+
+    class TestModel2(client_class.Model):
+        pass
+
+    class TestModel3(client_class.Model):
+        @cli2.cmd
+        def find():
+            pass
+
     assert client_class.cli
     factory = client_class.cli.overrides['self']['factory']
     assert isinstance(factory(), client_class)
@@ -45,8 +57,6 @@ async def test_client_cli(client_class, httpx_mock):
     response = await client_class.cli['get'].async_call('http://lol')
     assert response.json() == [1]
 
-    class TestModel(client_class.Model):
-        url_list = '/'
     assert 'testmodel' in client_class.cli
     assert client_class.cli['testmodel']['get'].overrides['cls']['factory']
     assert not inspect.ismethod(client_class.cli['testmodel']['get'].target)
@@ -58,16 +68,8 @@ async def test_client_cli(client_class, httpx_mock):
     httpx_mock.add_response(url='http://lol/?page=2', json=[])
     await client_class.cli['testmodel']['find'].async_call()
 
-    class TestModel2(client_class.Model):
-        pass
-
     assert 'testmodel2' not in client_class.cli
 
-    class TestModel3(client_class.Model):
-        @cli2.cmd
-        def find():
-            pass
-
     assert list(client_class.cli['testmodel3'].keys()) == ['help', 'find']
 
 
@@ -85,7 +87,6 @@ async def test_client_cli_override(client_class, httpx_mock):
         @cli2.cmd
         async def find(cls, foo):
             return cls.url_list
-    assert await Client.cli['testmodel']['find'].async_call('bar') == 'bar/foo'
 
     class TestModel2(Client.Model):
         @classmethod
@@ -93,12 +94,15 @@ async def test_client_cli_override(client_class, httpx_mock):
         async def find(cls):
             return 'foo'
 
-    assert await Client.cli['testmodel2']['find'].async_call() == 'foo'
-    assert 'get' not in Client.cli['testmodel2']
-
     class TestModel3(Client.Model):
         url_list = '{client.test}/foo'
         create = None
+
+    assert await Client.cli['testmodel']['find'].async_call('bar') == 'bar/foo'
+
+    assert await Client.cli['testmodel2']['find'].async_call() == 'foo'
+    assert 'get' not in Client.cli['testmodel2']
+
     assert 'create' not in Client.cli['testmodel3']
 
 
@@ -123,13 +127,13 @@ async def test_async_factory(httpx_mock, client_class):
         async def factory(cls):
             return cls(base_url='http://bar')
 
+    class TestModel(TestClient.Model):
+        url_list = '/2'
+
     TestClient.cli.overrides['self']['factory'] = TestClient.factory
     httpx_mock.add_response(url='http://bar/', json=[dict(a=1)])
     assert await TestClient.cli['get'].async_call('/')
 
-    class TestModel(TestClient.Model):
-        url_list = '/2'
-
     httpx_mock.add_response(url='http://bar/2', json=[dict(a=1)])
     httpx_mock.add_response(url='http://bar/2?page=2', json=[])
     await TestClient.cli['testmodel']['find'].async_call()
@@ -777,6 +781,10 @@ async def test_model_crud(httpx_mock, client_class):
 
 @pytest.mark.asyncio
 async def test_client_cli2(httpx_mock, client_class):
+    class Foo(client_class.Model):
+        id = cli2.Field()
+        url_list = '/foo'
+
     assert client_class.cli.name == 'test'
     assert client_class.cli.doc == 'doc'
 
@@ -785,10 +793,6 @@ async def test_client_cli2(httpx_mock, client_class):
     resp = await meth.async_call('/foo')
     assert resp.json() == [1]
 
-    class Foo(client_class.Model):
-        id = cli2.Field()
-        url_list = '/foo'
-
     meth = client_class.cli['foo']['get']
     httpx_mock.add_response(url='http://lol/foo/1', json=dict(id=1, a=2))
     result = await meth.async_call('id=1')
@@ -855,11 +859,12 @@ def test_datetime_default_fmt(client_class):
 
 
 @pytest.mark.asyncio
-async def test_mask_recursive(client_class):
+async def test_mask_recursive(client_class, monkeypatch):
     client = client_class(mask=['scrt', 'password'])
     client.client.send = mock.AsyncMock()
 
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
     response = httpx.Response(
         status_code=200,
         content='{"pub": 1, "foo": [{"scrt": "pass"}]}',
@@ -868,11 +873,11 @@ async def test_mask_recursive(client_class):
     response.request = httpx.Request('POST', '/', json=data)
     client.client.send.return_value = response
     await client.post('/', json=data)
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='POST',
         url='http://lol/',
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     log.debug.assert_called_once_with(
         'request',
         json=[{'foo': [{'src': 'pass'}]}],
@@ -888,11 +893,12 @@ async def test_mask_recursive(client_class):
 @pytest.mark.parametrize(
     'key', ('json', 'data'),
 )
-async def test_mask_logs(client_class, key):
+async def test_mask_logs(client_class, key, monkeypatch):
     client = client_class(mask=['scrt', 'password'])
     client.client.send = mock.AsyncMock()
 
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
     response = httpx.Response(
         status_code=200,
         content='{"pub": 1, "scrt": "pass"}',
@@ -901,11 +907,11 @@ async def test_mask_logs(client_class, key):
     response.request = httpx.Request('POST', '/', **{key: data})
     client.client.send.return_value = response
     await client.post('/', **{key: data})
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='POST',
         url='http://lol/',
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     log.debug.assert_called_once_with(
         'request',
         **{key: dict(foo='bar', password='***MASKED***')},
@@ -939,11 +945,12 @@ async def test_mask_exceptions(client_class):
 
 
 @pytest.mark.asyncio
-async def test_request_mask(client_class):
+async def test_request_mask(client_class, monkeypatch):
     client = client_class(mask=['password'])
     client.client.send = mock.AsyncMock()
 
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
     response = httpx.Response(
         status_code=200,
         content='{"pub": 1, "scrt": "pass"}',
@@ -952,11 +959,11 @@ async def test_request_mask(client_class):
     response.request = httpx.Request('POST', '/', json=data)
     client.client.send.return_value = response
     await client.post('/', json=data, mask=['scrt'])
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='POST',
         url='http://lol/'
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     log.debug.assert_called_once_with(
         'request',
         json=dict(foo='bar', password='secret'),
@@ -969,19 +976,20 @@ async def test_request_mask(client_class):
 
 
 @pytest.mark.asyncio
-async def test_log_content(client_class):
+async def test_log_content(client_class, monkeypatch):
     client = client_class()
     client.client.send = mock.AsyncMock()
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
     response = httpx.Response(status_code=200, content='lol:]bar')
     response.request = httpx.Request('POST', '/')
     client.client.send.return_value = response
     await client.post('/', content='lol:]foo')
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='POST',
         url='http://lol/'
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     log.debug.assert_called_once_with('request', content='lol:]foo')
     log.info.assert_called_once_with(
         'response', status_code=200, content=b'lol:]bar'
@@ -989,20 +997,20 @@ async def test_log_content(client_class):
 
 
 @pytest.mark.asyncio
-async def test_log_quiet(client_class):
+async def test_log_quiet(client_class, monkeypatch):
     client = client_class()
     client.client.send = mock.AsyncMock()
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
     response = httpx.Response(status_code=200, content='[1]')
     response.request = httpx.Request('GET', '/')
     client.client.send.return_value = response
     await client.get('/', json=[1], quiet=True)
-    log = client.logger.bind.return_value
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='GET',
         url='http://lol/',
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     assert not log.debug.call_args_list
     log.info.assert_called_once_with('response', status_code=200)
 
@@ -1065,11 +1073,13 @@ def test_id_value(client_class):
 
 
 @pytest.mark.asyncio
-async def test_debug(client_class):
+async def test_debug(client_class, monkeypatch):
     client = client_class(mask=['scrt', 'password'], debug=True)
     client.client.send = mock.AsyncMock()
 
-    client.logger = mock.Mock()
+    log = mock.Mock()
+    monkeypatch.setattr(cli2.client, 'log', log)
+
     response = httpx.Response(
         status_code=200,
         content='{"pub": 1, "scrt": "pass"}',
@@ -1078,11 +1088,11 @@ async def test_debug(client_class):
     response.request = httpx.Request('POST', '/', json=data)
     client.client.send.return_value = response
     await client.post('/', json=data, quiet=True)
-    client.logger.bind.assert_called_once_with(
+    log.bind.assert_called_once_with(
         method='POST',
         url='http://lol/',
     )
-    log = client.logger.bind.return_value
+    log = log.bind.return_value
     log.debug.assert_called_once_with(
         'request',
         json=dict(foo='bar', password='secret'),
@@ -1135,13 +1145,3 @@ async def test_client_token_apply(client_class, httpx_mock):
     await client.client_reset()
     assert client.token == 2
     assert client.client.token == 2
-
-
-def test_client_kwargs(client_class):
-    class TestCmd(cli2.Command):
-        pass
-
-    class TestClient(client_class):
-        cli2 = dict(cmdclass=TestCmd)
-
-    assert TestClient.cli.cmdclass == TestCmd