Python spotcrime by jcconnell · Pull Request #12460 · home-assistant/core

jcconnell · 2018-02-16T14:36:38Z

Description:

Added support for the Spot Crime API.

Related issue (if applicable): fixes #

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#4685

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: spotcrime
     name: Spot Crime
     days: 8
     radius: 0.05 # 5 miles

Checklist:

The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2018-02-16T14:36:40Z

Hi @jcconnell,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

happyleavesaoc · 2018-02-16T14:57:12Z

Neat! Is this ultimately the same data as crimereports, or is there some other advantage?

jcconnell · 2018-02-16T15:04:41Z

Hi! I used your code as a template since this is my first time contributing (both to HASS and OSS).

I used crimereports in my HA installation for a while, but never received any notice of an incident. After digging in a bit further, I realized that Crime Reports doesn't receive any notifications in my area, but Spot Crime does. I don't know of their specific differences across the states but in my area, Spot Crime provides some results where Crime Reports didn't.

happyleavesaoc

You'll want to remove man/man1/nosetests.1 from the PR. I think it got accidently included.

jcconnell · 2018-02-16T17:11:14Z

@happyleavesaoc Thank you for the help! I'm not very familiar with this process. What's the best way to remove the file from the PR?

balloob · 2018-02-16T17:16:12Z

git rm man/man1/nosetests.1
git commit -m "Remove accidental included file"
git push

pvizeli · 2018-02-16T19:16:47Z

 CONF_CUSTOMIZE = 'customize'
 CONF_CUSTOMIZE_DOMAIN = 'customize_domain'
 CONF_CUSTOMIZE_GLOB = 'customize_glob'
+CONF_DAYS = 'days'


Do that only if you can replace it and use it on other components/platform

What should I remove or how should I change it to be correct?

I think @pvizeli is saying that const.py is for constants that are broadly applicable; as far as we know, CONF_DAYS is only useful to your platform at the moment. So, until it's determined otherwise, it's best placed within spotcrime.py.

Thank you @bachya, I see now. I did not understand well enough how to bring in the configuration variables. Some of the information at this link gave me a better idea: https://community.home-assistant.io/t/help-using-config-get-for-custom-platform-switch/4092/2. I am working to do it the correct way now.

MartinHjelmare · 2018-02-21T09:27:17Z

+CONF_DAYS = 'days'
+DEFAULT_DAYS = 1
+
+DOMAIN = 'spotcrime'


This platform is part of the sensor domain. So don't overwrite that. If you need a constant to be used multiple times, just rename it to something else.

MartinHjelmare · 2018-02-21T09:29:51Z

+    """Set up the Crime Reports platform."""
+    latitude = config.get(CONF_LATITUDE, hass.config.latitude)
+    longitude = config.get(CONF_LONGITUDE, hass.config.longitude)
+    name = config.get(CONF_NAME)


The name is required in the config schema, so don't use dict.get. Do:

name = config[CONF_NAME]

MartinHjelmare · 2018-02-21T09:30:06Z

+    latitude = config.get(CONF_LATITUDE, hass.config.latitude)
+    longitude = config.get(CONF_LONGITUDE, hass.config.longitude)
+    name = config.get(CONF_NAME)
+    radius = config.get(CONF_RADIUS)


Same as above.

MartinHjelmare · 2018-02-21T09:30:58Z

+class SpotCrimeSensor(Entity):
+    """Representation of a Spot Crime Sensor."""
+
+    def __init__(self, hass, name, latitude, longitude, radius,


Don't pass in hass. It will be set on the entity when it has been added to home assistant.

MartinHjelmare · 2018-02-21T09:31:16Z

+                 include, exclude, days):
+        """Initialize the Spot Crime sensor."""
+        import spotcrime
+        self._hass = hass


Remove this.

MartinHjelmare · 2018-02-21T09:33:16Z

+                ATTR_LATITUDE: incident.get('lat'),
+                ATTR_LONGITUDE: incident.get('lon')
+            })
+        self._hass.bus.fire(EVENT_INCIDENT, data)


Use self.hass.

MartinHjelmare · 2018-02-21T17:09:03Z

+        import spotcrime
+        incident_counts = defaultdict(int)
+        incidents = self._spotcrime.get_incidents()
+        fire_events = len(self._previous_incidents) > 0


You don't need to define a new variable here. Just check if self._previous_incidents is truthy below.

MartinHjelmare · 2018-02-21T17:20:00Z

+        for incident in incidents:
+            incident_type = slugify(incident.get('type'))
+            incident_counts[incident_type] += 1
+            if (fire_events and incident.get('id')


if (self._previous_incidents and incident.get('id') not in self._previous_incidents):

MartinHjelmare · 2018-02-21T17:21:02Z

+                self._incident_event(incident)
+            self._previous_incidents.add(incident.get('id'))
+        self._attributes = {
+            ATTR_ATTRIBUTION: spotcrime.ATTRIBUTION


Do this in init instead.

houndci-bot · 2018-02-21T17:54:02Z

+
+    def update(self):
+        """Update device state."""
+        import spotcrime


'spotcrime' imported but unused

MartinHjelmare

Looks good!

MartinHjelmare · 2018-02-21T17:57:24Z

Fix the lint issue and we can merge.

jcconnell · 2018-02-21T17:58:38Z

@MartinHjelmare Thank you for the review! Really appreciate the detail. Removed the un-needed import and I think I fixed the lint issue. Testing now.

jcconnell · 2018-02-22T17:36:22Z

Nice! Thanks for all the help on my first go everyone!

jcconnell added 2 commits February 16, 2018 13:59

Added python-spotcrime sensor

a2af3c4

Added python-spotcrime sensor

6f24664

jcconnell requested review from a team and andrey-git as code owners February 16, 2018 14:36

homeassistant added cla-needed core new-platform platform: sensor.spotcrime cla-signed and removed cla-needed labels Feb 16, 2018

happyleavesaoc requested changes Feb 16, 2018

View reviewed changes

Remove accidental included file

e813395

homeassistant added the cla-signed label Feb 16, 2018

Update indentation to match PEP8

b4881c8

happyleavesaoc approved these changes Feb 16, 2018

View reviewed changes

pvizeli reviewed Feb 16, 2018

View reviewed changes

jcconnell added 2 commits February 19, 2018 19:03

Remove days from const.py

1f4fbd4

Changed default days to 1

b91e594

homeassistant added the cla-signed label Feb 19, 2018

MartinHjelmare removed the core label Feb 21, 2018

MartinHjelmare requested changes Feb 21, 2018

View reviewed changes

Incorporate changes requested by MartinHjelmare

525abad

homeassistant added the cla-signed label Feb 21, 2018

houndci-bot reviewed Feb 21, 2018

View reviewed changes

MartinHjelmare approved these changes Feb 21, 2018

View reviewed changes

Remove unnecessary import and fix lint error

0fe2c6d

homeassistant added the cla-signed label Feb 21, 2018

balloob merged commit 4fdbbc4 into home-assistant:dev Feb 22, 2018

balloob mentioned this pull request Feb 22, 2018

0.64.0 #12609

Merged

home-assistant locked and limited conversation to collaborators May 29, 2018

ghost added integration: spotcrime and removed platform: sensor.spotcrime labels Mar 21, 2019

Uh oh!

Conversation

jcconnell commented Feb 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

homeassistant commented Feb 16, 2018

Uh oh!

happyleavesaoc commented Feb 16, 2018

Uh oh!

jcconnell commented Feb 16, 2018

Uh oh!

happyleavesaoc left a comment

Choose a reason for hiding this comment

Uh oh!

jcconnell commented Feb 16, 2018

Uh oh!

balloob commented Feb 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare commented Feb 21, 2018

Uh oh!

jcconnell commented Feb 21, 2018

Uh oh!

jcconnell commented Feb 22, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jcconnell commented Feb 16, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):