mycroft.util.parse

The mycroft.util.parse module provides various parsing functions for things like numbers, times, durations etc.

The focus of these parsing functions is to extract data from natural speech and to allow localization.

mycroft.util.parse.extract_datetime(text, anchorDate=None, lang=None, default_time=None)[source]

Extracts date and time information from a sentence. Parses many of the common ways that humans express dates and times, including relative dates like “5 days from today”, “tomorrow’, and “Tuesday”.

Vague terminology are given arbitrary values, like:
  • morning = 8 AM
  • afternoon = 3 PM
  • evening = 7 PM

If a time isn’t supplied or implied, the function defaults to 12 AM

Parameters:
  • text (str) – the text to be interpreted
  • anchorDate (datetime, optional) – the date to be used for relative dating (for example, what does “tomorrow” mean?). Defaults to the current local date/time.
  • lang (str) – the BCP-47 code for the language to use, None uses default
  • default_time (datetime.time) – time to use if none was found in the input string.
Returns:

‘datetime’ is the extracted date

as a datetime object in the user’s local timezone. ‘leftover_string’ is the original phrase with all date and time related keywords stripped out. See examples for further clarification

Returns ‘None’ if no date or time related text is found.

Return type:

[datetime, str]

Examples

>>> extract_datetime(
... "What is the weather like the day after tomorrow?",
... datetime(2017, 06, 30, 00, 00)
... )
[datetime.datetime(2017, 7, 2, 0, 0), 'what is weather like']
>>> extract_datetime(
... "Set up an appointment 2 weeks from Sunday at 5 pm",
... datetime(2016, 02, 19, 00, 00)
... )
[datetime.datetime(2016, 3, 6, 17, 0), 'set up appointment']
>>> extract_datetime(
... "Set up an appointment",
... datetime(2016, 02, 19, 00, 00)
... )
None
mycroft.util.parse.extract_duration(text, lang=None)[source]

Convert an english phrase into a number of seconds

Convert things like:
“10 minute” “2 and a half hours” “3 days 8 hours 10 minutes and 49 seconds”

into an int, representing the total number of seconds.

The words used in the duration will be consumed, and the remainder returned.

As an example, “set a timer for 5 minutes” would return (300, “set a timer for”).

Parameters:
  • text (str) – string containing a duration
  • lang (str) – the BCP-47 code for the language to use, None uses default
Returns:

A tuple containing the duration and the remaining text not consumed in the parsing. The first value will be None if no duration is found. The text returned will have whitespace stripped from the ends.

Return type:

(timedelta, str)

mycroft.util.parse.extract_number(text, short_scale=True, ordinals=False, lang=None)[source]

Takes in a string and extracts a number.

Parameters:
  • text (str) – the string to extract a number from
  • short_scale (bool) – Use “short scale” or “long scale” for large numbers – over a million. The default is short scale, which is now common in most English speaking countries. See https://en.wikipedia.org/wiki/Names_of_large_numbers
  • ordinals (bool) – consider ordinal numbers, e.g. third=3 instead of 1/3
  • lang (str) – the BCP-47 code for the language to use, None uses default
Returns:

The number extracted or False if the input

text contains no numbers

Return type:

(int, float or False)

mycroft.util.parse.extract_numbers(text, short_scale=True, ordinals=False, lang=None)[source]
Takes in a string and extracts a list of numbers.
Parameters:
  • text (str) – the string to extract a number from
  • short_scale (bool) – Use “short scale” or “long scale” for large numbers – over a million. The default is short scale, which is now common in most English speaking countries. See https://en.wikipedia.org/wiki/Names_of_large_numbers
  • ordinals (bool) – consider ordinal numbers, e.g. third=3 instead of 1/3
  • lang (str) – the BCP-47 code for the language to use, None uses default
Returns:

list of extracted numbers as floats, or empty list if none found

Return type:

list

mycroft.util.parse.fuzzy_match(x, against)[source]

Perform a ‘fuzzy’ comparison between two strings. :returns:

match percentage – 1.0 for perfect match,
down to 0.0 for no match at all.
Return type:float
mycroft.util.parse.get_gender(word, context='', lang=None)[source]

Guess the gender of a word

Some languages assign genders to specific words. This method will attempt to determine the gender, optionally using the provided context sentence.

Parameters:
  • word (str) – The word to look up
  • context (str, optional) – String containing word, for context
  • lang (str) – the BCP-47 code for the language to use, None uses default
Returns:

The code “m” (male), “f” (female) or “n” (neutral) for the gender,

or None if unknown/or unused in the given language.

Return type:

str

mycroft.util.parse.match_one(query, choices)[source]

Find best match from a list or dictionary given an input

Parameters:
  • query – string to test
  • choices – list or dictionary of choices

Returns: tuple with best match, score

mycroft.util.parse.normalize(text, lang=None, remove_articles=True)[source]

Prepare a string for parsing

This function prepares the given text for parsing by making numbers consistent, getting rid of contractions, etc.

Parameters:
  • text (str) – the string to normalize
  • lang (str) – the BCP-47 code for the language to use, None uses default
  • remove_articles (bool) – whether to remove articles (like ‘a’, or ‘the’). True by default.
Returns:

The normalized string.

Return type:

(str)