AmzRating.md

Class Definition

AmzRating(html_element=None):

The AmzRating class extends the AmzBase class and, as such the following attributes are available to be called as an index call or as an attribute:

• ratings_text (str): The star rating (e.g. "4.5/5").
• ratings_count_text (str): The number of votes (e.g. "100").

This class should usually not be instantiated directly (rather be used as part of an AmzProduct element) but can be created by passing an HTML element to the constructor. If nothing is passed, an empty AmzRating object is created.

Optional Args:

html_element (LXML root): A root for an HTML tree derived from an element on an Amazon search page.

Class Methods

get(key, default=None, raise_error=False):

Inherited method from AmzBase.

get_count():

Gets the total number of ratings.

Returns:

int: The number of ratings.

get_denominator():

Gets the value the star rating is out of (usually 5).

Returns:

float: The denominator of the star rating.

get_numerator():

Gets the value the average value of the star rating (usually between 0 and 5).

Returns:

float: The numerator of the star rating.

get_perc():

Gets a percentage value of the rating - 0% being a 0/5 star rating and 100% being a 5/5 star rating.

Returns:

float: The star percentage.

get_star_repr(star_repr='*'):

Gives a visual representation of the star rating, rounding to the nearest star.

Optional Args:

star_repr (str): A (typically) single character used to represent a star.

Returns:

str: A representation of the star rating.

is_valid():

Inherited method from AmzBase.

items():

Inherited method from AmzBase.

keys():

Inherited method from AmzBase.

to_dict(recursive=True, flatten=False):

Inherited method from AmzBase.

to_series(recursive=True, flatten=False):

Inherited method from AmzBase.

values():

Inherited method from AmzBase.