Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix gtfs typing and logger issues #22572

Merged
merged 1 commit into from
Mar 31, 2019
Merged

Fix gtfs typing and logger issues #22572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 34 additions & 36 deletions homeassistant/components/gtfs/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@

def get_next_departure(schedule: Any, start_station_id: Any,
end_station_id: Any, offset: cv.time_period,
include_tomorrow: cv.boolean = False) -> dict:
include_tomorrow: bool = False) -> dict:
"""Get the next departure for the given schedule."""
now = datetime.datetime.now() + offset
now_date = now.strftime(dt_util.DATE_STR_FORMAT)
Expand All @@ -147,7 +147,7 @@ def get_next_departure(schedule: Any, start_station_id: Any,
limit = 24 * 60 * 60 * 2
tomorrow_select = tomorrow_where = tomorrow_order = ''
if include_tomorrow:
limit = limit / 2 * 3
limit = int(limit / 2 * 3)
tomorrow_name = tomorrow.strftime('%A').lower()
tomorrow_select = "calendar.{} AS tomorrow,".format(tomorrow_name)
tomorrow_where = "OR calendar.{} = 1".format(tomorrow_name)
Expand Down Expand Up @@ -218,7 +218,7 @@ def get_next_departure(schedule: Any, start_station_id: Any,
# as long as all departures are within the calendar date range.
timetable = {}
yesterday_start = today_start = tomorrow_start = None
yesterday_last = today_last = None
yesterday_last = today_last = ''

for row in result:
if row['yesterday'] == 1 and yesterday_date >= row['start_date']:
Expand Down Expand Up @@ -274,7 +274,7 @@ def get_next_departure(schedule: Any, start_station_id: Any,

_LOGGER.debug("Timetable: %s", sorted(timetable.keys()))

item = {}
item = {} # type: dict
for key in sorted(timetable.keys()):
if dt_util.parse_datetime(key) > now:
item = timetable[key]
Expand Down Expand Up @@ -350,22 +350,22 @@ def get_next_departure(schedule: Any, start_station_id: Any,

def setup_platform(hass: HomeAssistantType, config: ConfigType,
add_entities: Callable[[list], None],
discovery_info: Optional[dict] = None) -> bool:
discovery_info: Optional[dict] = None) -> None:
"""Set up the GTFS sensor."""
gtfs_dir = hass.config.path(DEFAULT_PATH)
data = str(config.get(CONF_DATA))
data = config[CONF_DATA]
origin = config.get(CONF_ORIGIN)
destination = config.get(CONF_DESTINATION)
name = config.get(CONF_NAME)
offset = config.get(CONF_OFFSET)
include_tomorrow = config.get(CONF_TOMORROW)
include_tomorrow = config[CONF_TOMORROW]

if not os.path.exists(gtfs_dir):
os.makedirs(gtfs_dir)

if not os.path.exists(os.path.join(gtfs_dir, data)):
_LOGGER.error("The given GTFS data file/folder was not found")
return False
return

import pygtfs

Expand All @@ -382,15 +382,14 @@ def setup_platform(hass: HomeAssistantType, config: ConfigType,
add_entities([
GTFSDepartureSensor(gtfs, name, origin, destination, offset,
include_tomorrow)])
return True


class GTFSDepartureSensor(Entity):
"""Implementation of a GTFS departure sensor."""

def __init__(self, pygtfs: Any, name: Optional[Any], origin: Any,
destination: Any, offset: cv.time_period,
include_tomorrow: cv.boolean) -> None:
include_tomorrow: bool) -> None:
"""Initialize the sensor."""
self._pygtfs = pygtfs
self.origin = origin
Expand All @@ -402,7 +401,7 @@ def __init__(self, pygtfs: Any, name: Optional[Any], origin: Any,
self._available = False
self._icon = ICON
self._name = ''
self._state = None
self._state = None # type: Optional[str]
self._attributes = {} # type: dict

self._agency = None
Expand All @@ -421,10 +420,8 @@ def name(self) -> str:
return self._name

@property
def state(self) -> str:
def state(self) -> Optional[str]: # type: ignore
"""Return the state of the sensor."""
if self._state is None:
return STATE_UNKNOWN
return self._state

@property
Expand Down Expand Up @@ -488,26 +485,27 @@ def update(self) -> None:
else:
trip_id = self._departure['trip_id']
if not self._trip or self._trip.trip_id != trip_id:
_LOGGER.info("Fetching trip details for %s", trip_id)
_LOGGER.debug("Fetching trip details for %s", trip_id)
self._trip = self._pygtfs.trips_by_id(trip_id)[0]

route_id = self._departure['route_id']
if not self._route or self._route.route_id != route_id:
_LOGGER.info("Fetching route details for %s", route_id)
_LOGGER.debug("Fetching route details for %s", route_id)
self._route = self._pygtfs.routes_by_id(route_id)[0]

# Fetch agency details exactly once
if self._agency is None and self._route:
_LOGGER.debug("Fetching agency details for %s",
self._route.agency_id)
try:
_LOGGER.info("Fetching agency details for %s",
self._route.agency_id)
self._agency = self._pygtfs.agencies_by_id(
self._route.agency_id)[0]
except IndexError:
_LOGGER.warning(
"Agency ID '%s' not found in agency table. You may "
"want to update the agency database table to fix this "
"missing reference.", self._route.agency_id)
"Agency ID '%s' was not found in agency table, "
"you may want to update the routes database table "
"to fix this missing reference",
self._route.agency_id)
self._agency = False

# Assign attributes, icon and name
Expand Down Expand Up @@ -540,21 +538,21 @@ def update_attributes(self) -> None:

if self._departure[ATTR_FIRST] is not None:
self._attributes[ATTR_FIRST] = self._departure['first']
elif ATTR_FIRST in self._attributes.keys():
elif ATTR_FIRST in self._attributes:
del self._attributes[ATTR_FIRST]

if self._departure[ATTR_LAST] is not None:
self._attributes[ATTR_LAST] = self._departure['last']
elif ATTR_LAST in self._attributes.keys():
elif ATTR_LAST in self._attributes:
del self._attributes[ATTR_LAST]
else:
if ATTR_ARRIVAL in self._attributes.keys():
if ATTR_ARRIVAL in self._attributes:
del self._attributes[ATTR_ARRIVAL]
if ATTR_DAY in self._attributes.keys():
if ATTR_DAY in self._attributes:
del self._attributes[ATTR_DAY]
if ATTR_FIRST in self._attributes.keys():
if ATTR_FIRST in self._attributes:
del self._attributes[ATTR_FIRST]
if ATTR_LAST in self._attributes.keys():
if ATTR_LAST in self._attributes:
del self._attributes[ATTR_LAST]

# Add contextual information
Expand All @@ -563,21 +561,21 @@ def update_attributes(self) -> None:
if self._state is None:
self._attributes[ATTR_INFO] = "No more departures" if \
self._include_tomorrow else "No more departures today"
elif ATTR_INFO in self._attributes.keys():
elif ATTR_INFO in self._attributes:
del self._attributes[ATTR_INFO]

if self._agency:
self._attributes[ATTR_ATTRIBUTION] = self._agency.agency_name
elif ATTR_ATTRIBUTION in self._attributes.keys():
elif ATTR_ATTRIBUTION in self._attributes:
del self._attributes[ATTR_ATTRIBUTION]

# Add extra metadata
key = 'agency_id'
if self._agency and key not in self._attributes.keys():
if self._agency and key not in self._attributes:
self.append_keys(self.dict_for_table(self._agency), 'Agency')

key = 'origin_station_stop_id'
if self._origin and key not in self._attributes.keys():
if self._origin and key not in self._attributes:
self.append_keys(self.dict_for_table(self._origin),
"Origin Station")
self._attributes[ATTR_LOCATION_ORIGIN] = \
Expand All @@ -590,7 +588,7 @@ def update_attributes(self) -> None:
WHEELCHAIR_BOARDING_DEFAULT)

key = 'destination_station_stop_id'
if self._destination and key not in self._attributes.keys():
if self._destination and key not in self._attributes:
self.append_keys(self.dict_for_table(self._destination),
"Destination Station")
self._attributes[ATTR_LOCATION_DESTINATION] = \
Expand All @@ -604,19 +602,19 @@ def update_attributes(self) -> None:

# Manage Route metadata
key = 'route_id'
if not self._route and key in self._attributes.keys():
if not self._route and key in self._attributes:
self.remove_keys('Route')
elif self._route and (key not in self._attributes.keys() or
elif self._route and (key not in self._attributes or
self._attributes[key] != self._route.route_id):
self.append_keys(self.dict_for_table(self._route), 'Route')
self._attributes[ATTR_ROUTE_TYPE] = \
ROUTE_TYPE_OPTIONS[self._route.route_type]

# Manage Trip metadata
key = 'trip_id'
if not self._trip and key in self._attributes.keys():
if not self._trip and key in self._attributes:
self.remove_keys('Trip')
elif self._trip and (key not in self._attributes.keys() or
elif self._trip and (key not in self._attributes or
self._attributes[key] != self._trip.trip_id):
self.append_keys(self.dict_for_table(self._trip), 'Trip')
self._attributes[ATTR_BICYCLE] = BICYCLE_ALLOWED_OPTIONS.get(
Expand Down