Open Stack

We enthusiastically announce the release of:

cliff 3.7.0: Command Line Interface Formulation Framework

This release is part of the wallaby release series.

The source is available from:

    https://opendev.org/openstack/cliff

Download the package from:

    https://pypi.org/project/cliff

Please report issues through:

    https://storyboard.openstack.org/#!/project/openstack/cliff

For more details, please see below.

3.7.0
^^^^^


New Features
************

* The "cliff.lister.Lister" base class now implements "--sort-
  ascending" and "--sort-descending" options, which can be used to
  configure the sort direction. For example:

     $ hello-world list-users --sort-column email --sort-descending
     +----------------+-----------------------------+
     | Name           | Email                       |
     +----------------+-----------------------------+
     | Charles Xavier | therealcharliex at example.com |
     | Jim Hendrix    | jim at example.com             |
     | John Doe       | doe.john at example.com        |
     | Alice Baker    | abaker at example.com          |
     +----------------+-----------------------------+

* Instances of "cliff.columns.FormattableColumn" are now comparable.
  This allows implementations of "FormattableColumn" storing primitive
  data types or containers with primitive data types to be sorted
  using the "--sort-column" option. Implementations of
  "FormattableColumn" that store other types of data will still need
  to implement their own rich comparison magic methods.


Upgrade Notes
*************

* "cliff.lister.Lister" implementations that override the
  "need_sort_by_cliff" property should now consider the "--sort-
  ascending" and "--sort-descending" options.


Bug Fixes
*********

* Sorting output using the "--sort-column" option will now handle
  "None" values. This was supported implicitly in Python 2 but was
  broken in the move to Python 3. In addition, requests to sort a
  column containing non-comparable types will now be ignored.
  Previously, these request would result in a "TypeError".

Changes in cliff 3.6.0..3.7.0
-----------------------------

117a100 requirements: Uncap PrettyTable
7798cb2 Add '--sort-ascending', '--sort-descending' parameters
c1c9910 Make 'FormattableColumn' comparable
4f45f9a Handle null values when sorting
0d18e88 Remove unicode from code
3613473 gitignore: Ignore reno artefacts
b04cba8 Remove lower-constraints


Diffstat (except docs and test files)
-------------------------------------

.gitignore                                         | 11 +--
.zuul.yaml                                         |  1 -
cliff/columns.py                                   |  5 ++
cliff/formatters/table.py                          | 13 +--
cliff/formatters/value.py                          |  2 +-
cliff/lister.py                                    | 92 ++++++++++++++++------
demoapp/cliffdemo/encoding.py                      |  4 +-
lower-constraints.txt                              | 33 --------
...add-Lister-sort-direction-5f34dba3c9743572.yaml | 21 +++++
...parable-FormattableColumn-31c0030ced70b7fb.yaml |  9 +++
...-none-values-when-sorting-de40e36c66ad95ca.yaml |  8 ++
requirements.txt                                   |  4 +-
tox.ini                                            | 26 +++---
20 files changed, 228 insertions(+), 117 deletions(-)


Requirements updates
--------------------

diff --git a/requirements.txt b/requirements.txt
index cb74608..774d9d2 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,2 +5,2 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0
-cmd2>=0.8.0,!=0.8.3 # MIT
-PrettyTable<0.8,>=0.7.2 # BSD
+cmd2>=1.0.0 # MIT
+PrettyTable>=0.7.2 # BSD