Added possibilities to use template in the command_line sensor #8505

mar-schmidt · 2017-07-16T17:00:31Z

Description:

Added possibilities to use template in the command_line sensor

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

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

- platform: command_line
    name: yr wind direction cmd
    command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.yr_wind_direction_template.state }}'
    unit_of_measurement: "Vind"

Checklist:

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

Documentation added/updated in home-assistant.github.io PR Added documentation to HA PR#8505 home-assistant.io#3157

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

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
script/gen_requirements_all.py.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2017-07-16T17:00:32Z

Hi @mar-schmidt,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

mention-bot · 2017-07-16T17:00:32Z

@mar-schmidt, thanks for your PR! By analyzing the history of the files in this pull request, we identified @devdelay, @fabaff and @rmkraus to be potential reviewers.

houndci-bot · 2017-07-16T17:00:37Z

homeassistant/components/sensor/command_line.py


+        if rendered_args == args:
+            # No template used. default behavior
+            shell=True


local variable 'shell' is assigned to but never used
missing whitespace around operator

houndci-bot · 2017-07-16T17:00:38Z

homeassistant/components/sensor/command_line.py

+
+        if args_compiled:
+            try:
+                a = {"arguments":args}


missing whitespace after ':'

houndci-bot · 2017-07-16T17:00:38Z

homeassistant/components/sensor/command_line.py


    def update(self):
        """Get the latest data with a shell command."""
-        _LOGGER.info("Running command: %s", self.command)
+


blank line contains whitespace

homeassistant · 2017-07-16T17:05:25Z

Hi @mar-schmidt,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-07-16T17:05:32Z

homeassistant/components/sensor/command_line.py

+        else:
+            # Template used. Construct the string used in the shell
+            command = str(' '.join([prog] + shlex.split(rendered_args)))
+            shell=True


missing whitespace around operator

houndci-bot · 2017-07-16T17:05:32Z

homeassistant/components/sensor/command_line.py

+
+        if args_compiled: 
+            try:
+                a = { "arguments": args }


whitespace after '{'
whitespace before '}'

houndci-bot · 2017-07-16T17:05:32Z

homeassistant/components/sensor/command_line.py

+            args_compiled = template.Template(args, self.hass)
+            cache[command] = prog, args, args_compiled
+
+        if args_compiled: 


trailing whitespace

homeassistant · 2017-07-16T17:08:16Z

Hi @mar-schmidt,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

balloob · 2017-07-16T17:26:50Z

Can you add a test

houndci-bot · 2017-07-16T17:37:59Z

tests/components/sensor/test_command_line.py

+    def test_template_render(self):
+        """Ensure command with templates get rendered properly."""
+        self.hass.states.set('sensor.test_state', 'Works')
+        data = command_line.CommandSensorData(self.hass, 'echo {{ states.sensor.test_state.state }}')


line too long (101 > 79 characters)

houndci-bot · 2017-07-16T17:40:42Z

tests/components/sensor/test_command_line.py

+        """Ensure command with templates get rendered properly."""
+        self.hass.states.set('sensor.test_state', 'Works')
+        data = command_line.CommandSensorData(self.hass, 
+            'echo {{ states.sensor.test_state.state }}')


continuation line under-indented for visual indent

houndci-bot · 2017-07-16T17:40:42Z

tests/components/sensor/test_command_line.py

+    def test_template_render(self):
+        """Ensure command with templates get rendered properly."""
+        self.hass.states.set('sensor.test_state', 'Works')
+        data = command_line.CommandSensorData(self.hass, 


trailing whitespace

balloob · 2017-07-24T16:04:43Z

homeassistant/components/sensor/command_line.py

        self.value = None
+        self.hass = hass


This is not necessary. By the time update gets called, self.hass will be set by Home Assistant.

Since this is not the entity class, hass needs to be passed in. I think @balloob was thinking about the entity class where it could be removed.

balloob

Ok to merge when 1 comment addressed

mar-schmidt · 2017-07-24T16:29:18Z

@balloob removing this pointer will essentially throw some exceptions and break tests. Shall I keep it?

2017-07-24 18:23:33 ERROR (MainThread) [homeassistant.components.sensor] Error while setting up platform command_line
      3 Traceback (most recent call last):
      4   File "/usr/local/lib/python3.4/dist-packages/homeassistant/helpers/entity_component.py", line 164, in _async_setup_platform
      5     SLOW_SETUP_MAX_WAIT, loop=self.hass.loop)
      6   File "/usr/lib/python3.4/asyncio/tasks.py", line 372, in wait_for
      7     return fut.result()
      8   File "/usr/lib/python3.4/asyncio/futures.py", line 277, in result
      9     raise self._exception
     10   File "/usr/lib/python3.4/concurrent/futures/thread.py", line 54, in run
     11     result = self.fn(*self.args, **self.kwargs)
     12   File "/usr/local/lib/python3.4/dist-packages/homeassistant/components/sensor/command_line.py", line 48, in setup_platform
     13     add_devices([CommandSensor(hass, data, name, unit, value_template)])
     14   File "/usr/local/lib/python3.4/dist-packages/homeassistant/components/sensor/command_line.py", line 62, in __init__
     15     self.update()
     16   File "/usr/local/lib/python3.4/dist-packages/homeassistant/components/sensor/command_line.py", line 81, in update
     17     self.data.update()
     18   File "/usr/local/lib/python3.4/dist-packages/homeassistant/components/sensor/command_line.py", line 115, in update
     19     args_compiled = template.Template(args, self.hass)
     20 AttributeError: 'CommandSensorData' object has no attribute 'hass'

tests/components/sensor/test_command_line.py ✓⨯✓⨯⨯

balloob · 2017-07-26T16:19:17Z

The code should not call self.update() in the constructor of the class. Instead, pass True as second argument to add_devices callback.

mad-ady · 2017-08-13T02:06:43Z

@mar-schmidt: You should also send a PR to add a usage example in the docs!

mar-schmidt · 2017-08-13T04:45:29Z

@mad-ady: here you go home-assistant/home-assistant.io#3157

…assistant#8505) * Added possibilities to use template in the command_line sensor * Minor style guideline conforms * Minor style guideline conforms * Added new test for template rendering * Minor style guideline conforms * Minor style guideline conforms * Fixed failing testcases * Fix style violations * fix code pretty

Added possibilities to use template in the command_line sensor

a6ee60a

homeassistant added cla-needed platform: sensor.command_line labels Jul 16, 2017

balloobbot added the platform label Jul 16, 2017

houndci-bot reviewed Jul 16, 2017

View reviewed changes

Minor style guideline conforms

838d103

homeassistant added the cla-needed label Jul 16, 2017

houndci-bot reviewed Jul 16, 2017

View reviewed changes

Minor style guideline conforms

3c11692

homeassistant added cla-needed cla-signed and removed cla-needed labels Jul 16, 2017

Added new test for template rendering

7dd3d75

houndci-bot reviewed Jul 16, 2017

View reviewed changes

Minor style guideline conforms

1fcecf4

houndci-bot reviewed Jul 16, 2017

View reviewed changes

mar-schmidt added 3 commits July 16, 2017 19:42

Minor style guideline conforms

0b9d06c

Fixed failing testcases

e40b283

Fix style violations

3cc18e7

balloob reviewed Jul 24, 2017

View reviewed changes

balloob approved these changes Jul 24, 2017

View reviewed changes

Merge branch 'dev' into sensor.command_line-improv

35fe38c

homeassistant added the cla-signed label Aug 9, 2017

mar-schmidt mentioned this pull request Aug 9, 2017

Added documentation to HA PR#8505 home-assistant/home-assistant.io#3157

Merged

fix code pretty

5c5d5df

homeassistant added the cla-signed label Aug 10, 2017

pvizeli approved these changes Aug 10, 2017

View reviewed changes

pvizeli merged commit d7e8616 into home-assistant:dev Aug 10, 2017

mar-schmidt deleted the sensor.command_line-improv branch August 10, 2017 18:52

fabaff mentioned this pull request Aug 12, 2017

0.51 #8919

Merged

home-assistant locked and limited conversation to collaborators Dec 11, 2017

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added possibilities to use template in the command_line sensor #8505

Added possibilities to use template in the command_line sensor #8505

mar-schmidt commented Jul 16, 2017 •

edited

Loading

homeassistant commented Jul 16, 2017

mention-bot commented Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

homeassistant commented Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

homeassistant commented Jul 16, 2017

balloob commented Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

houndci-bot Jul 16, 2017

balloob Jul 24, 2017

MartinHjelmare Aug 10, 2017

balloob left a comment

mar-schmidt commented Jul 24, 2017

balloob commented Jul 26, 2017

mad-ady commented Aug 13, 2017

mar-schmidt commented Aug 13, 2017

Added possibilities to use template in the command_line sensor #8505

Added possibilities to use template in the command_line sensor #8505

Conversation

mar-schmidt commented Jul 16, 2017 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Jul 16, 2017

mention-bot commented Jul 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

homeassistant commented Jul 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

homeassistant commented Jul 16, 2017

balloob commented Jul 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob left a comment

Choose a reason for hiding this comment

mar-schmidt commented Jul 24, 2017

balloob commented Jul 26, 2017

mad-ady commented Aug 13, 2017

mar-schmidt commented Aug 13, 2017

mar-schmidt commented Jul 16, 2017 •

edited

Loading

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