Merge pull request #50 from pyexcel/dev

chfw · web-flow · commit 4889372ba103 · 2021-10-07T19:52:10.000+01:00
release 0.7.0
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -14,7 +14,7 @@ jobs:
             python-version: 3.8
       - name: lint
         run: |
-          pip install flake8
-          pip install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install flake8
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
           flake8 --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long . 
           python setup.py checkdocs
diff --git a/.github/workflows/moban-update.yml b/.github/workflows/moban-update.yml
@@ -21,10 +21,8 @@ jobs:
           git diff --exit-code
       - name: Auto-commit
         if: failure()
-        uses: docker://cdssnc/auto-commit-github-action
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          args: >-
+          commit_message: >-
             This is an auto-commit, updating project meta data,
             such as changelog.rst, contributors.rst
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -9,6 +9,9 @@ jobs:
         matrix:
             python-version: [3.6, 3.7, 3.8, 3.9]
             os: [macOs-latest, ubuntu-latest, windows-latest]
+            exclude:
+              - os: macos-latest
+               python-version: 3.6
 
     runs-on:  ${{ matrix.os }}
     name: run tests
@@ -20,8 +23,8 @@ jobs:
             python-version:  ${{ matrix.python-version }}
       - name: install
         run: |
-          pip install -r requirements.txt
-          pip install -r tests/requirements.txt
+          pip --use-deprecated=legacy-resolver install -r requirements.txt
+          pip --use-deprecated=legacy-resolver install -r tests/requirements.txt
       - name: test
         run: |
           pip freeze
diff --git a/.moban.d/custom_README.rst.jj2 b/.moban.d/custom_README.rst.jj2
@@ -8,19 +8,33 @@
 write data in {{file_type}} format and it can read xlsx and xlsm fromat.
 You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
 
-New flag: `detect_merged_cells` allows you to spread the same value among
+Oct 2021 - Update:
+===================
+
+1. v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this
+library will NOT read 'xlsx' format and you need to install pyexcel-xlsx. Othwise,
+this library can use xlrd < 2 to read xlsx format for you. So 'xlsx' support
+in this library will vary depending on the installed version of xlrd.
+
+2. v0.6.3 can write datetime.timedelta. but when the value is read out,
+you will get datetime.datetime. so you as the developer decides what to do with it.
+
+Past news
+===========
+
+`detect_merged_cells` allows you to spread the same value among
 all merged cells. But be aware that this may slow down its reading
 performance.
 
-New flag: `skip_hidden_row_and_column` allows you to skip hidden rows
+`skip_hidden_row_and_column` allows you to skip hidden rows
 and columns and is defaulted to **True**. It may slow down its reading
 performance. And it is only valid for 'xls' files. For 'xlsx' files,
 please use pyexcel-xlsx.
 
 Warning
 ================================================================================
 
-xls file cannot contain more than 65,000 rows. You are risking the reputation
+**xls file cannot contain more than 65,000 rows**. You are risking the reputation
 of yourself/your company/
 `your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep
 using xls and are not aware of its row limit.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,19 @@
 Change log
 ================================================================================
 
+0.7.0 - 07.10.2021
+--------------------------------------------------------------------------------
+
+**Removed**
+
+#. `#46 <https://github.com/pyexcel/pyexcel-xls/issues/46>`_: remove the hard
+   pin on xlrd version < 2.0
+
+**Added**
+
+#. `#47 <https://github.com/pyexcel/pyexcel-xls/issues/47>`_: limit support to
+   persist datetime.timedelta. see more details in doc
+
 0.6.2 - 12.12.2020
 --------------------------------------------------------------------------------
 
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
@@ -1,9 +1,10 @@
 
 
-2 contributors
+3 contributors
 ================================================================================
 
 In alphabetical order:
 
 * `John Vandenberg <https://github.com/jayvdb>`_
 * `Peter Carnesciali <https://github.com/pcarn>`_
+* `vinraspa <https://github.com/vinraspa>`_
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors
+Copyright (c) 2015-2021 by Onni Software Ltd. and its contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms of the software as well
diff --git a/README.rst b/README.rst
@@ -39,19 +39,33 @@ pyexcel-xls - Let you focus on data, instead of xls format
 write data in xls format and it can read xlsx and xlsm fromat.
 You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
 
-New flag: `detect_merged_cells` allows you to spread the same value among
+Oct 2021 - Update:
+===================
+
+1. v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this
+library will NOT read 'xlsx' format and you need to install pyexcel-xlsx. Othwise,
+this library can use xlrd < 2 to read xlsx format for you. So 'xlsx' support
+in this library will vary depending on the installed version of xlrd.
+
+2. v0.6.3 can write datetime.timedelta. but when the value is read out,
+you will get datetime.datetime. so you as the developer decides what to do with it.
+
+Past news
+===========
+
+`detect_merged_cells` allows you to spread the same value among
 all merged cells. But be aware that this may slow down its reading
 performance.
 
-New flag: `skip_hidden_row_and_column` allows you to skip hidden rows
+`skip_hidden_row_and_column` allows you to skip hidden rows
 and columns and is defaulted to **True**. It may slow down its reading
 performance. And it is only valid for 'xls' files. For 'xlsx' files,
 please use pyexcel-xlsx.
 
 Warning
 ================================================================================
 
-xls file cannot contain more than 65,000 rows. You are risking the reputation
+**xls file cannot contain more than 65,000 rows**. You are risking the reputation
 of yourself/your company/
 `your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep
 using xls and are not aware of its row limit.
@@ -353,7 +367,7 @@ Then install relevant development requirements:
 #. pip install -r tests/requirements.txt
 
 Once you have finished your changes, please provide test case(s), relevant documentation
-and update CHANGELOG.rst.
+and update changelog.yml
 
 .. note::
 
@@ -372,7 +386,7 @@ On Linux/Unix systems, please launch your tests like this::
 
     $ make
 
-On Windows systems, please issue this command::
+On Windows, please issue this command::
 
     > test.bat
 
@@ -384,7 +398,7 @@ Please run::
 
     $ make format
 
-so as to beautify your code otherwise travis-ci may fail your unit test.
+so as to beautify your code otherwise your build may fail your unit test.
 
 
 Known Issues
diff --git a/changelog.yml b/changelog.yml
@@ -1,6 +1,15 @@
 name: pyexcel-xls
 organisation: pyexcel
 releases:
+- changes:
+  - action: Removed
+    details:
+    - "`#46`: remove the hard pin on xlrd version < 2.0"
+  - action: Added
+    details:
+    - "`#47`: limit support to persist datetime.timedelta. see more details in doc"
+  date: 07.10.2021
+  version: 0.7.0
 - changes:
   - action: Updated
     details:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,12 +23,12 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pyexcel-xls'
-copyright = '2015-2020 Onni Software Ltd.'
+copyright = '2015-2021 Onni Software Ltd.'
 author = 'C.W.'
 # The short X.Y version
-version = '0.6.2'
+version = '0.7.0'
 # The full version, including alpha/beta/rc tags
-release = '0.6.2'
+release = '0.7.0'
 
 # -- General configuration ---------------------------------------------------
 
diff --git a/pyexcel-xls.yml b/pyexcel-xls.yml
@@ -1,14 +1,14 @@
 overrides: "pyexcel.yaml"
 name: "pyexcel-xls"
 nick_name: xls
-version: 0.6.2
-current_version: 0.6.2
-release: 0.6.2
+version: 0.7.0
+current_version: 0.7.0
+release: 0.7.0
 file_type: xls
 is_on_conda: true
 dependencies:
   - pyexcel-io>=0.6.2
-  - xlrd<2
+  - xlrd
   - xlwt
 test_dependencies:
   - pyexcel
diff --git a/pyexcel_xls/__init__.py b/pyexcel_xls/__init__.py
@@ -4,9 +4,10 @@
 
     The lower level xls/xlsx/xlsm file format handler using xlrd/xlwt
 
-    :copyright: (c) 2016-2020 by Onni Software Ltd
+    :copyright: (c) 2016-2021 by Onni Software Ltd
     :license: New BSD License
 """
+import xlrd
 
 # flake8: noqa
 from pyexcel_io.io import get_data as read_data
@@ -19,20 +20,37 @@
 
 __FILE_TYPE__ = "xls"
 
+
+def xlrd_version_2_or_greater():
+    xlrd_version = getattr(xlrd, "__version__")
+
+    if xlrd_version:
+        major = int(xlrd_version.split(".")[0])
+        if major >= 2:
+            return True
+    return False
+
+
+XLRD_VERSION_2_OR_ABOVE = xlrd_version_2_or_greater()
+supported_file_formats = [__FILE_TYPE__, "xlsx", "xlsm"]
+if XLRD_VERSION_2_OR_ABOVE:
+    supported_file_formats.remove("xlsx")
+
+
 IOPluginInfoChainV2(__name__).add_a_reader(
     relative_plugin_class_path="xlsr.XLSInFile",
     locations=["file"],
-    file_types=[__FILE_TYPE__, "xlsx", "xlsm"],
+    file_types=supported_file_formats,
     stream_type="binary",
 ).add_a_reader(
     relative_plugin_class_path="xlsr.XLSInMemory",
     locations=["memory"],
-    file_types=[__FILE_TYPE__, "xlsx", "xlsm"],
+    file_types=supported_file_formats,
     stream_type="binary",
 ).add_a_reader(
     relative_plugin_class_path="xlsr.XLSInContent",
     locations=["content"],
-    file_types=[__FILE_TYPE__, "xlsx", "xlsm"],
+    file_types=supported_file_formats,
     stream_type="binary",
 ).add_a_writer(
     relative_plugin_class_path="xlsw.XLSWriter",
diff --git a/pyexcel_xls/xlsr.py b/pyexcel_xls/xlsr.py
@@ -4,7 +4,7 @@
 
     The lower level xls/xlsm file format handler using xlrd
 
-    :copyright: (c) 2016-2020 by Onni Software Ltd
+    :copyright: (c) 2016-2021 by Onni Software Ltd
     :license: New BSD License
 """
 import datetime
@@ -152,9 +152,7 @@ def __init__(self, file_type, **keywords):
     def read_sheet(self, index):
         native_sheet = self.content_array[index]
         sheet = XLSheet(
-            native_sheet,
-            date_mode=self.xls_book.datemode,
-            **self._keywords
+            native_sheet, date_mode=self.xls_book.datemode, **self._keywords
         )
         return sheet
 
diff --git a/pyexcel_xls/xlsw.py b/pyexcel_xls/xlsw.py
@@ -4,7 +4,7 @@
 
     The lower level xls file format handler using xlwt
 
-    :copyright: (c) 2016-2020 by Onni Software Ltd
+    :copyright: (c) 2016-2021 by Onni Software Ltd
     :license: New BSD License
 """
 import datetime
@@ -16,6 +16,7 @@
 
 DEFAULT_DATE_FORMAT = "DD/MM/YY"
 DEFAULT_TIME_FORMAT = "HH:MM:SS"
+DEFAULT_LONGTIME_FORMAT = "[HH]:MM:SS"
 DEFAULT_DATETIME_FORMAT = "%s %s" % (DEFAULT_DATE_FORMAT, DEFAULT_TIME_FORMAT)
 EMPTY_SHEET_NOT_ALLOWED = "xlwt does not support a book without any sheets"
 
@@ -52,6 +53,10 @@ def write_row(self, array):
                 value = xlrd.xldate.xldate_from_datetime_tuple(tmp_array, 0)
                 style = XFStyle()
                 style.num_format_str = DEFAULT_DATETIME_FORMAT
+            elif isinstance(value, datetime.timedelta):
+                value = value.days + value.seconds / 86_400
+                style = XFStyle()
+                style.num_format_str = DEFAULT_LONGTIME_FORMAT
             elif isinstance(value, datetime.date):
                 tmp_array = [value.year, value.month, value.day]
                 value = xlrd.xldate.xldate_from_date_tuple(tmp_array, 0)
@@ -83,7 +88,7 @@ def __init__(
         _,  # file_type not used
         encoding="ascii",
         style_compression=2,
-        **keywords
+        **keywords,
     ):
         self.file_alike_object = file_alike_object
         self.work_book = Workbook(
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
 pyexcel-io>=0.6.2
-xlrd<2
+xlrd
 xlwt
diff --git a/setup.py b/setup.py
@@ -32,15 +32,15 @@
 
 NAME = "pyexcel-xls"
 AUTHOR = "C.W."
-VERSION = "0.6.2"
+VERSION = "0.7.0"
 EMAIL = "info@pyexcel.org"
 LICENSE = "New BSD"
 DESCRIPTION = (
     "A wrapper library to read, manipulate and write data in xls format. It" +
     "reads xlsx and xlsm format"
 )
 URL = "https://github.com/pyexcel/pyexcel-xls"
-DOWNLOAD_URL = "%s/archive/0.6.2.tar.gz" % URL
+DOWNLOAD_URL = "%s/archive/0.7.0.tar.gz" % URL
 FILES = ["README.rst","CONTRIBUTORS.rst", "CHANGELOG.rst"]
 KEYWORDS = [
     "python",
@@ -69,7 +69,7 @@
 
 INSTALL_REQUIRES = [
     "pyexcel-io>=0.6.2",
-    "xlrd<2",
+    "xlrd",
     "xlwt",
 ]
 SETUP_COMMANDS = {}
@@ -81,8 +81,8 @@
 PUBLISH_COMMAND = "{0} setup.py sdist bdist_wheel upload -r pypi".format(sys.executable)
 HERE = os.path.abspath(os.path.dirname(__file__))
 
-GS_COMMAND = ("gease pyexcel-xls v0.6.2 " +
-              "Find 0.6.2 in changelog for more details")
+GS_COMMAND = ("gease pyexcel-xls v0.7.0 " +
+              "Find 0.7.0 in changelog for more details")
 NO_GS_MESSAGE = ("Automatic github release is disabled. " +
                  "Please install gease to enable it.")
 UPLOAD_FAILED_MSG = (
diff --git a/tests/test_bug_fixes.py b/tests/test_bug_fixes.py
diff --git a/tests/test_formatters.py b/tests/test_formatters.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2015-2020 by Onni Software Ltd. and its contributors`
	`1`	`+Copyright (c) 2015-2021 by Onni Software Ltd. and its contributors`
`2`	`2`	`All rights reserved.`
`3`	`3`
`4`	`4`	`Redistribution and use in source and binary forms of the software as well`