[PATCH] nmbug-status: add support for specifying sort order for each view

[PATCH] nmbug-status: add support for specifying sort order for each view

[Jani Nikula]

Let each view have "sort" key with possible values "oldest-first",
"newest-first", and "unsorted", and sort the results
accordingly. Oldest first remains the default.
---
 devel/nmbug/nmbug-status | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index 19dc48abf557..e1abf4db15ba 100755
--- a/devel/nmbug/nmbug-status
+++ b/devel/nmbug/nmbug-status
@@ -156,11 +156,19 @@ class Page (object):
             stream.write(self.footer)
 
     def _write_view(self, database, view, stream):
+        sort = {
+            'oldest-first': notmuch.Query.SORT.OLDEST_FIRST,
+            'newest-first': notmuch.Query.SORT.NEWEST_FIRST,
+            'unsorted': notmuch.Query.SORT.UNSORTED
+        }
         if 'query-string' not in view:
             query = view['query']
             view['query-string'] = ' and '.join(query)
         q = notmuch.Query(database, view['query-string'])
-        q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
+        if 'sort' in view and view['sort'] in sort:
+            q.set_sort(sort[view['sort']])
+        else:
+            q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
         threads = self._get_threads(messages=q.search_messages())
         self._write_view_header(view=view, stream=stream)
         self._write_threads(threads=threads, stream=stream)
-- 
2.1.4

Re: [PATCH] nmbug-status: add support for specifying sort order for each view

[Tomi Ollila]

On Fri, Apr 03 2015, Jani Nikula <jani@nikula.org> wrote:

> Let each view have "sort" key with possible values "oldest-first",
> "newest-first", and "unsorted", and sort the results
> accordingly. Oldest first remains the default.
> ---

lgtm.

Tomi

>  devel/nmbug/nmbug-status | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
> index 19dc48abf557..e1abf4db15ba 100755
> --- a/devel/nmbug/nmbug-status
> +++ b/devel/nmbug/nmbug-status
> @@ -156,11 +156,19 @@ class Page (object):
>              stream.write(self.footer)
>  
>      def _write_view(self, database, view, stream):
> +        sort = {
> +            'oldest-first': notmuch.Query.SORT.OLDEST_FIRST,
> +            'newest-first': notmuch.Query.SORT.NEWEST_FIRST,
> +            'unsorted': notmuch.Query.SORT.UNSORTED
> +        }
>          if 'query-string' not in view:
>              query = view['query']
>              view['query-string'] = ' and '.join(query)
>          q = notmuch.Query(database, view['query-string'])
> -        q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
> +        if 'sort' in view and view['sort'] in sort:
> +            q.set_sort(sort[view['sort']])
> +        else:
> +            q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
>          threads = self._get_threads(messages=q.search_messages())
>          self._write_view_header(view=view, stream=stream)
>          self._write_threads(threads=threads, stream=stream)
> -- 
> 2.1.4
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re: [PATCH] nmbug-status: add support for specifying sort order for each view

[W. Trevor King]

[-- Attachment #1: Type: text/plain, Size: 1772 bytes --]

On Fri, Apr 03 2015, Jani Nikula <jani@nikula.org> wrote:
> Let each view have "sort" key with possible values "oldest-first",
> "newest-first", and "unsorted", and sort the results
> accordingly. Oldest first remains the default.

I like it, but have a few suggestions to tweak the implementation.

>      def _write_view(self, database, view, stream):
> +        sort = {
> +            'oldest-first': notmuch.Query.SORT.OLDEST_FIRST,
> +            'newest-first': notmuch.Query.SORT.NEWEST_FIRST,
> +            'unsorted': notmuch.Query.SORT.UNSORTED
> +        }

I'd rather have this mapping defined in a global variable
(_SORT_TERMS?) or a class-wide attribute (Page.sort_terms?).
Alternatively, you could do something dynamic like:

	sort_key = view.get('sort', 'oldest-first')
  sort_attribute = sort_key.upper().replace('-', '_'))
  try:
      sort = getattr(notmuch.Query.SORT, sort_attribute)
  except AttributeError:
      raise ConfigError('Invalid setting for {}: {!r}'.format(
          view['title'], sort_key))

which would automatically keep the implementation in sync with the
available values in notmuch.Query.SORT.

> -        q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
> +        if 'sort' in view and view['sort'] in sort:
> +            q.set_sort(sort[view['sort']])
> +        else:
> +            q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)

Instead of silently falling back to oldest-first if the requested
sort-key isn't available, I think we should be raising ConfigError so
the user knows they need to update their config.

Cheers,
Trevor

-- 
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH] nmbug-status: add support for specifying sort order for each view

[Tomi Ollila]

On Mon, Apr 06 2015, "W. Trevor King" <wking@tremily.us> wrote:

> On Fri, Apr 03 2015, Jani Nikula <jani@nikula.org> wrote:
>> Let each view have "sort" key with possible values "oldest-first",
>> "newest-first", and "unsorted", and sort the results
>> accordingly. Oldest first remains the default.
>
> I like it, but have a few suggestions to tweak the implementation.
>
>>      def _write_view(self, database, view, stream):
>> +        sort = {
>> +            'oldest-first': notmuch.Query.SORT.OLDEST_FIRST,
>> +            'newest-first': notmuch.Query.SORT.NEWEST_FIRST,
>> +            'unsorted': notmuch.Query.SORT.UNSORTED
>> +        }
>
> I'd rather have this mapping defined in a global variable
> (_SORT_TERMS?) or a class-wide attribute (Page.sort_terms?).
> Alternatively, you could do something dynamic like:
>
> 	sort_key = view.get('sort', 'oldest-first')
>   sort_attribute = sort_key.upper().replace('-', '_'))
>   try:
>       sort = getattr(notmuch.Query.SORT, sort_attribute)
>   except AttributeError:
>       raise ConfigError('Invalid setting for {}: {!r}'.format(
>           view['title'], sort_key))
>
> which would automatically keep the implementation in sync with the
> available values in notmuch.Query.SORT.

I like how this suggestion looks like.

Tomi

>
>> -        q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
>> +        if 'sort' in view and view['sort'] in sort:
>> +            q.set_sort(sort[view['sort']])
>> +        else:
>> +            q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
>
> Instead of silently falling back to oldest-first if the requested
> sort-key isn't available, I think we should be raising ConfigError so
> the user knows they need to update their config.
>
> Cheers,
> Trevor
>
> -- 
> This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
> For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

[PATCH v2] nmbug-status: add support for specifying sort order for each view

[Jani Nikula]

Let each view have a "sort" key, typically used with values
"oldest-first" or "newest-first" (although all values in Query.SORT
are accepted), and sort the results accordingly. Oldest first remains
the default.

The dynamic approach of mapping sort values is as suggested by
W. Trevor King <wking@tremily.us>.
---
 devel/nmbug/nmbug-status | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index e845c2a5c8f7..a289798e3cc1 100755
--- a/devel/nmbug/nmbug-status
+++ b/devel/nmbug/nmbug-status
@@ -156,11 +156,20 @@ class Page (object):
             stream.write(self.footer)
 
     def _write_view(self, database, view, stream):
+        # sort order, default to oldest-first
+        sort_key = view.get('sort', 'oldest-first')
+        # dynamically accept all values in Query.SORT
+        sort_attribute = sort_key.upper().replace('-', '_')
+        try:
+            sort = getattr(notmuch.Query.SORT, sort_attribute)
+        except AttributeError:
+            raise ConfigError('Invalid sort setting for {}: {!r}'.format(
+                view['title'], sort_key))
         if 'query-string' not in view:
             query = view['query']
             view['query-string'] = ' and '.join(query)
         q = notmuch.Query(database, view['query-string'])
-        q.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
+        q.set_sort(sort)
         threads = self._get_threads(messages=q.search_messages())
         self._write_view_header(view=view, stream=stream)
         self._write_threads(threads=threads, stream=stream)
-- 
2.1.4

Re: [PATCH v2] nmbug-status: add support for specifying sort order for each view

[W. Trevor King]

[-- Attachment #1: Type: text/plain, Size: 198 bytes --]

Looks good to me ;).

Cheers,
Trevor

-- 
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH v2] nmbug-status: add support for specifying sort order for each view

[David Bremner]

Jani Nikula <jani@nikula.org> writes:

> Let each view have a "sort" key, typically used with values
> "oldest-first" or "newest-first" (although all values in Query.SORT
> are accepted), and sort the results accordingly. Oldest first remains
> the default.

pushed.

d

Re: [PATCH v2] nmbug-status: add support for specifying sort order for each view

[Tomi Ollila]

On Tue, Sep 29 2015, David Bremner <david@tethera.net> wrote:

> Jani Nikula <jani@nikula.org> writes:
>
>> Let each view have a "sort" key, typically used with values
>> "oldest-first" or "newest-first" (although all values in Query.SORT
>> are accepted), and sort the results accordingly. Oldest first remains
>> the default.
>
> pushed.

when can we expect nmbug status page update ? :D

>
> d

Tomi