Merge pull request #2671 from MycroftAI/remove/dialog-loader
remove deprecated DialogLoader classpull/2678/head
commit
cb2531c81c
|
@ -14,5 +14,4 @@
|
||||||
#
|
#
|
||||||
"""Provides utilities for rendering dialogs and populating with custom data."""
|
"""Provides utilities for rendering dialogs and populating with custom data."""
|
||||||
|
|
||||||
from .dialog import (MustacheDialogRenderer, DialogLoader,
|
from .dialog import (MustacheDialogRenderer, load_dialogs, get)
|
||||||
load_dialogs, get)
|
|
||||||
|
|
|
@ -120,28 +120,6 @@ class MustacheDialogRenderer:
|
||||||
return line
|
return line
|
||||||
|
|
||||||
|
|
||||||
class DialogLoader:
|
|
||||||
"""Loads a collection of dialog files into a renderer implementation.
|
|
||||||
|
|
||||||
TODO: Remove in 20.02
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, renderer_factory=MustacheDialogRenderer):
|
|
||||||
LOG.warning('Deprecated, use load_dialogs() instead.')
|
|
||||||
self.__renderer = renderer_factory()
|
|
||||||
|
|
||||||
def load(self, dialog_dir):
|
|
||||||
"""Load all dialog files within the specified directory.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
dialog_dir (str): directory that contains dialog files
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
a loaded instance of a dialog renderer
|
|
||||||
"""
|
|
||||||
return load_dialogs(dialog_dir, self.__renderer)
|
|
||||||
|
|
||||||
|
|
||||||
def load_dialogs(dialog_dir, renderer=None):
|
def load_dialogs(dialog_dir, renderer=None):
|
||||||
"""Load all dialog files within the specified directory.
|
"""Load all dialog files within the specified directory.
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ import unittest
|
||||||
import pathlib
|
import pathlib
|
||||||
import json
|
import json
|
||||||
|
|
||||||
from mycroft.dialog import MustacheDialogRenderer, DialogLoader, get
|
from mycroft.dialog import MustacheDialogRenderer, load_dialogs, get
|
||||||
from mycroft.util import resolve_resource_file
|
from mycroft.util import resolve_resource_file
|
||||||
|
|
||||||
|
|
||||||
|
@ -90,15 +90,13 @@ class DialogTest(unittest.TestCase):
|
||||||
|
|
||||||
def test_dialog_loader(self):
|
def test_dialog_loader(self):
|
||||||
template_path = self.topdir.joinpath('./multiple_dialogs')
|
template_path = self.topdir.joinpath('./multiple_dialogs')
|
||||||
loader = DialogLoader()
|
renderer = load_dialogs(template_path)
|
||||||
renderer = loader.load(template_path)
|
|
||||||
self.assertEqual(renderer.render('one'), 'ONE')
|
self.assertEqual(renderer.render('one'), 'ONE')
|
||||||
self.assertEqual(renderer.render('two'), 'TWO')
|
self.assertEqual(renderer.render('two'), 'TWO')
|
||||||
|
|
||||||
def test_dialog_loader_missing(self):
|
def test_dialog_loader_missing(self):
|
||||||
template_path = self.topdir.joinpath('./missing_dialogs')
|
template_path = self.topdir.joinpath('./missing_dialogs')
|
||||||
loader = DialogLoader()
|
renderer = load_dialogs(template_path)
|
||||||
renderer = loader.load(template_path)
|
|
||||||
self.assertEqual(renderer.render('test'), 'test')
|
self.assertEqual(renderer.render('test'), 'test')
|
||||||
|
|
||||||
def test_get(self):
|
def test_get(self):
|
||||||
|
|
Loading…
Reference in New Issue