def test_moved(self):
"""Warning message when the class has moved."""
mock_warn = mock.Mock()
test_class = deprecated.MovedHelper(urls.Url,
'grow.common.urls.Url',
warn=mock_warn)
_ = test_class('/')
mock_warn.assert_called_with(
'The grow.common.urls.Url class has moved to grow.common.urls.Url and '
'will be removed in a future version.')
def test_static_method(self):
"""Moved warning also works with static methods."""
mock_warn = mock.Mock()
test_class = deprecated.MovedHelper(urls.Url,
'grow.common.urls.Url',
warn=mock_warn)
_ = test_class.create_relative_path('/foo/bar/baz/',
relative_to='/test/dir/')
mock_warn.assert_called_with(
'The grow.common.urls.Url class has moved to grow.common.urls.Url and '
'will be removed in a future version.')
"""Deprecated path for Grow catalog holder."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.translations import catalog_holder as new_ref
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(new_ref.Error, 'grow.pods.catalog_holder.Error')
UsageError = deprecated.MovedHelper(new_ref.UsageError,
'grow.pods.catalog_holder.UsageError')
Catalogs = deprecated.MovedHelper(new_ref.Catalogs,
'grow.pods.catalog_holder.Catalogs')
"""Deprecated path for file storage."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.storage import file_storage as new_ref
# pylint: disable=invalid-name
FileStorage = deprecated.MovedHelper(
new_ref.FileStorage, 'grow.pods.storage.file_storage.FileStorage')
"""Deprecated path for GCS storage."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.storage import google_storage as new_ref
# pylint: disable=invalid-name
CloudStorage = deprecated.MovedHelper(
new_ref.CloudStorage, 'grow.pods.storage.google_storage.CloudStorage')
CloudStorageLoader = deprecated.MovedHelper(
new_ref.CloudStorageLoader,
'grow.pods.storage.google_storage.CloudStorageLoader')
"""Deprecated path for Grow importers."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.translations import importers as new_ref
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(
new_ref.Error, 'grow.pods.importers.Error')
Importer = deprecated.MovedHelper(
new_ref.Importer, 'grow.pods.importers.Importer')
"""Deprecated path for Grow locales.""" # TODO: Remove after deprecation period. from grow.common import deprecated from grow.translations import locales as new_ref # pylint: disable=invalid-name Locales = deprecated.MovedHelper(new_ref.Locales, 'grow.pods.locales.Locales') Locale = deprecated.MovedHelper(new_ref.Locale, 'grow.pods.locales.Locale')
"""Deprecated path for Grow documents."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.documents import document as new_ref
# Alias constants.
PATH_LOCALE_REGEX = new_ref.PATH_LOCALE_REGEX
BUILT_IN_FIELDS = new_ref.BUILT_IN_FIELDS
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(new_ref.Error, 'grow.pods.documents.Error')
DocumentDoesNotExistError = deprecated.MovedHelper(
new_ref.DocumentDoesNotExistError,
'grow.pods.documents.DocumentDoesNotExistError')
DocumentExistsError = deprecated.MovedHelper(
new_ref.DocumentExistsError, 'grow.pods.documents.DocumentExistsError')
PathFormatError = deprecated.MovedHelper(
new_ref.PathFormatError, 'grow.pods.documents.PathFormatError')
Document = deprecated.MovedHelper(new_ref.Document,
'grow.pods.documents.Document')
"""Deprecated path for Grow document front matter."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.documents import document_front_matter as new_ref
# Alias constants.
BOUNDARY_REGEX = new_ref.BOUNDARY_REGEX
CONVERT_MESSAGE = new_ref.CONVERT_MESSAGE
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(
new_ref.Error, 'grow.pods.document_front_matter.Error')
BadFormatError = deprecated.MovedHelper(
new_ref.BadFormatError, 'grow.pods.document_front_matter.BadFormatError')
DocumentFrontMatter = deprecated.MovedHelper(
new_ref.DocumentFrontMatter, 'grow.pods.document_front_matter.DocumentFrontMatter')
"""Deprecated path for Grow document fields."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.documents import document_fields as new_ref
# Alias constants.
LOCALIZED_KEY_REGEX = new_ref.LOCALIZED_KEY_REGEX
# pylint: disable=invalid-name
DocumentFields = deprecated.MovedHelper(
new_ref.DocumentFields, 'grow.pods.document_fields.DocumentFields')
"""Deprecated path for Grow catalogs.""" # TODO: Remove after deprecation period. from grow.common import deprecated from grow.translations import catalogs as new_ref # pylint: disable=invalid-name Catalog = deprecated.MovedHelper(new_ref.Catalog, 'grow.pods.catalogs.Catalog')
"""Deprecated path for storage errors."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.storage import errors as new_ref
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(new_ref.Error, 'grow.pods.storage.errors.Error')
PathError = deprecated.MovedHelper(new_ref.PathError,
'grow.pods.storage.errors.PathError')
NotFoundError = deprecated.MovedHelper(
new_ref.NotFoundError, 'grow.pods.storage.errors.NotFoundError')
"""Deprecated path for Grow document format."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.documents import document_format as new_ref
# Alias constants.
BOUNDARY_SEPARATOR = new_ref.BOUNDARY_SEPARATOR
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(new_ref.Error,
'grow.pods.document_format.Error')
BadFormatError = deprecated.MovedHelper(
new_ref.BadFormatError, 'grow.pods.document_format.BadFormatError')
BadLocalesError = deprecated.MovedHelper(
new_ref.BadLocalesError, 'grow.pods.document_format.BadLocalesError')
DocumentFormat = deprecated.MovedHelper(
new_ref.DocumentFormat, 'grow.pods.document_format.DocumentFormat')
HtmlDocumentFormat = deprecated.MovedHelper(
new_ref.HtmlDocumentFormat, 'grow.pods.document_format.HtmlDocumentFormat')
MarkdownDocumentFormat = deprecated.MovedHelper(
new_ref.MarkdownDocumentFormat,
'grow.pods.document_format.MarkdownDocumentFormat')
TextDocumentFormat = deprecated.MovedHelper(
new_ref.TextDocumentFormat, 'grow.pods.document_format.TextDocumentFormat')
YamlDocumentFormat = deprecated.MovedHelper(
new_ref.YamlDocumentFormat, 'grow.pods.document_format.YamlDocumentFormat')
"""Deprecated path for storage errors."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.storage import base_storage as new_ref
# pylint: disable=invalid-name
BaseStorage = deprecated.MovedHelper(
new_ref.BaseStorage, 'grow.pods.storage.base_storage.BaseStorage')
"""Deprecated path for Grow collection."""
# TODO: Remove after deprecation period.
from grow.common import deprecated
from grow.collections import collection as new_ref
# pylint: disable=invalid-name
Error = deprecated.MovedHelper(new_ref.Error, 'grow.pods.collections.Error')
BadCollectionNameError = deprecated.MovedHelper(
new_ref.BadCollectionNameError,
'grow.pods.collections.BadCollectionNameError')
BadFieldsError = deprecated.MovedHelper(
new_ref.BadFieldsError, 'grow.pods.collections.BadFieldsError')
CollectionDoesNotExistError = deprecated.MovedHelper(
new_ref.CollectionDoesNotExistError,
'grow.pods.collections.CollectionDoesNotExistError')
CollectionExistsError = deprecated.MovedHelper(
new_ref.CollectionExistsError,
'grow.pods.collections.CollectionExistsError')
CollectionNotEmptyError = deprecated.MovedHelper(
new_ref.CollectionNotEmptyError,
'grow.pods.collections.CollectionNotEmptyError')
NoLocalesError = deprecated.MovedHelper(
new_ref.NoLocalesError, 'grow.pods.collections.NoLocalesError')
Collection = deprecated.MovedHelper(new_ref.Collection,
'grow.pods.collections.Collection')
