Waze Travel Time: optional inclusive/exclusive filters by mario-tux · Pull Request #14000 · home-assistant/core

mario-tux · 2018-04-19T15:58:30Z

Added optional inc_filter and `excl_filter' params that allow to refine the reported routes: the first is not always the best/desired. A simple case-insensitive filtering (no regular expression) is used.

Description:

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5208

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: waze_travel_time
    origin: Montréal, QC
    destination: Québec, QC
    region: 'US'
    inc_filter: 'High'
    excl_filter: 'local'

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

Added optional `inc_filter` and `excl_filter' params that allow to refine the reported routes: the first is not always the best/desired. A simple case-insensitive filtering (no regular expression) is used.

houndci-bot · 2018-04-19T15:58:52Z

+            if self._inc_filter is not None:
+                results = {k: v for k, v in results.items() if self._inc_filter.lower() in k.lower()}
+            if self._excl_filter is not None:
+                results = {k: v for k, v in results.items() if self._excl_filter.lower() not in k.lower()}


line too long (106 > 79 characters)

houndci-bot · 2018-04-19T15:58:52Z

                self._origin, self._destination, self._region, None)
            results = params.calc_all_routes_info()
+            if self._inc_filter is not None:
+                results = {k: v for k, v in results.items() if self._inc_filter.lower() in k.lower()}


line too long (101 > 79 characters)

houndci-bot · 2018-04-19T15:58:52Z


    try:
-        waze_data = WazeRouteData(origin, destination, region)
+        waze_data = WazeRouteData(origin, destination, region, inc_filter, excl_filter)


line too long (87 > 79 characters)

houndci-bot · 2018-04-24T16:31:01Z

+                    self._inc_filter.lower() in k.lower()}
+            if self._excl_filter is not None:
+                results = {k: v for k, v in results.items() if 
+                    self._excl_filter.lower() not in k.lower()}


continuation line under-indented for visual indent

houndci-bot · 2018-04-24T16:31:01Z

+                results = {k: v for k, v in results.items() if 
+                    self._inc_filter.lower() in k.lower()}
+            if self._excl_filter is not None:
+                results = {k: v for k, v in results.items() if 


trailing whitespace

houndci-bot · 2018-04-24T16:31:02Z

            results = params.calc_all_routes_info()
+            if self._inc_filter is not None:
+                results = {k: v for k, v in results.items() if 
+                    self._inc_filter.lower() in k.lower()}


continuation line under-indented for visual indent

houndci-bot · 2018-04-24T16:31:02Z

                self._origin, self._destination, self._region, None)
            results = params.calc_all_routes_info()
+            if self._inc_filter is not None:
+                results = {k: v for k, v in results.items() if 


trailing whitespace

houndci-bot · 2018-04-24T16:31:02Z

    try:
-        waze_data = WazeRouteData(origin, destination, region)
+        waze_data = WazeRouteData(origin, destination, region, 
+            inc_filter, excl_filter)


continuation line under-indented for visual indent

houndci-bot · 2018-04-24T16:31:02Z


    try:
-        waze_data = WazeRouteData(origin, destination, region)
+        waze_data = WazeRouteData(origin, destination, region, 


trailing whitespace

fabaff · 2018-05-01T19:18:43Z

@Myrddyn1, can you please comment on this? Thanks

mario-tux · 2018-05-02T08:33:22Z

Maybe the example of usage of the filters proposed in the documentation doesn't make so sense.
I use such filter in my daily use because Waze, for my daily trip for work, regularly proposes three paths. The one I prefer makes use of the high-way but it is not always on the top of the list. The other two paths make use of secondary roads. With such filters (even with just one) I can influence the selection with clear rules.

Myrddyn1 · 2018-05-07T03:00:34Z

Hi,
This is a good feature :)
So, you would keep the exact same route whatever happens on the way? (accident for instance)
Would you consider a better route if the usual route is like XX min longer than the best one ?

mario-tux · 2018-05-07T10:42:17Z

@Myrddyn1
These are just filters on the synthetic names automatically reported by Waze: they look to report the main roads used in the path.
I guess, in case of accident, it would continue to report the main road name (if still used).

If I use an "inclusive filter" with the high-way name, he would select it even if longer than the others (not using the high-way). If I use an "exclusive filter" with a not-preferred road name, he would remove any path reporting such name event if it is shorter. Such filters are a simple way to apply personal preferences and, as in my case, to prevent continuing variation of the selected path (few minutes of difference among the alternatives).

IMHO such filters should not annoy anyone who don't want to use them and they could even used in combination with other future criteria. They just cut-off the reported list.

Myrddyn1 · 2018-05-07T11:33:45Z

@diraimondo
I understand your feature.
I was just wondering if you would reconsider your route by setting a threshold in minutes as a parameter.
Thus, if your preferred route presents an unusual delay, and its delay is (let's say) 15 min higher than the second route option, the plugin will give you the second option.

Anyway, with or without that threshold, I agree with your feature :)

fabaff

Thanks 🐦

…t#14000) * Waze Travel Time: optional inclusive/exclusive filters Added optional `inc_filter` and `excl_filter' params that allow to refine the reported routes: the first is not always the best/desired. A simple case-insensitive filtering (no regular expression) is used. * fix line lenght * fix spaces * Rename var * Fix typo * Fix missing var

Waze Travel Time: optional inclusive/exclusive filters

6c10f9a

Added optional `inc_filter` and `excl_filter' params that allow to refine the reported routes: the first is not always the best/desired. A simple case-insensitive filtering (no regular expression) is used.

This comment has been minimized.

Sign in to view

homeassistant added cla-needed platform: sensor.waze_travel_time small-pr PRs with less than 30 lines. labels Apr 19, 2018

houndci-bot reviewed Apr 19, 2018

View reviewed changes

mario-tux mentioned this pull request Apr 19, 2018

Waze Travel Time: optional inclusive/exclusive filters home-assistant/home-assistant.io#5208

Merged

2 tasks

homeassistant added cla-signed and removed cla-needed labels Apr 19, 2018

fix line lenght

a2b6fde

houndci-bot reviewed Apr 24, 2018

View reviewed changes

fix spaces

5d9832f

Rename var

b7e2936

homeassistant added the cla-signed label May 8, 2018

fabaff added 2 commits May 8, 2018 23:56

Fix typo

02b71b6

Fix missing var

6beace4

fabaff approved these changes May 8, 2018

View reviewed changes

fabaff merged commit 6231394 into home-assistant:dev May 8, 2018

balloob mentioned this pull request May 28, 2018

0.70.0 #14657

Merged

home-assistant locked and limited conversation to collaborators Sep 5, 2018

ghost added integration: waze_travel_time and removed platform: sensor.waze_travel_time labels Mar 21, 2019

Uh oh!

Conversation

mario-tux commented Apr 19, 2018

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff commented May 1, 2018

Uh oh!

mario-tux commented May 2, 2018

Uh oh!

Myrddyn1 commented May 7, 2018

Uh oh!

mario-tux commented May 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Myrddyn1 commented May 7, 2018

Uh oh!

fabaff left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Example entry for `configuration.yaml` (if applicable):

mario-tux commented May 7, 2018 •

edited

Loading