import pandas as pd
import re
from pyquery import PyQuery as pq
from .. import utils
from ..decorators import float_property_decorator, int_property_decorator
from .constants import (BOXSCORE_ELEMENT_INDEX,
BOXSCORE_SCHEME,
BOXSCORE_URL,
BOXSCORES_URL)
from functools import wraps
from sportsreference import utils
from sportsreference.constants import AWAY, HOME
[docs]def nhl_int_property_decorator(func):
@property
@wraps(func)
def wrapper(*args):
value = func(*args)
num_skaters = args[0]._away_skaters
num_goalies = args[0]._away_goalies
num = 0
# If the field is specific to goalie stats, use the number of goalies
# as an index instead of the number of skaters.
index = num_skaters
if func.__name__ in ['away_saves', 'away_shutout', 'home_saves',
'home_shutout']:
index = num_goalies
# For properties dedicated to the away team, reference the first chunk
# of skaters. Otherwise, reference the second chunk for home team
# properties.
value_subset = value[:index]
if 'home' in func.__name__:
value_subset = value[index:]
for x in value_subset:
try:
num += int(x)
except ValueError:
continue
return num
return wrapper
[docs]class Boxscore(object):
"""
Detailed information about the final statistics for a game.
Stores all relevant information for a game such as the date, time,
location, result, and more advanced metrics such as the number of goals
scored, the number of points for a player, the amount of power play assists
and much more.
Parameters
----------
uri : string
The relative link to the boxscore HTML page, such as
'201806070VEG'.
"""
def __init__(self, uri):
self._uri = uri
self._date = None
self._time = None
self._arena = None
self._attendance = None
self._duration = None
self._away_name = None
self._home_name = None
self._winner = None
self._winning_name = None
self._winning_abbr = None
self._losing_name = None
self._losing_abbr = None
self._away_goals = None
self._away_assists = None
self._away_points = None
self._away_penalties_in_minutes = None
self._away_even_strength_goals = None
self._away_power_play_goals = None
self._away_short_handed_goals = None
self._away_game_winning_goals = None
self._away_even_strength_assists = None
self._away_power_play_assists = None
self._away_short_handed_assists = None
self._away_shots_on_goal = None
self._away_shooting_percentage = None
self._away_saves = None
self._away_save_percentage = None
self._away_shutout = None
self._home_goals = None
self._home_assists = None
self._home_points = None
self._home_penalties_in_minutes = None
self._home_even_strength_goals = None
self._home_power_play_goals = None
self._home_short_handed_goals = None
self._home_game_winning_goals = None
self._home_even_strength_assists = None
self._home_power_play_assists = None
self._home_short_handed_assists = None
self._home_shots_on_goal = None
self._home_shooting_percentage = None
self._home_saves = None
self._home_save_percentage = None
self._home_shutout = None
self._parse_game_data(uri)
def _retrieve_html_page(self, uri):
"""
Download the requested HTML page.
Given a relative link, download the requested page and strip it of all
comment tags before returning a pyquery object which will be used to
parse the data.
Parameters
----------
uri : string
The relative link to the boxscore HTML page, such as
'201806070VEG'.
Returns
-------
PyQuery object
The requested page is returned as a queriable PyQuery object with
the comment tags removed.
"""
url = BOXSCORE_URL % uri
try:
url_data = pq(url)
except:
return None
return pq(utils._remove_html_comment_tags(url_data))
def _parse_game_date_and_location(self, field, boxscore):
"""
Retrieve the game's date and location.
The date and location of the game follow a more complicated parsing
scheme and should be handled differently from other tags. Both fields
are separated by a newline character ('\n') with the first line being
the date and the second being the location.
Parameters
----------
field : string
The name of the attribute to parse
boxscore : PyQuery object
A PyQuery object containing all of the HTML data from the boxscore.
Returns
-------
string
Depending on the requested field, returns a text representation of
either the date or location of the game.
"""
scheme = BOXSCORE_SCHEME[field]
items = [i.text() for i in boxscore(scheme).items()]
game_info = items[0].split('\n')
index = BOXSCORE_ELEMENT_INDEX[field]
# For playoff games, the second line (index 1) in the information block
# of the boxscore contains the name of the round. If found, the index
# will need to be updated by 1 to match the information.
if 'eastern first round' in game_info[1].lower() or \
'western first round' in game_info[1].lower() or \
'eastern second round' in game_info[1].lower() or \
'western second round' in game_info[1].lower() or \
'eastern conference finals' in game_info[1].lower() or \
'western conference finals' in game_info[1].lower() or \
'stanley cup final' in game_info[1].lower():
# The date and time fields will always be the first line of
# information and should retain their original index.
if field != 'date' and field != 'time':
index += 1
try:
return game_info[index]
except IndexError:
return ''
def _parse_name(self, field, boxscore):
"""
Retrieve the team's complete name tag.
Both the team's full name (embedded in the tag's text) and the team's
abbreviation are stored in the name tag which can be used to parse
the winning and losing team's information.
Parameters
----------
field : string
The name of the attribute to parse
boxscore : PyQuery object
A PyQuery object containing all of the HTML data from the boxscore.
Returns
-------
PyQuery object
The complete text for the requested tag.
"""
scheme = BOXSCORE_SCHEME[field]
return boxscore(scheme)
def _parse_game_data(self, uri):
"""
Parses a value for every attribute.
This function looks through every attribute and retrieves the value
according to the parsing scheme and index of the attribute from the
passed HTML data. Once the value is retrieved, the attribute's value is
updated with the returned result.
Note that this method is called directly once Boxscore is invoked and
does not need to be called manually.
Parameters
----------
uri : string
The relative link to the boxscore HTML page, such as
'201802040nwe'.
"""
boxscore = self._retrieve_html_page(uri)
# If the boxscore is None, the game likely hasn't been played yet and
# no information can be gathered. As there is nothing to grab, the
# class instance should just be empty.
if not boxscore:
return
fields_to_special_parse = [
'away_even_strength_assists',
'away_power_play_assists',
'away_short_handed_assists',
'away_game_winning_goals',
'away_saves',
'away_save_percentage',
'away_shutout',
'home_even_strength_assists',
'home_power_play_assists',
'home_short_handed_assists',
'home_game_winning_goals',
'home_saves',
'home_save_percentage',
'home_shutout'
]
for field in self.__dict__:
# Remove the '_' from the name
short_field = str(field)[1:]
if short_field == 'winner' or \
short_field == 'winning_name' or \
short_field == 'winning_abbr' or \
short_field == 'losing_name' or \
short_field == 'losing_abbr' or \
short_field == 'uri':
continue
if short_field == 'date' or \
short_field == 'time' or \
short_field == 'arena' or \
short_field == 'attendance' or \
short_field == 'time_of_day' or \
short_field == 'duration':
value = self._parse_game_date_and_location(short_field,
boxscore)
setattr(self, field, value)
continue
if short_field == 'away_name' or \
short_field == 'home_name':
value = self._parse_name(short_field, boxscore)
setattr(self, field, value)
continue
if short_field in fields_to_special_parse:
scheme = BOXSCORE_SCHEME[short_field]
value = [i.text() for i in boxscore(scheme).items()]
setattr(self, field, value)
continue
index = 0
if short_field in BOXSCORE_ELEMENT_INDEX.keys():
index = BOXSCORE_ELEMENT_INDEX[short_field]
value = utils._parse_field(BOXSCORE_SCHEME,
boxscore,
short_field,
index)
setattr(self, field, value)
self._away_skaters = len(boxscore(BOXSCORE_SCHEME['away_skaters']))
num_away_goalies = boxscore(BOXSCORE_SCHEME['away_goalies']).items()
# Skip the first element as it is dedicated to skaters and not goalies.
next(num_away_goalies)
self._away_goalies = len(next(num_away_goalies)('tbody tr'))
@property
def dataframe(self):
"""
Returns a pandas DataFrame containing all other class properties and
values. The index for the DataFrame is the string URI that is used to
instantiate the class, such as '201806070VEG'.
"""
if self._away_goals is None and self._home_goals is None:
return None
fields_to_include = {
'arena': self.arena,
'attendance': self.attendance,
'away_assists': self.away_assists,
'away_even_strength_assists': self.away_even_strength_assists,
'away_even_strength_goals': self.away_even_strength_goals,
'away_game_winning_goals': self.away_game_winning_goals,
'away_goals': self.away_goals,
'away_penalties_in_minutes': self.away_penalties_in_minutes,
'away_points': self.away_points,
'away_power_play_assists': self.away_power_play_assists,
'away_power_play_goals': self.away_power_play_goals,
'away_save_percentage': self.away_save_percentage,
'away_saves': self.away_saves,
'away_shooting_percentage': self.away_shooting_percentage,
'away_short_handed_assists': self.away_short_handed_assists,
'away_short_handed_goals': self.away_short_handed_goals,
'away_shots_on_goal': self.away_shots_on_goal,
'away_shutout': self.away_shutout,
'date': self.date,
'duration': self.duration,
'home_assists': self.home_assists,
'home_even_strength_assists': self.home_even_strength_assists,
'home_even_strength_goals': self.home_even_strength_goals,
'home_game_winning_goals': self.home_game_winning_goals,
'home_goals': self.home_goals,
'home_penalties_in_minutes': self.home_penalties_in_minutes,
'home_points': self.home_points,
'home_power_play_assists': self.home_power_play_assists,
'home_power_play_goals': self.home_power_play_goals,
'home_save_percentage': self.home_save_percentage,
'home_saves': self.home_saves,
'home_shooting_percentage': self.home_shooting_percentage,
'home_short_handed_assists': self.home_short_handed_assists,
'home_short_handed_goals': self.home_short_handed_goals,
'home_shots_on_goal': self.home_shots_on_goal,
'home_shutout': self.home_shutout,
'losing_abbr': self.losing_abbr,
'losing_name': self.losing_name,
'time': self.time,
'winner': self.winner,
'winning_abbr': self.winning_abbr,
'winning_name': self.winning_name
}
return pd.DataFrame([fields_to_include], index=[self._uri])
@property
def date(self):
"""
Returns a ``string`` of the date the game took place.
"""
# Date is in the format 'Month Day, Year, Time'. Split the date into
# the day and time by combining the text on both sides of the first
# comma.
date = self._date.split(',')
return ','.join(date[:-1])
@property
def time(self):
"""
Returns a ``string`` of the time the game started.
"""
# Time is in the format 'Month Day, Year, Time'. Split the time into
# the day and the time by taking the text after the last comma.
time = self._time.split(',')
return time[-1].strip()
@property
def arena(self):
"""
Returns a ``string`` of the name of the ballpark where the game was
played.
"""
return self._arena.replace('Arena: ', '')
@int_property_decorator
def attendance(self):
"""
Returns an ``int`` of the game's listed attendance.
"""
return self._attendance.replace('Attendance: ', '').replace(',', '')
@property
def duration(self):
"""
Returns a ``string`` of the game's duration in the format 'H:MM'.
"""
return self._duration.replace('Game Duration: ', '')
@property
def winner(self):
"""
Returns a ``string`` constant indicating whether the home or away team
won.
"""
if self.home_goals > self.away_goals:
return HOME
return AWAY
@property
def winning_name(self):
"""
Returns a ``string`` of the winning team's name, such as 'Vegas Golden
Knights'.
"""
if self.winner == HOME:
return self._home_name.text()
return self._away_name.text()
@property
def winning_abbr(self):
"""
Returns a ``string`` of the winning team's abbreviation, such as 'VEG'
for the Vegas Golden Knights.
"""
if self.winner == HOME:
return utils._parse_abbreviation(self._home_name)
return utils._parse_abbreviation(self._away_name)
@property
def losing_name(self):
"""
Returns a ``string`` of the losing team's name, such as 'Washington
Capitals'.
"""
if self.winner == HOME:
return self._away_name.text()
return self._home_name.text()
@property
def losing_abbr(self):
"""
Returns a ``string`` of the losing team's abbreviation, such as 'WSH'
for the Washington Capitals.
"""
if self.winner == HOME:
return utils._parse_abbreviation(self._away_name)
return utils._parse_abbreviation(self._home_name)
@int_property_decorator
def away_goals(self):
"""
Returns an ``int`` of the number of goals the away team scored.
"""
return self._away_goals
@int_property_decorator
def away_assists(self):
"""
Returns an ``int`` of the number of assists the away team registered.
"""
return self._away_assists
@int_property_decorator
def away_points(self):
"""
Returns an ``int`` of the number of points the away team registered.
"""
return self._away_points
@int_property_decorator
def away_penalties_in_minutes(self):
"""
Returns an ``int`` of the length of time the away team spent in the
penalty box.
"""
return self._away_penalties_in_minutes
@int_property_decorator
def away_even_strength_goals(self):
"""
Returns an ``int`` of the number of goals the away team scored at even
strength.
"""
return self._away_even_strength_goals
@int_property_decorator
def away_power_play_goals(self):
"""
Returns an ``int`` of the number of goals the away team scored while on
a power play.
"""
return self._away_power_play_goals
@int_property_decorator
def away_short_handed_goals(self):
"""
Returns an ``int`` of the number of goals the away team scored while
short handed.
"""
return self._away_short_handed_goals
@nhl_int_property_decorator
def away_game_winning_goals(self):
"""
Returns an ``int`` of the number of game winning goals the away team
scored.
"""
return self._away_game_winning_goals
@nhl_int_property_decorator
def away_even_strength_assists(self):
"""
Returns an ``int`` of the number of assists the away team registered
while at even strength.
"""
return self._away_even_strength_assists
@nhl_int_property_decorator
def away_power_play_assists(self):
"""
Returns an ``int`` of the number of assists the away team registered
while on a power play.
"""
return self._away_power_play_assists
@nhl_int_property_decorator
def away_short_handed_assists(self):
"""
Returns an ``int`` of the number of assists the away team registered
while short handed.
"""
return self._away_short_handed_assists
@int_property_decorator
def away_shots_on_goal(self):
"""
Returns an ``int`` of the number of shots on goal the away team
registered.
"""
return self._away_shots_on_goal
@float_property_decorator
def away_shooting_percentage(self):
"""
Returns a ``float`` of the away team's shooting percentage. Percentage
ranges from 0-100.
"""
return self._away_shooting_percentage
@nhl_int_property_decorator
def away_saves(self):
"""
Returns an ``int`` of the number of saves the away team made.
"""
return self._away_saves
@property
def away_save_percentage(self):
"""
Returns a ``float`` of the percentage of shots the away team saved.
Percentage ranges from 0-1.
"""
try:
save_pct = float(self.away_saves) / float(self.home_shots_on_goal)
return round(save_pct, 3)
except ZeroDivisionError:
return 0.0
@nhl_int_property_decorator
def away_shutout(self):
"""
Returns an ``int`` denoting whether or not the away team shutout the
home team.
"""
return self._away_shutout
@int_property_decorator
def home_goals(self):
"""
Returns an ``int`` of the number of goals the home team scored.
"""
return self._home_goals
@int_property_decorator
def home_assists(self):
"""
Returns an ``int`` of the number of assists the home team registered.
"""
return self._home_assists
@int_property_decorator
def home_points(self):
"""
Returns an ``int`` of the number of points the home team registered.
"""
return self._home_points
@int_property_decorator
def home_penalties_in_minutes(self):
"""
Returns an ``int`` of the length of time the home team spent in the
penalty box.
"""
return self._home_penalties_in_minutes
@int_property_decorator
def home_even_strength_goals(self):
"""
Returns an ``int`` of the number of goals the home team scored at even
strength.
"""
return self._home_even_strength_goals
@int_property_decorator
def home_power_play_goals(self):
"""
Returns an ``int`` of the number of goals the home team scored while on
a power play.
"""
return self._home_power_play_goals
@int_property_decorator
def home_short_handed_goals(self):
"""
Returns an ``int`` of the number of goals the home team scored while
short handed.
"""
return self._home_short_handed_goals
@nhl_int_property_decorator
def home_game_winning_goals(self):
"""
Returns an ``int`` of the number of game winning goals the home team
scored.
"""
return self._home_game_winning_goals
@nhl_int_property_decorator
def home_even_strength_assists(self):
"""
Returns an ``int`` of the number of assists the home team registered
while at even strength.
"""
return self._home_even_strength_assists
@nhl_int_property_decorator
def home_power_play_assists(self):
"""
Returns an ``int`` of the number of assists the home team registered
while on a power play.
"""
return self._home_power_play_assists
@nhl_int_property_decorator
def home_short_handed_assists(self):
"""
Returns an ``int`` of the number of assists the home team registered
while short handed.
"""
return self._home_short_handed_assists
@int_property_decorator
def home_shots_on_goal(self):
"""
Returns an ``int`` of the number of shots on goal the home team
registered.
"""
return self._home_shots_on_goal
@float_property_decorator
def home_shooting_percentage(self):
"""
Returns a ``float`` of the home team's shooting percentage. Percentage
ranges from 0-100.
"""
return self._home_shooting_percentage
@nhl_int_property_decorator
def home_saves(self):
"""
Returns an ``int`` of the number of saves the home team made.
"""
return self._home_saves
@property
def home_save_percentage(self):
"""
Returns a ``float`` of the percentage of shots the home team saved.
Percentage ranges from 0-1.
"""
try:
save_pct = float(self.home_saves) / float(self.away_shots_on_goal)
return round(save_pct, 3)
except ZeroDivisionError:
return 0.0
@nhl_int_property_decorator
def home_shutout(self):
"""
Returns an ``int`` denoting whether or not the home team shutout the
home team.
"""
return self._home_shutout
[docs]class Boxscores:
"""
Search for NHL games taking place on a particular day.
Retrieve a dictionary which contains a list of all games being played on a
particular day. Output includes a link to the boxscore, and the names and
abbreviations for both the home teams. If no games are played on a
particular day, the list will be empty.
Parameters
----------
date : datetime object
The date to search for any matches. The month, day, and year are
required for the search, but time is not factored into the search.
"""
def __init__(self, date):
self._boxscores = {'boxscores': []}
self._find_games(date)
@property
def games(self):
"""
Returns a ``dictionary`` object representing all of the games played on
the requested day. Dictionary is in the following format::
{'boxscores' : [
{'home_name': Name of the home team, such as 'New York
Rangers' (`str`),
'home_abbr': Abbreviation for the home team, such as
'NYR' (`str`),
'away_name': Name of the away team, such as 'Boston
Bruins' (`str`),
'away_abbr': Abbreviation for the away team, such as
'BOS' (`str`),
'boxscore': String representing the boxscore URI, such as
'201702040VAN' (`str`)},
{ ... },
...
]
}
If no games were played during the requested day, the list for
['boxscores'] will be empty.
"""
return self._boxscores
def _create_url(self, date):
"""
Build the URL based on the passed datetime object.
In order to get the proper boxscore page, the URL needs to include the
requested month, day, and year.
Parameters
----------
date : datetime object
The date to search for any matches. The month, day, and year are
required for the search, but time is not factored into the search.
Returns
-------
string
Returns a ``string`` of the boxscore URL including the requested
date.
"""
return BOXSCORES_URL % (date.month, date.day, date.year)
def _get_requested_page(self, url):
"""
Get the requested page.
Download the requested page given the created URL and return a PyQuery
object.
Parameters
----------
url : string
The URL containing the boxscores to find.
Returns
-------
PyQuery object
A PyQuery object containing the HTML contents of the requested
page.
"""
return pq(url)
def _get_boxscore_uri(self, url):
"""
Find the boxscore URI.
Given the boxscore tag for a game, parse the embedded URI for the
boxscore.
Parameters
----------
url : PyQuery object
A PyQuery object containing the game's boxscore tag which has the
boxscore URI embedded within it.
Returns
-------
string
Returns a ``string`` containing the link to the game's boxscore
page.
"""
uri = re.sub(r'.*/boxscores/', '', str(url))
uri = re.sub(r'\.html.*', '', uri).strip()
return uri
def _parse_abbreviation(self, abbr):
"""
Parse a team's abbreviation.
Given the team's HTML name tag, parse their abbreviation.
Parameters
----------
abbr : string
A string of a team's HTML name tag.
Returns
-------
string
Returns a ``string`` of the team's abbreviation.
"""
abbr = re.sub(r'.*/teams/', '', str(abbr))
abbr = re.sub(r'/.*', '', abbr)
return abbr
def _get_name(self, name):
"""
Find a team's name and abbreviation.
Given the team's HTML name tag, determine their name, and abbreviation.
Parameters
----------
name : PyQuery object
A PyQuery object of a team's HTML name tag in the boxscore.
Returns
-------
tuple
Returns a tuple containing the name and abbreviation for a team.
Tuple is in the following order: Team Name, Team Abbreviation.
"""
team_name = name.text()
abbr = self._parse_abbreviation(name)
return team_name, abbr
def _get_team_names(self, game):
"""
Find the names and abbreviations for both teams in a game.
Using the HTML contents in a boxscore, find the name and abbreviation
for both teams.
Parameters
----------
game : PyQuery object
A PyQuery object of a single boxscore containing information about
both teams.
Returns
-------
tuple
Returns a tuple containing the names and abbreviations of both
teams in the following order: Away Name, Away Abbreviation, Home
Name, Home Abbreviation.
"""
links = [i for i in game('td a').items()]
# The away team is the first link in the boxscore
away = links[0]
# The home team is the last (3rd) link in the boxscore
home = links[-1]
away_name, away_abbr = self._get_name(away)
home_name, home_abbr = self._get_name(home)
return away_name, away_abbr, home_name, home_abbr
def _extract_game_info(self, games):
"""
Parse game information from all boxscores.
Find the major game information for all boxscores listed on a
particular boxscores webpage and return the results in a list.
Parameters
----------
games : generator
A generator where each element points to a boxscore on the parsed
boxscores webpage.
Returns
-------
list
Returns a ``list`` of dictionaries where each dictionary contains
the name and abbreviations for both the home and away teams, and a
link to the game's boxscore.
"""
all_boxscores = []
for game in games:
names = self._get_team_names(game)
away_name, away_abbr, home_name, home_abbr = names
boxscore_url = game('td[class="right gamelink"] a')
boxscore_uri = self._get_boxscore_uri(boxscore_url)
game_info = {
'boxscore': boxscore_uri,
'away_name': away_name,
'away_abbr': away_abbr,
'home_name': home_name,
'home_abbr': home_abbr
}
all_boxscores.append(game_info)
return all_boxscores
def _find_games(self, date):
"""
Retrieve all major games played on a given day.
Builds a URL based on the requested date and downloads the HTML
contents before parsing any and all games played during that day. Any
games that are found are added to the boxscores dictionary with
high-level game information such as the home and away team names and a
link to the boxscore page.
Parameters
----------
date : datetime object
The date to search for any matches. The month, day, and year are
required for the search, but time is not factored into the search.
"""
url = self._create_url(date)
page = self._get_requested_page(url)
games = page('table[class="teams"]').items()
boxscores = self._extract_game_info(games)
self._boxscores = {'boxscores': boxscores}