mycroft-core/test/unittests/util/test_format.py

407 lines
19 KiB
Python
Executable File

# -*- coding: iso-8859-15 -*-
#
# Copyright 2017 Mycroft AI Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import json
import unittest
import datetime
import ast
from pathlib import Path
from mycroft.util.format import nice_number
from mycroft.util.format import nice_time
from mycroft.util.format import nice_date
from mycroft.util.format import nice_date_time
from mycroft.util.format import nice_year
from mycroft.util.format import pronounce_number
from mycroft.util.format import date_time_format
NUMBERS_FIXTURE_EN = {
1.435634: '1.436',
2: '2',
5.0: '5',
0.027: '0.027',
0.5: 'a half',
1.333: '1 and a third',
2.666: '2 and 2 thirds',
0.25: 'a forth',
1.25: '1 and a forth',
0.75: '3 forths',
1.75: '1 and 3 forths',
3.4: '3 and 2 fifths',
16.8333: '16 and 5 sixths',
12.5714: '12 and 4 sevenths',
9.625: '9 and 5 eigths',
6.777: '6 and 7 ninths',
3.1: '3 and a tenth',
2.272: '2 and 3 elevenths',
5.583: '5 and 7 twelveths',
8.384: '8 and 5 thirteenths',
0.071: 'a fourteenth',
6.466: '6 and 7 fifteenths',
8.312: '8 and 5 sixteenths',
2.176: '2 and 3 seventeenths',
200.722: '200 and 13 eighteenths',
7.421: '7 and 8 nineteenths',
0.05: 'a twentyith'
}
class TestNiceNumberFormat(unittest.TestCase):
def test_convert_float_to_nice_number(self):
for number, number_str in NUMBERS_FIXTURE_EN.items():
self.assertEqual(nice_number(number), number_str,
'should format {} as {} and not {}'.format(
number, number_str, nice_number(number)))
def test_specify_denominator(self):
self.assertEqual(nice_number(5.5, denominators=[1, 2, 3]),
'5 and a half',
'should format 5.5 as 5 and a half not {}'.format(
nice_number(5.5, denominators=[1, 2, 3])))
self.assertEqual(nice_number(2.333, denominators=[1, 2]),
'2.333',
'should format 2.333 as 2.333 not {}'.format(
nice_number(2.333, denominators=[1, 2])))
def test_no_speech(self):
self.assertEqual(nice_number(6.777, speech=False),
'6 7/9',
'should format 6.777 as 6 7/9 not {}'.format(
nice_number(6.777, speech=False)))
self.assertEqual(nice_number(6.0, speech=False),
'6',
'should format 6.0 as 6 not {}'.format(
nice_number(6.0, speech=False)))
def test_different_language(self):
self.assertEqual(nice_number(5.5, lang="es-us"), '5.5',
'should format 5.5 as 5.5 not {}'.format(
nice_number(5.5, lang="es-us")))
# def pronounce_number(number, lang="en-us", places=2):
class TestPronounceNumber(unittest.TestCase):
def test_convert_int(self):
self.assertEqual(pronounce_number(0), "zero")
self.assertEqual(pronounce_number(1), "one")
self.assertEqual(pronounce_number(10), "ten")
self.assertEqual(pronounce_number(15), "fifteen")
self.assertEqual(pronounce_number(20), "twenty")
self.assertEqual(pronounce_number(27), "twenty seven")
self.assertEqual(pronounce_number(30), "thirty")
self.assertEqual(pronounce_number(33), "thirty three")
def test_convert_negative_int(self):
self.assertEqual(pronounce_number(-1), "negative one")
self.assertEqual(pronounce_number(-10), "negative ten")
self.assertEqual(pronounce_number(-15), "negative fifteen")
self.assertEqual(pronounce_number(-20), "negative twenty")
self.assertEqual(pronounce_number(-27), "negative twenty seven")
self.assertEqual(pronounce_number(-30), "negative thirty")
self.assertEqual(pronounce_number(-33), "negative thirty three")
def test_convert_decimals(self):
self.assertEqual(pronounce_number(1.234),
"one point two three")
self.assertEqual(pronounce_number(21.234),
"twenty one point two three")
self.assertEqual(pronounce_number(21.234, places=1),
"twenty one point two")
self.assertEqual(pronounce_number(21.234, places=0),
"twenty one")
self.assertEqual(pronounce_number(21.234, places=3),
"twenty one point two three four")
self.assertEqual(pronounce_number(21.234, places=4),
"twenty one point two three four")
self.assertEqual(pronounce_number(21.234, places=5),
"twenty one point two three four")
self.assertEqual(pronounce_number(-1.234),
"negative one point two three")
self.assertEqual(pronounce_number(-21.234),
"negative twenty one point two three")
self.assertEqual(pronounce_number(-21.234, places=1),
"negative twenty one point two")
self.assertEqual(pronounce_number(-21.234, places=0),
"negative twenty one")
self.assertEqual(pronounce_number(-21.234, places=3),
"negative twenty one point two three four")
self.assertEqual(pronounce_number(-21.234, places=4),
"negative twenty one point two three four")
self.assertEqual(pronounce_number(-21.234, places=5),
"negative twenty one point two three four")
def test_convert_hundreds(self):
self.assertEqual(pronounce_number(100), "one hundred")
self.assertEqual(pronounce_number(666), "six hundred and sixty six")
self.assertEqual(pronounce_number(1456), "fourteen fifty six")
self.assertEqual(pronounce_number(103254654), "one hundred and three "
"million, two hundred "
"and fifty four "
"thousand, six hundred "
"and fifty four")
self.assertEqual(pronounce_number(1512457), "one million, five hundred"
" and twelve thousand, "
"four hundred and fifty "
"seven")
self.assertEqual(pronounce_number(209996), "two hundred and nine "
"thousand, nine hundred "
"and ninety six")
self.assertEqual(pronounce_number(95505896639631893),
"ninety five quadrillion, five hundred and five "
"trillion, eight hundred and ninety six billion, six "
"hundred and thirty nine million, six hundred and "
"thirty one thousand, eight hundred and ninety three")
self.assertEqual(pronounce_number(95505896639631893,
short_scale=False),
"ninety five thousand five hundred and five billion, "
"eight hundred and ninety six thousand six hundred "
"and thirty nine million, six hundred and thirty one "
"thousand, eight hundred and ninety three")
def test_convert_scientific_notation(self):
self.assertEqual(pronounce_number(0, scientific=True), "zero")
self.assertEqual(pronounce_number(33, scientific=True),
"three point three times ten to the power of one")
self.assertEqual(pronounce_number(299792458, scientific=True),
"two point nine nine times ten to the power of eight")
self.assertEqual(pronounce_number(299792458, places=6,
scientific=True),
"two point nine nine seven nine two five times "
"ten to the power of eight")
self.assertEqual(pronounce_number(1.672e-27, places=3,
scientific=True),
"one point six seven two times ten to the power of "
"negative twenty seven")
def test_large_numbers(self):
self.assertEqual(pronounce_number(299792458, short_scale=True),
"two hundred ninety nine million seven hundred ninety two thousand four hundred fifty eight")
self.assertEqual(pronounce_number(299792458, short_scale=False),
"two hundred ninety nine million seven hundred ninety two thousand four hundred fifty eight")
self.assertEqual(pronounce_number(100034000299792458, short_scale=True),
"one hundred quintillion thirty four quadrillion"
"two hundred ninety nine million seven hundred ninety two thousand four hundred fifty eight")
self.assertEqual(pronounce_number(100034000299792458, short_scale=False),
"one hundred trillion thirty four thousand billion"
"two hundred ninety nine million seven hundred ninety two thousand four hundred fifty eight")
# def nice_time(dt, lang="en-us", speech=True, use_24hour=False,
# use_ampm=False):
class TestNiceDateFormat(unittest.TestCase):
@classmethod
def setUpClass(cls):
# Read date_time_test.json files for test data
cls.test_config = {}
p = Path(date_time_format.config_path)
for sub_dir in [x for x in p.iterdir() if x.is_dir()]:
if (sub_dir / 'date_time_test.json').exists():
print("Getting test for " +
str(sub_dir / 'date_time_test.json'))
with (sub_dir / 'date_time_test.json').open() as f:
cls.test_config[sub_dir.parts[-1]] = json.loads(f.read())
def test_convert_times(self):
dt = datetime.datetime(2017, 1, 31,
13, 22, 3)
# Verify defaults haven't changed
self.assertEqual(nice_time(dt),
nice_time(dt, "en-us", True, False, False))
self.assertEqual(nice_time(dt),
"one twenty two")
self.assertEqual(nice_time(dt, use_ampm=True),
"one twenty two p.m.")
self.assertEqual(nice_time(dt, speech=False),
"1:22")
self.assertEqual(nice_time(dt, speech=False, use_ampm=True),
"1:22 PM")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True),
"13:22")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True,
use_ampm=True),
"13:22")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=True),
"thirteen twenty two")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=False),
"thirteen twenty two")
dt = datetime.datetime(2017, 1, 31,
13, 0, 3)
self.assertEqual(nice_time(dt),
"one o'clock")
self.assertEqual(nice_time(dt, use_ampm=True),
"one p.m.")
self.assertEqual(nice_time(dt, speech=False),
"1:00")
self.assertEqual(nice_time(dt, speech=False, use_ampm=True),
"1:00 PM")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True),
"13:00")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True,
use_ampm=True),
"13:00")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=True),
"thirteen hundred")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=False),
"thirteen hundred")
dt = datetime.datetime(2017, 1, 31,
13, 2, 3)
self.assertEqual(nice_time(dt),
"one oh two")
self.assertEqual(nice_time(dt, use_ampm=True),
"one oh two p.m.")
self.assertEqual(nice_time(dt, speech=False),
"1:02")
self.assertEqual(nice_time(dt, speech=False, use_ampm=True),
"1:02 PM")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True),
"13:02")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True,
use_ampm=True),
"13:02")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=True),
"thirteen zero two")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=False),
"thirteen zero two")
dt = datetime.datetime(2017, 1, 31,
0, 2, 3)
self.assertEqual(nice_time(dt),
"twelve oh two")
self.assertEqual(nice_time(dt, use_ampm=True),
"twelve oh two a.m.")
self.assertEqual(nice_time(dt, speech=False),
"12:02")
self.assertEqual(nice_time(dt, speech=False, use_ampm=True),
"12:02 AM")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True),
"00:02")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True,
use_ampm=True),
"00:02")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=True),
"zero zero zero two")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=False),
"zero zero zero two")
dt = datetime.datetime(2018, 2, 8,
1, 2, 33)
self.assertEqual(nice_time(dt),
"one oh two")
self.assertEqual(nice_time(dt, use_ampm=True),
"one oh two a.m.")
self.assertEqual(nice_time(dt, speech=False),
"1:02")
self.assertEqual(nice_time(dt, speech=False, use_ampm=True),
"1:02 AM")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True),
"01:02")
self.assertEqual(nice_time(dt, speech=False, use_24hour=True,
use_ampm=True),
"01:02")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=True),
"zero one zero two")
self.assertEqual(nice_time(dt, use_24hour=True, use_ampm=False),
"zero one zero two")
def test_nice_date(self):
for lang in self.test_config:
i = 1
while (self.test_config[lang].get('test_nice_date') and
self.test_config[lang]['test_nice_date'].get(str(i))):
p = self.test_config[lang]['test_nice_date'][str(i)]
dp = ast.literal_eval(p['datetime_param'])
np = ast.literal_eval(p['now'])
dt = datetime.datetime(
dp[0], dp[1], dp[2], dp[3], dp[4], dp[5])
now = None if not np else datetime.datetime(
np[0], np[1], np[2], np[3], np[4], np[5])
print('Testing for ' + lang + ' that ' + str(dt) +
' is date ' + p['assertEqual'])
self.assertEqual(p['assertEqual'],
nice_date(dt, lang=lang, now=now))
i = i + 1
# test fall back to english
dt = datetime.datetime(2018, 2, 4, 0, 2, 3)
self.assertEqual(nice_date(
dt, lang='invalid', now=datetime.datetime(2018, 2, 4, 0, 2, 3)),
'today')
# test all days in a year for all languages,
# that some output is produced
for lang in self.test_config:
for dt in (datetime.datetime(2017, 12, 30, 0, 2, 3) +
datetime.timedelta(n) for n in range(368)):
self.assertTrue(len(nice_date(dt, lang=lang)) > 0)
def test_nice_date_time(self):
for lang in self.test_config:
i = 1
while (self.test_config[lang].get('test_nice_date_time') and
self.test_config[lang]['test_nice_date_time'].get(str(i))):
p = self.test_config[lang]['test_nice_date_time'][str(i)]
dp = ast.literal_eval(p['datetime_param'])
np = ast.literal_eval(p['now'])
dt = datetime.datetime(
dp[0], dp[1], dp[2], dp[3], dp[4], dp[5])
now = None if not np else datetime.datetime(
np[0], np[1], np[2], np[3], np[4], np[5])
print('Testing for ' + lang + ' that ' + str(dt) +
' is date time ' + p['assertEqual'])
self.assertEqual(
p['assertEqual'],
nice_date_time(
dt, lang=lang, now=now,
use_24hour=ast.literal_eval(p['use_24hour']),
use_ampm=ast.literal_eval(p['use_ampm'])))
i = i + 1
def test_nice_year(self):
for lang in self.test_config:
i = 1
while (self.test_config[lang].get('test_nice_year') and
self.test_config[lang]['test_nice_year'].get(str(i))):
p = self.test_config[lang]['test_nice_year'][str(i)]
dp = ast.literal_eval(p['datetime_param'])
dt = datetime.datetime(
dp[0], dp[1], dp[2], dp[3], dp[4], dp[5])
print('Testing for ' + lang + ' that ' + str(dt) +
' is year ' + p['assertEqual'])
self.assertEqual(p['assertEqual'], nice_year(
dt, lang=lang, bc=ast.literal_eval(p['bc'])))
i = i + 1
# Test all years from 0 to 9999 for all languages,
# that some output is produced
for lang in self.test_config:
print("Test all years in " + lang)
for i in range(1, 9999):
dt = datetime.datetime(i, 1, 31, 13, 2, 3)
self.assertTrue(len(nice_year(dt, lang=lang)) > 0)
# Looking through the date sequence can be helpful
# print(nice_year(dt, lang=lang))
if __name__ == "__main__":
unittest.main()