Add config_flow to shopping_list (#32388)
* Add config_flow to shopping_list
* Fix pylint unused import error
* Use _abort_if_unique_id_configured
* Remove SHOPPING_LIST const
* Use const.py for DOMAIN and CONF_TYPE
* Fix tests
* Remove unchanged variable _errors
* Revert CONF_TYPE (wrong usage)
* Use consts in test
* Remove import check
* Remove data={}
* Remove parameters and default values
* Re-add data={}, because it's needed
* Unique ID checks and reverts for default parameters
* remove pylint comment
* Remove block till done
* Address change requests
* Update homeassistant/components/shopping_list/strings.json
Co-Authored-By: Quentame <polletquentin74@me.com>
* Update homeassistant/components/shopping_list/strings.json
Co-Authored-By: Quentame <polletquentin74@me.com>
* Update tests/components/shopping_list/test_config_flow.py
Co-Authored-By: Quentame <polletquentin74@me.com>
* Update tests/components/shopping_list/test_config_flow.py
Co-Authored-By: Quentame <polletquentin74@me.com>
* Update tests/components/shopping_list/test_config_flow.py
Co-Authored-By: Quentame <polletquentin74@me.com>
* Update tests/components/shopping_list/test_config_flow.py
Co-Authored-By: Quentame <polletquentin74@me.com>
* Only test config_flow
* Generate translations
* Move data to end
* @asyncio.coroutine --> async def, yield from --> await
* @asyncio.coroutine --> async def, yield from --> await (tests)
* Remove init in config flow
* remove if not hass.config_entries.async_entries(DOMAIN)
* Add DOMAIN not in config
* Fix tests
* Update homeassistant/components/shopping_list/config_flow.py
Co-Authored-By: Paulus Schoutsen <paulus@home-assistant.io>
* Fix tests
* Update homeassistant/components/shopping_list/__init__.py
Co-Authored-By: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Quentame <polletquentin74@me.com>
Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
10 files changed
+163
-65
No files matched your search
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"config": {
|
||||
"abort": {
|
||||
"already_configured": "The shopping list is already configured."
|
||||
},
|
||||
"step": {
|
||||
"user": {
|
||||
"description": "Do you want to configure the shopping list?",
|
||||
"title": "Shopping List"
|
||||
}
|
||||
},
|
||||
"title": "Shopping List"
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1,10 @@
|
||||
"""Support to manage a shopping list."""
|
||||
import asyncio
|
||||
import logging
|
||||
import uuid
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.components import http, websocket_api
|
||||
from homeassistant.components.http.data_validator import RequestDataValidator
|
||||
from homeassistant.const import HTTP_BAD_REQUEST, HTTP_NOT_FOUND
|
||||
@@ -12,9 +12,10 @@ from homeassistant.core import callback
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.util.json import load_json, save_json
|
||||
|
||||
from .const import DOMAIN
|
||||
|
||||
ATTR_NAME = "name"
|
||||
|
||||
DOMAIN = "shopping_list"
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
CONFIG_SCHEMA = vol.Schema({DOMAIN: {}}, extra=vol.ALLOW_EXTRA)
|
||||
EVENT = "shopping_list_updated"
|
||||
@@ -53,20 +54,32 @@ SCHEMA_WEBSOCKET_CLEAR_ITEMS = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_setup(hass, config):
|
||||
async def async_setup(hass, config):
|
||||
"""Initialize the shopping list."""
|
||||
|
||||
@asyncio.coroutine
|
||||
def add_item_service(call):
|
||||
if DOMAIN not in config:
|
||||
return True
|
||||
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": config_entries.SOURCE_IMPORT}
|
||||
)
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def async_setup_entry(hass, config_entry):
|
||||
"""Set up shopping list from config flow."""
|
||||
|
||||
async def add_item_service(call):
|
||||
"""Add an item with `name`."""
|
||||
data = hass.data[DOMAIN]
|
||||
name = call.data.get(ATTR_NAME)
|
||||
if name is not None:
|
||||
data.async_add(name)
|
||||
|
||||
@asyncio.coroutine
|
||||
def complete_item_service(call):
|
||||
async def complete_item_service(call):
|
||||
"""Mark the item provided via `name` as completed."""
|
||||
data = hass.data[DOMAIN]
|
||||
name = call.data.get(ATTR_NAME)
|
||||
@@ -80,7 +93,7 @@ def async_setup(hass, config):
|
||||
data.async_update(item["id"], {"name": name, "complete": True})
|
||||
|
||||
data = hass.data[DOMAIN] = ShoppingData(hass)
|
||||
yield from data.async_load()
|
||||
await data.async_load()
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SERVICE_ADD_ITEM, add_item_service, schema=SERVICE_ITEM_SCHEMA
|
||||
@@ -206,8 +219,7 @@ class CreateShoppingListItemView(http.HomeAssistantView):
|
||||
name = "api:shopping_list:item"
|
||||
|
||||
@RequestDataValidator(vol.Schema({vol.Required("name"): str}))
|
||||
@asyncio.coroutine
|
||||
def post(self, request, data):
|
||||
async def post(self, request, data):
|
||||
"""Create a new shopping list item."""
|
||||
item = request.app["hass"].data[DOMAIN].async_add(data["name"])
|
||||
request.app["hass"].bus.async_fire(EVENT)
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
"""Config flow to configure ShoppingList component."""
|
||||
from homeassistant import config_entries
|
||||
|
||||
from .const import DOMAIN
|
||||
|
||||
|
||||
class ShoppingListFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
|
||||
"""Config flow for ShoppingList component."""
|
||||
|
||||
VERSION = 1
|
||||
CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_PUSH
|
||||
|
||||
async def async_step_user(self, user_input=None):
|
||||
"""Handle a flow initialized by the user."""
|
||||
# Check if already configured
|
||||
await self.async_set_unique_id(DOMAIN)
|
||||
self._abort_if_unique_id_configured()
|
||||
|
||||
if user_input is not None:
|
||||
return self.async_create_entry(title="Shopping List", data=user_input)
|
||||
|
||||
return self.async_show_form(step_id="user")
|
||||
|
||||
async_step_import = async_step_user
|
||||
@@ -0,0 +1,2 @@
|
||||
"""All constants related to the shopping list component."""
|
||||
DOMAIN = "shopping_list"
|
||||
@@ -5,5 +5,6 @@
|
||||
"requirements": [],
|
||||
"dependencies": ["http"],
|
||||
"codeowners": [],
|
||||
"config_flow": true,
|
||||
"quality_scale": "internal"
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"config": {
|
||||
"title": "Shopping List",
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "Shopping List",
|
||||
"description": "Do you want to configure the shopping list?"
|
||||
}
|
||||
},
|
||||
"abort": {
|
||||
"already_configured": "The shopping list is already configured."
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user