new(core): Creating the core package #1

ehdsouza · 2019-03-13T14:29:49Z

related to https://github.ibm.com/Watson/developer-experience/issues/6179

This PR contains move to a separate core, in addition:

Added python: 3.7 xenial support in travis
Moved _get_error_info and _get_error_message in Api_Exception class

germanattanasio · 2019-03-13T14:53:03Z

.bumpversion.cfg

@@ -0,0 +1,11 @@
+[bumpversion]
+current_version = 0.0.0


We need to make sure we don't use a 1.x version for the core package until we know it's stable

Created an initial tag: v0.0.0 and ran semantic locally:

# 0.1.0 (https://github.com/IBM/python-sdk-core/compare/v0.0.0...v0.1.0) (2019-03-13) ### Features * core: create a separate core for IBM python SDK (2421459 (https://github.com/IBM/python-sdk-core/commit/2421459))

germanattanasio

I'm going to wait until this PR is ready for review

germanattanasio · 2019-03-13T14:54:41Z

.travis.yml

+- provider: pypi
+  user: ehdsouza
+  password:
+    secure: eMssjS1Airz5MrmcEDAnKYnTlMLuzinX8JFsh4TB0A4t7GCes2a/mlvcoazAv2QZMQUKQMC++bAXYGGgXtsSQsfOYnRtojW4pRphxOZrlXlWFgCLGz/eHioamNZVbH+/P/OYjbLy5ZKSzp3M3bZxYqHcmGTq0sBeo5A2Ilkzu5P+D865Jqtn52brwh/xYq4XWeJeQN/BSLwdtPEtZYQXhQupAteNDAo2ON0FVyt0amINrjA0Qw+0k35g36wti+CsKn5fhbaHf6jjN0oRj8J8wPZieXLAUMdxscfBjUXJ8AK8E4H/wPI30IsaMus+1r85ekiDKZC5iukO6uqMARFywjX/eTIDbWxwKImQUgvVa2+gncre7GvZrHIFxhIDDkssH1IfC1fcw3mNY4vCO9df/vHStp3Kvi27GvsYJnfsbXXj6fAhokHtsrnrbpXFET6LghGQx3HgOKrlCQ1EI0Fk92Qw7+g15jwMGlkwUE1qMS+PVOe7dQ4ikxJgw4CVrqU6/zaLFHV8LXFfjv166ZSWcOJHJXGgJ2TPuGiooL60+pWp/UYY00hZVlYX0Vlks6zN0h9zJd16kR3EwDrW0muqFnLC2xTuv5WsCjsOATtsTQzmBNEdCbGdOskgF4+0yPe7ps3kEs3UpAooKtYVh1OOJAUkl4vSMyu4Jg1ASyQWt00=


Will this work?

@germanattanasio followed these steps for encrypting key: https://docs.travis-ci.com/user/deployment/pypi/

CONTRIBUTING.md

padamstx

I think a few minor things need to be addressed, and then also try to remove any additional watson-specific things that were copied from the python-sdk that shouldn't really be in a generic core package that will be shared with other SDK implementations.

CONTRIBUTING.md

ibm_cloud_sdk_core/service.py

pylint.sh

resources/ibm-credentials.env

ehdsouza · 2019-03-13T15:51:43Z

ibm_cloud_sdk_core/api_exception.py

+        self.transactionId = None
+        self.globalTransactionId = None
+        if httpResponse is not None:
+            self.transactionId = httpResponse.headers.get('X-DP-Watson-Tran-ID')


@padamstx @germanattanasio only Watson specific that I see here is this header. Should I remove it?

Watson specific code should be in our SDK not the core

ehdsouza · 2019-03-13T19:16:32Z

ibm_cloud_sdk_core/__init__.py

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .service import Service


Is the name service ok or should I move to base_service? @padamstx @germanattanasio

I think base_service it's better

germanattanasio

What's the code coverage? I would like to test the core SDK and get it to be ~90% as we did with Node

germanattanasio · 2019-03-13T19:35:26Z

ibm_cloud_sdk_core/__init__.py

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .service import Service


I think base_service it's better

germanattanasio · 2019-03-13T19:36:18Z

ibm_cloud_sdk_core/api_exception.py

+        self.info = info
+        self.httpResponse = httpResponse
+        self.globalTransactionId = None
+        if httpResponse is not None:


Can you get all the headers from the response in a dictionary? maybe they can access that if they use the httpResponse object

germanattanasio · 2019-03-13T19:36:45Z

ibm_cloud_sdk_core/api_exception.py

+        :return: A `dict` containing additional information about the error.
+        :rtype: dict
+        """
+        info_keys = ['code_description', 'description', 'errors', 'help',


@padamstx said that we have a defined list for this

@padamstx can you let me know if there is a list?

Well, i don't think we have a "defined list" just yet. We need to come up with one.
Related issues:
https://github.ibm.com/Watson/developer-experience/issues/6336
https://github.ibm.com/arf/planning-sdk-squad/issues/818

germanattanasio · 2019-03-13T19:37:08Z

ibm_cloud_sdk_core/api_exception.py

+        try:
+            error_json = response.json()
+            if 'error' in error_json:
+                if isinstance(error_json['error'], dict) and 'description' in \


@padamstx said that we have a list for this

codecov · 2019-03-14T19:49:39Z

Codecov Report

❗ No coverage uploaded for pull request base (master@cda4fe5). Click here to learn what that means.
The diff coverage is 95.21%.

@@            Coverage Diff            @@
##             master       #1   +/-   ##
=========================================
  Coverage          ?   95.21%           
=========================================
  Files             ?        7           
  Lines             ?      376           
  Branches          ?        0           
=========================================
  Hits              ?      358           
  Misses            ?       18           
  Partials          ?        0

Impacted Files	Coverage Δ
ibm_cloud_sdk_core/api_exception.py	`100% <100%> (ø)`
ibm_cloud_sdk_core/version.py	`100% <100%> (ø)`
ibm_cloud_sdk_core/detailed_response.py	`100% <100%> (ø)`
ibm_cloud_sdk_core/__init__.py	`100% <100%> (ø)`
ibm_cloud_sdk_core/base_service.py	`93.53% <93.53%> (ø)`
ibm_cloud_sdk_core/utils.py	`94.73% <94.73%> (ø)`
ibm_cloud_sdk_core/iam_token_manager.py	`96.96% <96.96%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cda4fe5...e1df393. Read the comment docs.

padamstx · 2019-03-14T16:08:56Z

ibm_cloud_sdk_core/api_exception.py

+        :return: A `dict` containing additional information about the error.
+        :rtype: dict
+        """
+        info_keys = ['code_description', 'description', 'errors', 'help',


Well, i don't think we have a "defined list" just yet. We need to come up with one.
Related issues:
https://github.ibm.com/Watson/developer-experience/issues/6336
https://github.ibm.com/arf/planning-sdk-squad/issues/818

padamstx · 2019-03-15T16:29:51Z

ibm_cloud_sdk_core/__init__.py

@@ -17,3 +17,4 @@
 from .detailed_response import DetailedResponse
 from .iam_token_manager import IAMTokenManager
 from .api_exception import ApiException
+from .utils import datetime_to_string, string_to_datetime


Does this mean that a generated .py file no longer needs to explicitly import these functions as long as it imports the "ibm_cloud_sdk_core" module?

The import would look something like:
from ibm_cloud_sdk_core import string_to_datetime

or if you want to import the entire module

import ibm_cloud_sdk_core # And then using the module, call the function like this: ibm_cloud_sdk_core.string_to_datetime()

padamstx · 2019-03-15T16:31:53Z

ibm_cloud_sdk_core/base_service.py

@@ -81,8 +81,7 @@ def __init__(self, vcap_services_name, url, username=None, password=None,
            raise ValueError('The URL shouldn\'t start or end with curly brackets or quotes. '
                             'Be sure to remove any {} and \" characters surrounding your URL')

-        user_agent_string = 'ibm-python-sdk-core-' + __version__ + self.get_os_info()
-        self.user_agent_header = self.set_user_agent_header(user_agent_string)
+        self.set_user_agent_header(self.build_user_agent())


In general, I think we want the core to add the User-Agent header to the outgoing request ONLY if it hasn't already been added by the service function. (I can't tell from this whether we will unconditionally add the core's User-Agent header or not).

Oh good catch!, I have to make a check in the request function

padamstx

LGTM

watson-github-bot · 2019-03-18T14:37:13Z

🎉 This PR is included in version 0.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

watson-github-bot · 2019-03-18T15:22:11Z

🎉 This PR is included in version 0.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

watson-github-bot · 2019-03-18T16:02:08Z

🎉 This PR is included in version 0.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Co-authored-by: Matthew Keezer <[email protected]>

new(core): Creating the core package

88912a1

ehdsouza requested a review from padamstx March 13, 2019 14:29

germanattanasio reviewed Mar 13, 2019

View reviewed changes

germanattanasio suggested changes Mar 13, 2019

View reviewed changes

feat(core): create a separate core for IBM python SDK

2421459

padamstx requested changes Mar 13, 2019

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

ibm_cloud_sdk_core/service.py Outdated Show resolved Hide resolved

pylint.sh Outdated Show resolved Hide resolved

resources/ibm-credentials.env Outdated Show resolved Hide resolved

chore(core): remove watson specific info

c3de2e1

ehdsouza commented Mar 13, 2019

View reviewed changes

ehdsouza added the ready for review label Mar 13, 2019

ehdsouza added 2 commits March 13, 2019 12:30

chore(travis): add python 3.7

2982424

chore(exception): Cleanup API exception class

3e0ae7e

ehdsouza commented Mar 13, 2019

View reviewed changes

germanattanasio suggested changes Mar 13, 2019

View reviewed changes

ehdsouza added 2 commits March 14, 2019 15:36

test(services): Code coverage with base service changes

b8c123a

test(response): change text response to string

0866521

ehdsouza added 3 commits March 14, 2019 15:56

doc(codecov): Add code coverage link to readne

975b907

chore(rename): rename to camel case

65e17d0

chore(user-agent): User agent methods and date time parsing in utils

416dd82

padamstx reviewed Mar 15, 2019

View reviewed changes

ehdsouza added 2 commits March 15, 2019 15:26

fix(user-agent): Add user agent header only if not set

49ed7eb

chore(error): parse error in a standard way

d631acc

ehdsouza requested review from padamstx and germanattanasio March 15, 2019 20:09

chore(global): test global transaction id

e1df393

padamstx approved these changes Mar 15, 2019

View reviewed changes

germanattanasio approved these changes Mar 16, 2019

View reviewed changes

ehdsouza merged commit 5f5ccd9 into master Mar 18, 2019

watson-github-bot added the released label Mar 18, 2019

ehdsouza deleted the init branch May 9, 2019 15:29

pyrooka added a commit that referenced this pull request Oct 29, 2021

chore: address issues #1

acce4d9

Co-authored-by: Matthew Keezer <[email protected]>

new(core): Creating the core package #1

new(core): Creating the core package #1

Uh oh!

Conversation

ehdsouza commented Mar 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

germanattanasio left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

padamstx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

germanattanasio left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ehdsouza Mar 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ehdsouza Mar 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

padamstx left a comment

Choose a reason for hiding this comment

Uh oh!

watson-github-bot commented Mar 18, 2019

Uh oh!

watson-github-bot commented Mar 18, 2019

Uh oh!

watson-github-bot commented Mar 18, 2019

Uh oh!

Uh oh!

ehdsouza commented Mar 13, 2019 •

edited

Loading

codecov bot commented Mar 14, 2019 •

edited

Loading

ehdsouza Mar 15, 2019 •

edited

Loading

ehdsouza Mar 15, 2019 •

edited

Loading