Skip to content

Commit 657ed8c

Browse files
Merge pull request #354 from watson-developer-cloud/document-conversion
Deprecate document conversion
2 parents d7709aa + d38c940 commit 657ed8c

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

watson_developer_cloud/document_conversion_v1.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@
1616
The v1 Document Conversion service
1717
(https://www.ibm.com/watson/developercloud/document-conversion.html)
1818
"""
19+
from .utils import deprecated
1920
from .watson_service import WatsonService
2021
import os
2122
import json
22-
23+
DEPRECATION_MESSAGE = "Since Document Conversion Service was retired in October 2017, we have continued to improve document conversion capabilities within Watson Discovery. If you are a Document Conversion user, get started with Discovery today. Refer to the migration guide: https://console.bluemix.net/docs/services/discovery/migrate-dcs-rr.html"
2324

2425
class DocumentConversionV1(WatsonService):
2526
DEFAULT_URL = 'https://gateway.watsonplatform.net/document-conversion/api'
@@ -28,10 +29,12 @@ class DocumentConversionV1(WatsonService):
2829
NORMALIZED_TEXT = 'normalized_text'
2930
latest_version = '2016-02-10'
3031

32+
@deprecated(DEPRECATION_MESSAGE)
3133
def __init__(self, version, url=DEFAULT_URL, **kwargs):
3234
WatsonService.__init__(self, 'document_conversion', url, **kwargs)
3335
self.version = version
3436

37+
@deprecated(DEPRECATION_MESSAGE)
3538
def convert_document(self, document, config, media_type=None):
3639
params = {'version': self.version}
3740
filename = os.path.basename(document.name)
@@ -45,7 +48,7 @@ def convert_document(self, document, config, media_type=None):
4548
return self.request(method='POST', url='/v1/convert_document',
4649
files=files, params=params,
4750
accept_json=accept_json)
48-
51+
@deprecated(DEPRECATION_MESSAGE)
4952
def index_document(self, config, document=None, metadata=None,
5053
media_type=None):
5154
if document is None and metadata is None:

watson_developer_cloud/utils.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import warnings
2+
3+
def deprecated(message):
4+
def deprecated_decorator(func):
5+
def deprecated_func(*args, **kwargs):
6+
warnings.warn("{} is a deprecated function. {}".format(func.__name__, message),
7+
category=DeprecationWarning,
8+
stacklevel=2)
9+
warnings.simplefilter('default', DeprecationWarning)
10+
return func(*args, **kwargs)
11+
return deprecated_func
12+
return deprecated_decorator

0 commit comments

Comments
 (0)