evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add index parameter to scrape sensor (#21084)

Browse source 
* Add index parameter to scrape sensor

The scrape sensor selects the first element of the list returned by
BeautifulSoup. This commit adds an optional index parameter to allow the
selection of a different element from the list of results. To make this
a non-breaking change, if no index value is configured, the sensor
defaults to the previous behaviour of returning the first element.

* Set default value for index to avoid later checks
This commit is contained in:
David Barrera 2019-02-16 03:29:24 -05:00 • committed by Fabian Affolter
parent 539d24dd60
commit 4509caefde
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
homeassistant/components/sensor/scrape.py
View file

@ -26,6 +26,7 @@ _LOGGER = logging.getLogger(__name__)
CONF_ATTR = 'attribute' CONF_ATTR = 'attribute'
CONF_SELECT = 'select' CONF_SELECT = 'select'
CONF_INDEX = 'index'
DEFAULT_NAME = 'Web scrape' DEFAULT_NAME = 'Web scrape'
DEFAULT_VERIFY_SSL = True DEFAULT_VERIFY_SSL = True
@ -34,6 +35,7 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_RESOURCE): cv.string, vol.Required(CONF_RESOURCE): cv.string,
vol.Required(CONF_SELECT): cv.string, vol.Required(CONF_SELECT): cv.string,
vol.Optional(CONF_ATTR): cv.string, vol.Optional(CONF_ATTR): cv.string,
vol.Optional(CONF_INDEX, default=0): cv.positive_int,
vol.Optional(CONF_AUTHENTICATION): vol.Optional(CONF_AUTHENTICATION):
vol.In([HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]), vol.In([HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]),
vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}), vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}),
@ -56,6 +58,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
verify_ssl = config.get(CONF_VERIFY_SSL) verify_ssl = config.get(CONF_VERIFY_SSL)
select = config.get(CONF_SELECT) select = config.get(CONF_SELECT)
attr = config.get(CONF_ATTR) attr = config.get(CONF_ATTR)
index = config.get(CONF_INDEX)
unit = config.get(CONF_UNIT_OF_MEASUREMENT) unit = config.get(CONF_UNIT_OF_MEASUREMENT)
username = config.get(CONF_USERNAME) username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD) password = config.get(CONF_PASSWORD)
@ -77,19 +80,21 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
raise PlatformNotReady raise PlatformNotReady
add_entities([ add_entities([
ScrapeSensor(rest, name, select, attr, value_template, unit)], True) ScrapeSensor(rest, name, select, attr, index, value_template, unit)],
True)
class ScrapeSensor(Entity): class ScrapeSensor(Entity):
"""Representation of a web scrape sensor.""" """Representation of a web scrape sensor."""
def __init__(self, rest, name, select, attr, value_template, unit): def __init__(self, rest, name, select, attr, index, value_template, unit):
"""Initialize a web scrape sensor.""" """Initialize a web scrape sensor."""
self.rest = rest self.rest = rest
self._name = name self._name = name
self._state = None self._state = None
self._select = select self._select = select
self._attr = attr self._attr = attr
self._index = index
self._value_template = value_template self._value_template = value_template
self._unit_of_measurement = unit self._unit_of_measurement = unit
@ -119,9 +124,9 @@ class ScrapeSensor(Entity):
try: try:
if self._attr is not None: if self._attr is not None:
value = raw_data.select(self._select)[0][self._attr] value = raw_data.select(self._select)[self._index][self._attr]
else: else:
value = raw_data.select(self._select)[0].text value = raw_data.select(self._select)[self._index].text
_LOGGER.debug(value) _LOGGER.debug(value)
except IndexError: except IndexError:
_LOGGER.error("Unable to extract data from HTML") _LOGGER.error("Unable to extract data from HTML")