cli2 5.0.2__tar.gz → 5.1.0rc1__tar.gz

{cli2-5.0.2/cli2.egg-info → cli2-5.1.0rc1}/PKG-INFO

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

{cli2-5.0.2 → cli2-5.1.0rc1}/cli2/__init__.py

@@ -14,7 +14,12 @@ from .colors import colors as c
 
 from .configuration import Configuration, cfg
 from .display import diff, diff_data, render, print, highlight, yaml_highlight
-from .lock import Lock
+try:
+    import fcntl
+except ImportError:
+    """ windows """
+else:
+    from .lock import Lock
 from .log import configure, log
 from .mask import Mask
 from .table import Table

{cli2-5.0.2 → cli2-5.1.0rc1}/cli2/lock.py

@@ -80,7 +80,7 @@ class Lock:
     .. py:attribute:: blocking
 
         If True, the locker automatically blocks. Otherwise, you need to check
-        :py:attr:`acquired` and call :py:method:`block` yourself.
+        :py:attr:`acquired` and call :py:meth:`block` yourself.
 
     .. py:attribute:: prefix
 

{cli2-5.0.2 → cli2-5.1.0rc1}/cli2/log.py

@@ -37,6 +37,16 @@ variables.
 
     Setting this to ``INFO``, ``DEBUG``, or any other log level is safe.
 
+.. envvar:: LOG_FILE
+
+    Path to log file to use, with a couple of special values:
+
+    - if ``LOG_FILE=auto``, then a path will be calculated in
+      ``~/.local/cli2/log``,
+    - if ``LOG_FILE=none``, then there will be no file logging.
+
+    Default: ``auto``
+
 .. envvar:: DEBUG
 
     Setting this will set :envvar:`LOG_LEVEL` to `DEBUG`, but also activate
@@ -72,6 +82,7 @@ class YAMLFormatter:
 
 def configure():
     LOG_LEVEL = os.getenv('LOG_LEVEL', 'WARNING').upper()
+    LOG_FILE = os.getenv('LOG_FILE', 'auto').upper()
 
     if os.getenv('DEBUG'):
         LOG_LEVEL = 'DEBUG'
@@ -92,11 +103,21 @@ def configure():
         for arg in sys.argv
     ])[:155]
 
-    log_dir = Path(os.getenv("HOME")) / '.local/cli2/log'
-    log_dir.mkdir(parents=True, exist_ok=True)
-    ts = datetime.datetime.now().strftime('%Y-%m-%d-%H-%M-%S')
-    file_name = f'{sys.argv[0].split("/")[-1]}-{ts}-{cmd}.log'
-    file_path = log_dir / file_name
+    if LOG_FILE == 'auto':
+        log_dir = Path(os.getenv("HOME")) / '.local/cli2/log'
+        log_dir.mkdir(parents=True, exist_ok=True)
+        ts = datetime.datetime.now().strftime('%Y-%m-%d-%H-%M-%S')
+        file_name = f'{sys.argv[0].split("/")[-1]}-{ts}-{cmd}.log'
+        LOG_FILE = log_dir / file_name
+    elif LOG_FILE == 'none' or not LOG_FILE:
+        LOG_FILE = None
+    else:
+        LOG_FILE = Path(LOG_FILE)
+
+    handlers = ['default']
+    if LOG_FILE:
+        handlers.append('file')
+
     LOGGING = {
         'version': 1,
         'disable_existing_loggers': True,
@@ -156,16 +177,10 @@ def configure():
                 'class': 'logging.StreamHandler',
                 'formatter': 'colored',
             },
-            'file': {
-                'level': 'DEBUG',
-                'class': 'logging.handlers.WatchedFileHandler',
-                'formatter': 'plain',
-                'filename': str(file_path),
-            },
         },
         'loggers': {
             'cli2': {
-                'handlers': ['default', 'file'],
+                'handlers': handlers,
                 'level': 'DEBUG',
                 'propagate': True,
             }
@@ -175,12 +190,20 @@ def configure():
     if os.getenv('HTTP_DEBUG'):
         LOGGING['loggers'].update({
             key: {
-                'handlers': ['default', 'file'],
+                'handlers': handlers,
                 'level': 'DEBUG',
                 'propagate': True,
             } for key in ('httpx', 'httpcore')
         })
 
+    if LOG_FILE:
+        LOGGING['handlers']['file'] = {
+            'level': 'DEBUG',
+            'class': 'logging.handlers.WatchedFileHandler',
+            'formatter': 'plain',
+            'filename': str(LOG_FILE),
+        }
+
     logging.config.dictConfig(LOGGING)
 
     structlog.configure(

{cli2-5.0.2 → cli2-5.1.0rc1}/cli2/mask.py

@@ -19,8 +19,8 @@ class Mask:
 
     .. code-block:: python
 
-        mask = cli2.Mask(keys=['password'], values=['1337p4ssw0rD'])
-        result = mask(dict(password='xx', text='some 1337p4ssw0rD noise xx'))
+        mask = cli2.Mask(keys=['password'], values=['secretval'])
+        result = mask(dict(password='xx', text='some secretval noise xx'))
 
     Will cause result to be:
 
@@ -31,7 +31,7 @@ class Mask:
 
     Because:
 
-    - ``1337p4ssw0rD`` was given as a value to mask
+    - ``secretval`` was given as a value to mask
     - ``password``'s value because ``password`` was given as a key to match
     - the Mask object learned the value of the ``password`` key, and masked it
       in ``text``

{cli2-5.0.2 → cli2-5.1.0rc1/cli2.egg-info}/PKG-INFO

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

{cli2-5.0.2 → cli2-5.1.0rc1}/setup.py

@@ -44,7 +44,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='5.0.2',
+    version='5.1.0rc1',
     setup_requires='setupmeta',
     packages=['cli2'],
     install_requires=[

{cli2-5.0.2 → cli2-5.1.0rc1}/tests/test_client.py

@@ -645,10 +645,11 @@ def test_descriptor(client_class):
     assert model.data['undeclared']['foo'] == 3
 
     model = Model()
-    assert model.foo == ''
+    assert model.foo is None
+    assert 'foo' not in model._data
     assert not model.changed_fields
     model.foo = 'bar'
-    assert model.changed_fields == dict(foo='')
+    assert model.changed_fields == dict(foo=None)
     model = Model(foo='bar')
     model.foo = 'foo'
     assert model.changed_fields == dict(foo='bar')
@@ -1246,3 +1247,54 @@ def test_client_command(client_class, httpx_mock):
     cmd = Client.cli['request']
     cmd()
     assert not Client.post_call_called
+
+
+def test_field_callback(client_class):
+    class TestModel(client_class.Model):
+        foo = chttpx.Field()
+        bar = chttpx.Field()
+        other = chttpx.Field()
+
+        @other.factory
+        def other_factory(self):
+            return 'nice'
+
+        @bar.factory(foo)
+        def bar_factory(self):
+            return f'bar{self.foo}'
+
+    model = client_class().TestModel(foo='test')
+    assert model.bar == 'bartest'
+    assert model.other == 'nice'
+
+    model = client_class().TestModel(foo='test')
+    assert model.data['bar'] == 'bartest'
+    assert model.data['other'] == 'nice'
+
+    model = client_class().TestModel()
+    assert model.data == dict(other='nice')
+
+    model = client_class().TestModel(bar='lol')
+    assert model.bar == 'lol'
+    assert model.data['bar'] == 'lol'
+
+
+def test_field_callback_recursion(client_class):
+    class TestModel(client_class.Model):
+        final = chttpx.Field()
+        req2 = chttpx.Field()
+        req1 = chttpx.Field()
+
+        @final.factory(req2)
+        def final_factory(self):
+            return f'{self.req2}val3'
+
+        @req2.factory(req1)
+        def req2_factory(self):
+            return f'{self.req1}val2'
+
+    model = client_class().TestModel(req1='lol')
+    assert model.data['final'] == 'lolval2val3'
+
+    model = client_class().TestModel(req1='lol')
+    assert model.final == 'lolval2val3'