added functionality to receive Events from Openhab and added methods to create and delete openhab items #22

galexey · 2020-12-13T13:03:58Z

I also created som testcases for the new functionality.

…nhab

need write testcases still

create item test

basic tests for setting states and commands added a method to delete items

finished documentation

sim0nx · 2020-12-13T23:52:26Z

Hi @galexey
Thanks for your PR!
That is quite a big one to review though ;-)
Could you please make sure to rebase from master and cleanup your code according to pylint, flake8 and mypy as much as possible.

What are you thoughts on using aiohttp-sse instead of threading+sseclient?

renaming of literals to python style

# Conflicts: # openhab/client.py # openhab/items.py

cleaning code regarding new codestyles

galexey · 2020-12-14T14:52:46Z

Hi!
Jep, this one grew quite big, sorry.
I merged your changes and did some major cleanup (also applied python naming style)
I haven´t used aiohttp-sse yet, but it looks nice. I might get back to your proposal and have a deeper look into it later this month.

galexey · 2020-12-16T09:09:12Z

I need to rework Commandhandling a bit. expect another commit soon.

…ands. changed handling of incoming values wrote quite a lot of testcases for creation/deletion of items wrote quite a lot of testcases for event handling

sim0nx · 2020-12-27T23:59:51Z

openhab/client.py

@@ -143,7 +375,7 @@ def fetch_all_items(self) -> typing.Dict[str, openhab.items.Item]:
    Returns:
      dict: Returns a dict with item names as key and item class instances as value.
    """
-    items = {}  # type: dict
+    items = {}  # data_type: dict


this should really be type

sim0nx · 2020-12-28T00:00:43Z

openhab/items.py

 class Item:
  """Base item class."""

-  types = []  # type: typing.List[typing.Type[openhab.types.CommandType]]
+  types = []  # data_type: typing.List[typing.Type[openhab.types.CommandType]]


this should really be type

sim0nx · 2020-12-28T00:00:50Z

openhab/items.py

-    self._state = None  # type: typing.Optional[typing.Any]
-    self._raw_state = None  # type: typing.Optional[typing.Any]  # raw state as returned by the server
-    self._members = {}  # type: typing.Dict[str, typing.Any] #  group members (key = item name), for none-group items it's empty
+    self._state = None  # data_type: typing.Optional[typing.Any]


this should really be type

sim0nx · 2020-12-28T00:00:56Z

openhab/items.py

-    self._raw_state = None  # type: typing.Optional[typing.Any]  # raw state as returned by the server
-    self._members = {}  # type: typing.Dict[str, typing.Any] #  group members (key = item name), for none-group items it's empty
+    self._state = None  # data_type: typing.Optional[typing.Any]
+    self._raw_state = None  # data_type: typing.Optional[typing.Any]  # raw state as returned by the server


this should really be type

sim0nx · 2020-12-28T00:01:00Z

openhab/items.py

-    self._members = {}  # type: typing.Dict[str, typing.Any] #  group members (key = item name), for none-group items it's empty
+    self._state = None  # data_type: typing.Optional[typing.Any]
+    self._raw_state = None  # data_type: typing.Optional[typing.Any]  # raw state as returned by the server
+    self._raw_state_event = None  # data_type: str  # raw state as received from Serverevent


this should really be type

sim0nx · 2020-12-28T00:01:05Z

openhab/items.py

+    self._state = None  # data_type: typing.Optional[typing.Any]
+    self._raw_state = None  # data_type: typing.Optional[typing.Any]  # raw state as returned by the server
+    self._raw_state_event = None  # data_type: str  # raw state as received from Serverevent
+    self._members = {}  # data_type: typing.Dict[str, typing.Any] #  group members (key = item name), for none-group items it's empty


this should really be type

sim0nx · 2020-12-28T00:01:12Z

openhab/items.py


  def _rest_format(self, value: str) -> typing.Union[str, bytes]:
    """Format a value before submitting to openHAB."""
-    _value = value  # type: typing.Union[str, bytes]
+    _value = value  # data_type: typing.Union[str, bytes]


this should really be type

sim0nx · 2020-12-28T00:01:30Z

openhab/client.py

+
+
+
+        # event = None


no commented code blocks

sim0nx · 2020-12-28T00:01:39Z

openhab/client.py

+        else:
+          self.logger.debug("item '{}' not registered. ignoring the arrived event.".format(item_name))
+
+


too many newlines

sim0nx · 2020-12-28T00:05:42Z

A couple of change requests:

please do fix linting issues (too many newlines, no newline at end of file etc)
do not use data_type in docstrings. either data type or just leave type please
could you please strip the SSE stuff into a separate pull request so that we can differentiate between code reworks, new type support, more complete API support ... and the event stream handling ?
please also fix the tests which currently fail ... there are at least import errors

Thanks

…by Georges some additions around event content bugfixes cleaned code to fix linting issues

galexey · 2020-12-30T09:29:53Z

Hi!
I cleaned the code as much as I cound and found reasonable.
the suggested aiohttp_sse_client works quite well and is a cleaner approach - thx for the hint.

However I can not split up the PRs to isolate the SSE-stuff, I had to change a lot of things in client, items and types modules for sse-implementation.

when reading images from OH

added voices added voice interpreter added cache for items

sim0nx · 2021-01-03T23:50:25Z

Hi,
I cloned your changes into a local branch and spend some time cleaning things up a bit, namely docstrings and typing.

Could you please rebase your PR on that branch ( https://github.com/sim0nx/python-openhab/tree/galexey_pr ) ... if required open a new PR.
I think it is important to have cleanly typed code as much as possible.

I would also appreciate docstrings for methods which currently have none :-)...

Thanks

… changes

added authentication to SSE through API token

more detailed logging again

…ditional thread for processing(dispatching) of events.

galexey added 5 commits December 5, 2020 01:27

initial commit for added functionality to receive ItemEvents from Ope…

4c06593

…nhab

receiving events works.

969f525

need write testcases still

ItemFactory to create new items

1ac15fb

create item test

added testcases for creation of all itemtypes

ac20567

basic tests for setting states and commands added a method to delete items

added testcases

deae6a0

finished documentation

sim0nx self-requested a review December 13, 2020 22:43

sim0nx self-assigned this Dec 13, 2020

galexey added 3 commits December 14, 2020 15:10

cleaning code (PEPs)

92864c1

renaming of literals to python style

Merge remote-tracking branch 'upstream/master'

7336dd3

# Conflicts: # openhab/client.py # openhab/items.py

merged with upstream master

50f7504

cleaning code regarding new codestyles

galexey added 2 commits December 14, 2020 17:21

updated samples in readme

47c1a9e

fixed bug in event-parsing and testcases

10e6973

major refactor to better reflect incoming states/statechange and comm…

d442ec6

…ands. changed handling of incoming values wrote quite a lot of testcases for creation/deletion of items wrote quite a lot of testcases for event handling

sim0nx requested changes Dec 28, 2020

View reviewed changes

changed Server Side Events client to aiohttp_sse_client as suggested …

628a9af

…by Georges some additions around event content bugfixes cleaned code to fix linting issues

galexey added 2 commits December 30, 2020 17:37

added http_buffersize to avoid "line too long" Exception

0b1e91e

when reading images from OH

added audiosinks

77da438

added voices added voice interpreter added cache for items

galexey added 7 commits January 20, 2021 15:59

fix for _is_my_own_echo and Eventtypes

70154e7

introduced a historylist of sent itemvalues for better echo checking

7ac50f1

changed behaviour for not yet implemented OH types

64f1799

introduced slotted sending of changes

7ddd650

changed item Factory and item creation methods for slotted sending of…

3f1ff0c

… changes

openHAB3

55477f3

added authentication to SSE through API token

added widgets

2072ede

more detailed logging again

galexey added 5 commits March 10, 2021 00:55

added widgets

9f3a21f

more detailed logging again

decoupled receiving of events from processing of events through an ad…

c3a331b

…ditional thread for processing(dispatching) of events.

changes widget behaviour

614b347

logging Q len

7ab6e9c

token store

3b7cfe7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added functionality to receive Events from Openhab and added methods to create and delete openhab items #22

added functionality to receive Events from Openhab and added methods to create and delete openhab items #22

galexey commented Dec 13, 2020

sim0nx commented Dec 13, 2020

galexey commented Dec 14, 2020

galexey commented Dec 16, 2020

sim0nx Dec 27, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx Dec 28, 2020

sim0nx commented Dec 28, 2020

galexey commented Dec 30, 2020

sim0nx commented Jan 3, 2021

		else:
		self.logger.debug("item '{}' not registered. ignoring the arrived event.".format(item_name))

added functionality to receive Events from Openhab and added methods to create and delete openhab items #22

Are you sure you want to change the base?

added functionality to receive Events from Openhab and added methods to create and delete openhab items #22

Conversation

galexey commented Dec 13, 2020

sim0nx commented Dec 13, 2020

galexey commented Dec 14, 2020

galexey commented Dec 16, 2020

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

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

sim0nx commented Dec 28, 2020

galexey commented Dec 30, 2020

sim0nx commented Jan 3, 2021