Replace 8000 emulated_hue: with emulated_hue_hidden: for consistency. #9382

rbflurry · 2017-09-11T15:22:32Z

Description:

I would like to propose the following code changes to standardize the way we choose to expose entity's to other platforms. This might be the wrong way to go about this but it is working in my situation.

Currently we use the following configs to get the same "hidden" result.

homeassistant:
  customize:
    light.demo:
      homebridge_hidden: true     # should we hide from homebridge?
      haaska_hidden: true              # should we hide from haaska?
      emulated_hue: false              # should we show to emulated_hue?

The code will continue to accept the current emulated_hue: attribute but will also except emulated_hue_hidden as well.

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

homeassistant:
  customize:
    light.demo:
      homebridge_hidden: true
      haaska_hidden: true
      emulated_hue_hidden: true

Checklist:

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:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
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:

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.

yes

houndci-bot · 2017-09-11T15:22:41Z

homeassistant/components/emulated_hue/__init__.py

+        else:
+          expose = False
+        if explicit_expose:
+            _LOGGER.warning("The attribute 'emulated_hue' is deprecated and will be removed in a"


line too long (97 > 79 characters)

houndci-bot · 2017-09-11T15:22:41Z

homeassistant/components/emulated_hue/__init__.py

+        if explicit_expose is True or explicit_hidden is False :
+          expose = True
+        else:
+          expose = False


indentation is not a multiple of four

houndci-bot · 2017-09-11T15:22:41Z

homeassistant/components/emulated_hue/__init__.py

-
+        explicit_hidden = entity.attributes.get (ATTR_EMULATED_HUE_HIDDEN, None)
+        if explicit_expose is True or explicit_hidden is False :
+          expose = True


indentation is not a multiple of four

houndci-bot · 2017-09-11T15:22:41Z

homeassistant/components/emulated_hue/__init__.py

@@ -223,17 +224,24 @@ def is_entity_exposed(self, entity):

        domain = entity.domain.lower()
        explicit_expose = entity.attributes.get(ATTR_EMULATED_HUE, None)
-
+        explicit_hidden = entity.attributes.get (ATTR_EMULATED_HUE_HIDDEN, None)
+        if explicit_expose is True or explicit_hidden is False :


whitespace before ':'

houndci-bot · 2017-09-11T15:22:41Z

homeassistant/components/emulated_hue/__init__.py

@@ -223,17 +224,24 @@ def is_entity_exposed(self, entity):

        domain = entity.domain.lower()
        explicit_expose = entity.attributes.get(ATTR_EMULATED_HUE, None)
-
+        explicit_hidden = entity.attributes.get (ATTR_EMULATED_HUE_HIDDEN, None)


whitespace before '('
line too long (80 > 79 characters)

houndci-bot · 2017-09-11T15:34:31Z

homeassistant/components/emulated_hue/__init__.py


-        return is_default_exposed or explicit_expose
+        return is_default_exposed or expose


continuation line under-indented for visual indent

houndci-bot · 2017-09-11T15:34:31Z

homeassistant/components/emulated_hue/__init__.py

        domain_exposed_by_default = \
            self.expose_by_default and domain in self.exposed_domains

        # Expose an entity if the entity's domain is exposed by default and
        # the configuration doesn't explicitly exclude it from being
        # exposed, or if the entity is explicitly exposed
        is_default_exposed = \
-            domain_exposed_by_default and explicit_expose is not False
+            domain_exposed_by_default and expose is not False


continuation line under-indented for visual indent

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

+            expose = False
+        if explicit_expose:
+            _LOGGER.warning("The attribute 'emulated_hue' is deprecated and" 
+                            "will be removed in a future version use"


unexpected indentation

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

+        else:
+            expose = False
+        if explicit_expose:
+            _LOGGER.warning("The attribute 'emulated_hue' is deprecated and" 


trailing whitespace

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

+            expose = True
+        else:
+            expose = False
+        if explicit_expose:


continuation line missing indentation or outdented
multiple statements on one line (colon)

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

+        if explicit_expose is True or explicit_hidden is False:
+            expose = True
+        else:
+            expose = False


unexpected spaces around keyword / parameter equals

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

+        explicit_hidden = entity.attributes.get ATTR_EMULATED_HUE_HIDDEN, None)
+        if explicit_expose is True or explicit_hidden is False:
+            expose = True
+        else:


continuation line missing indentation or outdented
multiple statements on one line (colon)

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

-
+        explicit_hidden = e
8000
ntity.attributes.get ATTR_EMULATED_HUE_HIDDEN, None)
+        if explicit_expose is True or explicit_hidden is False:
+            expose = True


unexpected spaces around keyword / parameter equals

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

@@ -223,17 +224,25 @@ def is_entity_exposed(self, entity):

        domain = entity.domain.lower()
        explicit_expose = entity.attributes.get(ATTR_EMULATED_HUE, None)
-
+        explicit_hidden = entity.attributes.get ATTR_EMULATED_HUE_HIDDEN, None)
+        if explicit_expose is True or explicit_hidden is False:


continuation line missing indentation or outdented
multiple statements on one line (colon)

houndci-bot · 2017-09-11T15:34:32Z

homeassistant/components/emulated_hue/__init__.py

@@ -223,17 +224,25 @@ def is_entity_exposed(self, entity):

        domain = entity.domain.lower()
        explicit_expose = entity.attributes.get(ATTR_EMULATED_HUE, None)
-
+        explicit_hidden = entity.attributes.get ATTR_EMULATED_HUE_HIDDEN, None)


SyntaxError: invalid syntax

fronzbot · 2017-09-11T17:16:52Z

Perhaps I'm misunderstanding, but If you want to standardize it wouldn't it make more sense to have a hidden attribute (or maybe exclude)? So then you can list the domains you want to hide a component from such as:

light.bedroom:
    hidden:
        - emulated_hue
        - homebridge
        - haaska

That way the implementation can scale for any number of platforms that would require certain components to be excluded from discovery.

Given the popularity of the emulated_hue platform, it seems to me that this change is disruptive without actually improving anything. My two cents anyhow. ¯\_(ツ)_/¯

houndci-bot · 2017-09-11T17:52:30Z

homeassistant/components/emulated_hue/__init__.py

+        else:
+            expose = None
+        if explicit_expose:
+            _LOGGER.warning("The attribute 'emulated_hue' is deprecated and" 


trailing whitespace

Lint errors

balloob · 2017-09-12T04:41:18Z

@fronzbot We already have a hidden attribute and it's a boolean for the frontend. Any hidden attribute for other things (emulated_hue, etc) should be via it's own attribute, no overloading. So this is the right approach.

balloob · 2017-09-12T04:42:00Z

homeassistant/components/emulated_hue/__init__.py

+        else:
+            expose = None
+        if explicit_expose:
+            _LOGGER.warning("The attribute 'emulated_hue' is deprecated and"


Use helper.deprecation helpers instead.

balloob

This will require tests to be written.

houndci-bot · 2017-09-24T21:50:57Z

tests/components/emulated_hue/test_hue_api.py

@@ -98,6 +98,14 @@ def hass_hue(loop, hass):
    hass.states.async_set(
        kitchen_light_entity.entity_id, kitchen_light_entity.state,
        attributes=attrs)
+


blank line contains whitespace

balloob · 2017-09-26T07:31:32Z

Thanks!

nikc0069 · 2017-10-08T19:32:27Z

Seems to me that the naming is confusing.

Emulated_hue_hidden: false implies it is not hidden. It should be true to hide.

nikc0069 · 2017-10-08T19:34:18Z

Unless it's the documentation that needs to be a bit clearer. Specifying false is relatively pointless as it's the same as default

kipwittchen · 2017-10-09T12:04:13Z

I agree with @nikc0069, this is very confusing. If one has expose_by_default set to false, the old way of enabling a light would have been setting emulated_hue to true. Now with emulated_hue_hidden, that would also be set to true? That makes no sense, it implies that I'm saying yes to it being hidden. Seems like haaska and emulated hue should have had their parameter changed to "visible" or "shown" so that it's clear as to what true or false does.

arsaboo · 2017-10-09T13:17:13Z

emulated_hue_hidden: false does exactly what it says - the entity is not hidden. That is the same notation we use for Homebridge.

Also, please don't use closed PRs for such discussions.

rbflurry added 2 commits August 15, 2017 14:15

Merge pull request #2 from home-assistant/dev

c281019

yes

Update __init__.py

ca6c7ef

homeassistant added cla-signed integration: emulated_hue labels Sep 11, 2017

houndci-bot reviewed Sep 11, 2017

View reviewed changes

fix lint errors

a96ccd4

homeassistant added the cla-signed label Sep 11, 2017

houndci-bot reviewed Sep 11, 2017

View reviewed changes

rbflurry added 2 commits September 11, 2017 12:22

Update __init__.py

51a5bae

Update __init__.py

78bc91d

rbflurry added 2 commits September 11, 2017 13:39

Update __init__.py

3f14d75

Update __init__.py

503bd46

houndci-bot reviewed Sep 11, 2017

View reviewed changes

Update __init__.py

db67916

Lint errors

rbflurry changed the title ~~Hide from Emulated hue attr update~~ Replace emulated_hue: with emulated_hue_hidden: for consistency. Sep 11, 2017

balloob reviewed Sep 12, 2017

View reviewed changes

balloob requested changes Sep 12, 2017

View reviewed changes

use get_deprecated instead to log old attr

9a0c99b

homeassistant added the cla-signed label Sep 24, 2017

Updated tests to hide fan.ceiling_fan

56b601b

houndci-bot reviewed Sep 24, 2017

View reviewed changes

remove space fix lint

d6617eb

balloob approved these changes Sep 26, 2017

View reviewed changes

balloob merged commit fd9ceb7 into home-assistant:dev Sep 26, 2017

balloob mentioned this pull request Oct 5, 2017

0.55 #9704

Merged

Danielhiversen mentioned this pull request Oct 8, 2017

Update docs with emulated_hue_hidden home-assistant/home-assistant.io#3554

Merged

home-assistant locked and limited conversation to collaborators Oct 10, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Replace 8000 emulated_hue: with emulated_hue_hidden: for consistency. #9382

Replace emulated_hue: with emulated_hue_hidden: for consistency. #9382

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!


		return is_default_exposed or explicit_expose
		return is_default_exposed or expose

Uh oh!

Replace 8000 emulated_hue: with emulated_hue_hidden: for consistency. #9382

Replace emulated_hue: with emulated_hue_hidden: for consistency. #9382

Uh oh!

Conversation

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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