Skip to content

Commit

Permalink
Fix EventHandler type hints (#264)
Browse files Browse the repository at this point in the history
Signed-off-by: Dan Rose <[email protected]>
  • Loading branch information
rotu authored and jacobperron committed Jun 19, 2019
1 parent 998a916 commit 563bb7f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions launch/launch/actions/register_event_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"""Module for the RegisterEventHandler action."""

from ..action import Action
from ..event_handler import EventHandler
from ..event_handler import BaseEventHandler
from ..launch_context import LaunchContext


Expand All @@ -32,13 +32,13 @@ class RegisterEventHandler(Action):
place.
"""

def __init__(self, event_handler: EventHandler, **kwargs) -> None:
def __init__(self, event_handler: BaseEventHandler, **kwargs) -> None:
"""Constructor."""
super().__init__(**kwargs)
self.__event_handler = event_handler

@property
def event_handler(self) -> EventHandler:
def event_handler(self) -> BaseEventHandler:
"""Getter for self.__event_handler."""
return self.__event_handler

Expand Down
6 changes: 3 additions & 3 deletions launch/launch/actions/unregister_event_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@
"""Module for the UnregisterEventHandler action."""

from ..action import Action
from ..event_handler import EventHandler
from ..event_handler import BaseEventHandler
from ..launch_context import LaunchContext


class UnregisterEventHandler(Action):
"""Action that unregisters an event handler."""

def __init__(self, event_handler: EventHandler, **kwargs) -> None:
def __init__(self, event_handler: BaseEventHandler, **kwargs) -> None:
"""Constructor."""
super().__init__(**kwargs)
self.__event_handler = event_handler

@property
def event_handler(self) -> EventHandler:
def event_handler(self) -> BaseEventHandler:
"""Getter for self.__event_handler."""
return self.__event_handler

Expand Down
6 changes: 3 additions & 3 deletions launch/launch/launch_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import launch.logging

from .event import Event
from .event_handler import EventHandler
from .event_handler import BaseEventHandler
from .substitution import Substitution


Expand Down Expand Up @@ -161,11 +161,11 @@ def would_handle_event(self, event: Event) -> bool:
"""Check whether an event would be handled or not."""
return any(handler.matches(event) for handler in self._event_handlers)

def register_event_handler(self, event_handler: EventHandler) -> None:
def register_event_handler(self, event_handler: BaseEventHandler) -> None:
"""Register a event handler."""
self._event_handlers.appendleft(event_handler)

def unregister_event_handler(self, event_handler: EventHandler) -> None:
def unregister_event_handler(self, event_handler: BaseEventHandler) -> None:
"""Unregister an event handler."""
self._event_handlers.remove(event_handler)

Expand Down
4 changes: 2 additions & 2 deletions launch/launch/launch_introspector.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
from .actions import ExecuteProcess
from .actions import LogInfo
from .actions import RegisterEventHandler
from .event_handler import EventHandler
from .event_handler import BaseEventHandler
from .launch_description import LaunchDescription
from .launch_description_entity import LaunchDescriptionEntity
from .some_substitutions_type import SomeSubstitutionsType
Expand Down Expand Up @@ -80,7 +80,7 @@ def format_substitutions(substitutions: SomeSubstitutionsType) -> Text:
return ' + '.join([sub.describe() for sub in normalized_substitutions])


def format_event_handler(event_handler: EventHandler) -> List[Text]:
def format_event_handler(event_handler: BaseEventHandler) -> List[Text]:
"""Return a text representation of an event handler."""
if hasattr(event_handler, 'describe'):
# TODO(wjwwood): consider supporting mode complex descriptions of branching
Expand Down

0 comments on commit 563bb7f

Please sign in to comment.