Add message template support for alert component by thoscut · Pull Request #17516 · home-assistant/core

thoscut · 2018-10-16T10:16:46Z

Description:

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

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

  plant_office:
    name: Plant in office needs help
    entity_id: plant.plant_office
    state: 'problem'
    repeat:
      - 60
      - 720
    message: "{{ states.plant.plant_office }} ({{ state_attr('plant.plant_office', 'problem') }})"
    notifiers:
      - telegram_receiver

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.io

balloob · 2018-10-17T08:52:34Z

homeassistant/components/alert.py

+            if self._message_template is not None:
+                message = self._message_template.async_render()
+            else:
+                message = '{0}'.format(self._name)


No reason to format, just message = self._name will do.

balloob · 2018-10-17T08:52:48Z

Looks good! Ok to merge when a test has been added.

houndci-bot · 2018-10-17T21:25:31Z

tests/components/test_alert.py

+        self._setup_notify()
+
+        config = deepcopy(TEST_CONFIG)
+        config[alert.DOMAIN][NAME][alert.CONF_MESSAGE_TEMPLATE] = "{{ states.sensor.test.entity_id }}"


line too long (102 > 79 characters)

houndci-bot · 2018-10-17T22:25:13Z

tests/components/test_alert.py

+        self.hass.services.register(
+            notify.DOMAIN, NOTIFIER, record_event)
+
+		return events


indentation contains tabs
unexpected indentation
TabError: inconsistent use of tabs and spaces in indentation

houndci-bot · 2018-10-17T22:25:13Z

tests/components/test_alert.py

+
+        self.hass.services.register(
+            notify.DOMAIN, NOTIFIER, record_event)
+


indentation contains tabs
indentation contains mixed spaces and tabs
blank line contains whitespace

houndci-bot · 2018-10-17T22:25:13Z

tests/components/test_alert.py

        """Stop everything that was started."""
        self.hass.stop()
+
+    def _setup_notify(self):


indentation contains mixed spaces and tabs

houndci-bot · 2018-10-17T22:25:13Z

tests/components/test_alert.py

    def tearDown(self):
        """Stop everything that was started."""
        self.hass.stop()
+


indentation contains tabs
indentation contains mixed spaces and tabs
blank line contains whitespace

houndci-bot · 2018-10-18T21:09:49Z

tests/components/test_alert.py

        self.hass.add_job(entity.end_alerting)
        self.hass.block_till_done()
-        assert entity._send_done_message is False
+        assert entity._send_done_message is False


no newline at end of file

houndci-bot · 2018-10-31T19:43:54Z

homeassistant/components/alert.py

+        _LOGGER.info("Alerting: %s", self._done_message_template)
        self._send_done_message = False
+
+        if self._done_message_template is None:


indentation contains mixed spaces and tabs

houndci-bot · 2018-10-31T19:43:54Z

homeassistant/components/alert.py

-        _LOGGER.info("Alerting: %s", self._done_message)
+        _LOGGER.info("Alerting: %s", self._done_message_template)
        self._send_done_message = False
+


blank line contains whitespace
indentation contains mixed spaces and tabs
indentation contains tabs

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

+        self._done_message_template = done_message_template
+        if self._done_message_template is not None:
+            self._done_message_template.hass = hass
+


blank line contains whitespace
indentation contains mixed spaces and tabs
indentation contains tabs

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

-                 state, repeat, skip_first, notifiers, can_ack):
+    def __init__(self, hass, entity_id, name, watched_entity_id,
+                 state, repeat, skip_first, message_template, 
+				 done_message_template, notifiers, can_ack):


continuation line under-indented for visual indent
indentation contains mixed spaces and tabs
indentation contains tabs

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

-    def __init__(self, hass, entity_id, name, done_message, watched_entity_id,
-                 state, repeat, skip_first, notifiers, can_ack):
+    def __init__(self, hass, entity_id, name, watched_entity_id,
+                 state, repeat, skip_first, message_template, 


trailing whitespace

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

+                              watched_entity_id, alert_state, repeat,
+                              skip_first, message_template, 
+							  done_message_template, notifiers,
+                              can_ack))


indentation contains mixed spaces and tabs

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

+        entities.append(Alert(hass, object_id, name, 
+                              watched_entity_id, alert_state, repeat,
+                              skip_first, message_template, 
+							  done_message_template, notifiers,


continuation line under-indented for visual indent
indentation contains mixed spaces and tabs
indentation contains tabs

houndci-bot · 2018-10-31T19:43:55Z

homeassistant/components/alert.py

+
+        entities.append(Alert(hass, object_id, name, 
+                              watched_entity_id, alert_state, repeat,
+                              skip_first, message_template, 


trailing whitespace

houndci-bot · 2018-10-31T19:43:56Z

homeassistant/components/alert.py

+        notifiers = cfg.get(CONF_NOTIFIERS)
+        can_ack = cfg.get(CONF_CAN_ACK)
+
+        entities.append(Alert(hass, object_id, name, 


trailing whitespace

This reverts commit 7be519b.

…ction

thoscut · 2018-10-31T20:00:15Z

I updated the component to support templates for both, message and done_message. For legacy support, the message is optional and the name taken instead, like it was before.
Is there a common practice for marking this legacy support for removal/deprecated in a later release?

MartinHjelmare · 2018-10-31T23:46:57Z

Is this PR clashing with #17616?

homeassistant added cla-signed integration: alert labels Oct 16, 2018

ghost added the in progress label Oct 16, 2018

thoscut force-pushed the dev branch from 123856b to c6e342b Compare October 16, 2018 11:23

thoscut mentioned this pull request Oct 16, 2018

Add message template support for alert component home-assistant/home-assistant.io#6859

Merged

2 tasks

bachya added the Hacktoberfest label Oct 16, 2018

balloob reviewed Oct 17, 2018

View reviewed changes

houndci-bot reviewed Oct 17, 2018

View reviewed changes

thoscut force-pushed the dev branch 4 times, most recently from a6634f4 to b4ad138 Compare October 18, 2018 21:09

houndci-bot reviewed Oct 18, 2018

View reviewed changes

thoscut force-pushed the dev branch from b4ad138 to ab20e7a Compare October 18, 2018 21:12

houndci-bot reviewed Oct 31, 2018

View reviewed changes

thoscut added 11 commits October 31, 2018 20:52

Add problem text to message if available

d6ca0a2

Revert "Add problem text to message if available"

a2cda72

This reverts commit 7be519b.

Cleanup setup

b5bd847

Add message template support

e188799

Fix for failing test

5334bbe

Added tests

4640972

Refactor changes

8aa2f8e

Fix lint violation

7ca6c31

Fix failing tests

0aa9e84

Unify handling for message and done_message parameter and sending fun…

3fc5ff4

…ction

Update tests

5bba043

thoscut force-pushed the dev branch from d91d53e to 5bba043 Compare October 31, 2018 19:53

Fix lint warnings

c072bee

MartinHjelmare mentioned this pull request Oct 31, 2018

Add data/data_template/title to alert component #17616

Merged

3 tasks

balloob approved these changes Nov 1, 2018

View reviewed changes

balloob merged commit bfa86b8 into home-assistant:dev Nov 1, 2018

ghost removed the in progress label Nov 1, 2018

balloob mentioned this pull request Nov 9, 2018

0.82 #18335

Merged

home-assistant locked and limited conversation to collaborators Feb 5, 2019


		self.hass.services.register(
		notify.DOMAIN, NOTIFIER, record_event)

Uh oh!

Conversation

thoscut commented Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Oct 17, 2018

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!

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!

thoscut commented Oct 31, 2018

Uh oh!

MartinHjelmare commented Oct 31, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

thoscut commented Oct 16, 2018 •

edited

Loading

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