Merge pull request #179 from smartsheet-platform/tw-updates

timwellswa · web-flow · commit 355bffcd6fd0 · 2022-08-03T17:24:56.000-07:00
Rolled multiple PRs into this one
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,7 @@
-dist: trusty
+dist: focal
 
 language: python
+jdk: openjdk10
 
 cache:
   directories:
@@ -12,19 +13,21 @@ git:
 jobs:
   include:
     - stage: test
-      python: "2.7"
+      python: "3.6"
+      script:
+        - jdk_switcher use openjdk10
+        - sh test.sh
+    - # stage name not required
+      python: "3.7"
       script: sh test.sh
-      if: env(deploy) IS NOT present
     - # stage name not required
-      python: "3.4"
+      python: "3.8"
       script: sh test.sh
-      if: env(deploy) IS NOT present
     - # stage name not required
-      python: "3.5"
+      python: "3.9"
       script: sh test.sh
-      if: env(deploy) IS NOT present
     - # stage name not required
-      python: "3.6"
+      python: "3.10"
       script: sh test.sh
     - # stage name not required
       python: "pypy"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.177.0] - 2022-08-03
+### Added
+- add support for commenter permissions
+- add base URL for smartsheet.eu
+- add `level` parameter to get_row
+
+### Changed
+- pull updates for Python 3.10 compatibility
+- update setup and readme for Python version 3.7 - 3.10
+- update EnumeratedValue `__eq__` method to handle comparisons to NoneType
+
+### Fixed
+- separate `DatetimeObjectValue` from `DateObjectValue` to fix Sheet Summary Field serialization
+
 ## [2.105.1] - 2020-10-15
 ### Fixed
 - don't add time offset to date types when serializing
diff --git a/NOTICE b/NOTICE
@@ -1,5 +1,5 @@
 Smartsheet Python SDK
-Copyright 2016 Smartsheet.com, Inc.
+Copyright 2016-2021 Smartsheet.com, Inc.
 
 Portions of this software were developed by SmartBear Software under
 the Apache License, Version 2.0. The original software is available
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 This library is intended to simplify connecting to the [Smartsheet API](https://smartsheet.redoc.ly) from Python applications.
 
 ## System Requirements
-The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.  
-**Note:** Python version 3.4 or higher is required for Unicode support, for example, if your Smartsheet data includes non-ASCII characters.  
+The SDK currently supports Python 3.6, 3.7, 3.8, 3.9, pypy, and pypy3. Integrations built on previous versions may still function, but Smartsheet recommends staying current with the Python end-of-life guidelines. 
+**Note:** Python version 3.6 or higher is required for Unicode support, for example, if your Smartsheet data includes non-ASCII characters.  
 
 The following packages are required.
 
diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@ applications.
 System Requirements
 -------------------
 
-The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.
+The SDK currently supports Python 3.6, 3.7, 3.8, 3.9, 3.10, pypy, and pypy3.
 The following packages are required.
 
 -  `requests <https://pypi.python.org/pypi/requests>`__
diff --git a/docs-source/index.rst b/docs-source/index.rst
@@ -19,17 +19,17 @@ Getting started is easy:
       >>> import smartsheet
 #.  Refer to the `Smartsheet API Documentation`_ for dozens of Python SDK usage examples.
 
-.. _direct API access: https://smartsheet-platform.github.io/api-docs/index.html#direct-api-access
-.. _smartsheet page on the Python Package Index: http://pypi.python.org/pypi/smartsheet-python-sdk
-.. _Smartsheet API Documentation: https://smartsheet-platform.github.io/api-docs/index.html?python
+##. _direct API access: https://smartsheet-platform.github.io/api-docs/index.html#direct-api-access
+##. _smartsheet page on the Python Package Index: http://pypi.python.org/pypi/smartsheet-python-sdk
+##. _Smartsheet API Documentation: https://smartsheet-platform.github.io/api-docs/index.html?python
 
 API Documentation
 -----------------
 
 If you are looking for information on a specific function, class or method,
 this part of the documentation is for you.
 
-.. toctree::
+##. toctree::
    :maxdepth: 1
 
    smartsheet
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -19,17 +19,17 @@ Getting started is easy:
       >>> import smartsheet
 #.  Refer to the `Smartsheet API Documentation`_ for dozens of Python SDK usage examples.
 
-.. _direct API access: https://smartsheet-platform.github.io/api-docs/index.html#direct-api-access
-.. _smartsheet page on the Python Package Index: http://pypi.python.org/pypi/smartsheet-python-sdk
-.. _Smartsheet API Documentation: https://smartsheet-platform.github.io/api-docs/index.html?python
+##. _direct API access: https://smartsheet-platform.github.io/api-docs/index.html#direct-api-access
+##. _smartsheet page on the Python Package Index: http://pypi.python.org/pypi/smartsheet-python-sdk
+##. _Smartsheet API Documentation: https://smartsheet-platform.github.io/api-docs/index.html?python
 
 API Documentation
 -----------------
 
 If you are looking for information on a specific function, class or method,
 this part of the documentation is for you.
 
-.. toctree::
+#. toctree::
    :maxdepth: 1
 
    smartsheet
diff --git a/setup.py b/setup.py
@@ -54,10 +54,12 @@ def run_tests(self):
         'Operating System :: OS Independent',
         'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: Implementation :: PyPy',
         'Programming Language :: Python :: Implementation :: CPython',
         'Topic :: Software Development :: Libraries :: Python Modules',
diff --git a/smartsheet/__init__.py b/smartsheet/__init__.py
@@ -1,7 +1,7 @@
 # pylint: disable=C0111,C0413
 # Smartsheet Python SDK.
 #
-# Copyright 2016 Smartsheet.com, Inc.
+# Copyright 2016-2021 Smartsheet.com, 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
@@ -18,6 +18,7 @@
 from __future__ import absolute_import
 
 __api_base__ = 'https://api.smartsheet.com/2.0'
+__eu_base__  = 'https://api.smartsheet.eu/2.0'
 __gov_base__ = 'https://api.smartsheetgov.com/2.0'
 __api_version__ = '2.0'
 
diff --git a/smartsheet/models/date_object_value.py b/smartsheet/models/date_object_value.py
@@ -26,9 +26,9 @@
 class DateObjectValue(ObjectValue):
     """Smartsheet DateObjectValue data model."""
 
-    def __init__(self, props=None, object_type=None, base_obj=None):
+    def __init__(self, props=None, base_obj=None):
         """Initialize the DateObjectValue model."""
-        super(DateObjectValue, self).__init__(object_type, base_obj)
+        super(DateObjectValue, self).__init__(base_obj)
         self._base = None
         if base_obj is not None:
             self._base = base_obj
@@ -50,5 +50,5 @@ def value(self, value):
             self._value = value
         else:
             if isinstance(value, six.string_types):
-                value = parse(value)
+                value = parse(value).date()
                 self._value = value
diff --git a/smartsheet/models/datetime_object_value.py b/smartsheet/models/datetime_object_value.py
@@ -0,0 +1,54 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018Smartsheet.com, 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.
+
+from __future__ import absolute_import
+
+from .object_value import *
+from ..util import deserialize
+from datetime import datetime
+from dateutil.parser import parse
+
+
+class DatetimeObjectValue(ObjectValue):
+    """Smartsheet DateObjectValue data model."""
+
+    def __init__(self, props=None, object_type=None, base_obj=None):
+        """Initialize the DateObjectValue model."""
+        super(DatetimeObjectValue, self).__init__(object_type, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._value = None
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def value(self):
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        if isinstance(value, datetime):
+            self._value = value
+        else:
+            if isinstance(value, six.string_types):
+                value = parse(value)
+                self._value = value
diff --git a/smartsheet/models/enums/access_level.py b/smartsheet/models/enums/access_level.py
@@ -19,7 +19,8 @@
 
 class AccessLevel(Enum):
     VIEWER = 1
-    EDITOR = 2
-    EDITOR_SHARE = 3
-    ADMIN = 4
-    OWNER = 5
+    COMMENTER = 2
+    EDITOR = 3
+    EDITOR_SHARE = 4
+    ADMIN = 5
+    OWNER = 6
diff --git a/smartsheet/models/sheet.py b/smartsheet/models/sheet.py
@@ -382,8 +382,8 @@ def get_row(self, row_id, include=None, exclude=None):
     def get_version(self):
         return self._base.Sheets.get_sheet_version(self.id)
 
-    def list_shares(self, page_size=100, page=1, include_all=False):
-        return self._base.Sheets.list_shares(self.id, page_size, page, include_all)
+    def list_shares(self, page_size=100, page=1, include_all=False, include_workspace_shares=False, access_api_level=0):
+        return self._base.Sheets.list_shares(self.id, page_size, page, include_all, include_workspace_shares, access_api_level)
 
     def share(self, share_obj, send_email=False):
         return self._base.Sheets.share_sheet(self.id, share_obj, send_email)
diff --git a/smartsheet/object_value.py b/smartsheet/object_value.py
@@ -17,6 +17,7 @@
 from .models.boolean_object_value import BooleanObjectValue
 from .models.contact_object_value import ContactObjectValue
 from .models.date_object_value import DateObjectValue
+from .models.datetime_object_value import DatetimeObjectValue
 from .models.duration import Duration
 from .models.multi_contact_object_value import MultiContactObjectValue
 from .models.multi_picklist_object_value import MultiPicklistObjectValue
@@ -40,9 +41,11 @@ def assign_to_object_value(value):
                 return PredecessorList(value)
             elif enum_object_type == CONTACT:
                 return ContactObjectValue(value)
-            elif enum_object_type == DATE or enum_object_type == DATETIME or \
+            elif enum_object_type == DATE:
+                return DateObjectValue(value)
+            elif enum_object_type == DATETIME or \
                     enum_object_type == ABSTRACT_DATETIME:
-                return DateObjectValue(value, enum_object_value_type)
+                return DatetimeObjectValue(value, enum_object_value_type)
             elif enum_object_type == MULTI_CONTACT:
                 return MultiContactObjectValue(value)
             elif enum_object_type == MULTI_PICKLIST:
diff --git a/smartsheet/sheets.py b/smartsheet/sheets.py
@@ -420,7 +420,7 @@ def get_publish_status(self, sheet_id):
 
         return response
 
-    def get_row(self, sheet_id, row_id, include=None, exclude=None):
+    def get_row(self, sheet_id, row_id, include=None, exclude=None, level=None):
         """Get the specified Row of the specified Sheet.
 
         Args:
@@ -433,6 +433,12 @@ def get_row(self, sheet_id, row_id, include=None, exclude=None):
                 rowPermalink, rowWriterInfo.
             exclude (str): Response will not include cells
                 that have never contained any data.
+            level (int): Indicates compatibility level of data to return.
+                Valid options: 0, 1, 2
+                Option Descriptors:
+                    0 - Backwards compatible text format
+                    1 - multi-contact complex object
+                    2 - multi-picklist complex object
 
         Returns:
             Row
@@ -442,6 +448,7 @@ def get_row(self, sheet_id, row_id, include=None, exclude=None):
         _op['path'] = '/sheets/' + str(sheet_id) + '/rows/' + str(row_id)
         _op['query_params']['include'] = include
         _op['query_params']['exclude'] = exclude
+        _op['query_params']['level'] = level
 
         expected = 'Row'
         prepped_request = self._base.prepare_request(_op)
@@ -669,7 +676,8 @@ def list_org_sheets(self):
         return response
 
     def list_shares(self, sheet_id, page_size=None, page=None,
-                    include_all=None, include_workspace_shares=False):
+                    include_all=None, include_workspace_shares=False,
+                    access_api_level=0):
         """Get the list of all Users and Groups to whom the specified Sheet is
         shared, and their access level.
 
@@ -691,6 +699,7 @@ def list_shares(self, sheet_id, page_size=None, page=None,
         _op['query_params']['pageSize'] = page_size
         _op['query_params']['page'] = page
         _op['query_params']['includeAll'] = include_all
+        _op['query_params']['accessApiLevel'] = access_api_level
         if include_workspace_shares:
             _op['query_params']['include'] = 'workspaceShares'
 
diff --git a/smartsheet/types.py b/smartsheet/types.py
@@ -15,7 +15,13 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-import collections
+try:
+    # For Python versions 2.7 and 3.3 to 3.9, import from collections
+    from collections import MutableSequence
+except ImportError:
+    # For Python version >= 3.10 import from collections.abc
+    from collections.abc import MutableSequence
+
 import importlib
 import json
 import logging
@@ -26,7 +32,7 @@
 from enum import Enum
 
 
-class TypedList(collections.MutableSequence):
+class TypedList(MutableSequence):
 
     def __init__(self, item_type):
         self.item_type = item_type
@@ -281,7 +287,7 @@ def set(self, value):
             self._value = None
 
     def __eq__(self, other):
-        if isinstance(other, Enum):
+        if isinstance(other, Enum) or other is None:
             return self._value == other
         elif isinstance(other, six.string_types):
             return self._value == self.__enum[other]
diff --git a/test.sh b/test.sh
@@ -10,6 +10,6 @@ pip install certifi
 pip install enum34 requests six python-dateutil coverage coveralls[yaml] pytest pytest-travis-fold pytest-instafail requests-toolbelt
 
 smartsheet-sdk-tests/travis_scripts/start_wiremock.sh
-coverage run --source=smartsheet setup.py test
+coverage run --source=smartsheet setup.py test -a tests/integration/
 
 coveralls --verbose

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`# pylint: disable=C0111,C0413`
`2`	`2`	`# Smartsheet Python SDK.`
`3`	`3`	`#`
`4`		`-# Copyright 2016 Smartsheet.com, Inc.`
	`4`	`+# Copyright 2016-2021 Smartsheet.com, Inc.`
`5`	`5`	`#`
`6`	`6`	`# Licensed under the Apache License, Version 2.0 (the "License"): you may`
`7`	`7`	`# not use this file except in compliance with the License. You may obtain`
`@@ -18,6 +18,7 @@`
`18`	`18`	`from __future__ import absolute_import`
`19`	`19`
`20`	`20`	`__api_base__ = 'https://api.smartsheet.com/2.0'`
	`21`	`+__eu_base__ = 'https://api.smartsheet.eu/2.0'`
`21`	`22`	`__gov_base__ = 'https://api.smartsheetgov.com/2.0'`
`22`	`23`	`__api_version__ = '2.0'`
`23`	`24`