✨ add a wrapper for xlsx book and sheet. #56

Author: chfw

changelog.yml

@@ -1,6 +1,12 @@
 name: pyexcel-xlsx
 organisation: pyexcel
 releases:
+- changes:
+  - action: Updated
+    details:
+    - '`#56`: to add a csv file as sheet to a xlsx file'
+  date: 10.05.2025
+  version: 0.7.0
 - changes:
   - action: Updated
     details:

pyexcel-xlsx.yml

@@ -2,8 +2,8 @@ overrides: "pyexcel.yaml"
 name: "pyexcel-xlsx"
 project: "pyexcel-xlsx"
 nick_name: xlsx
-version: 0.6.1
-current_version: 0.6.1
+version: 0.7.0
+current_version: 0.7.0
 release: 0.6.1
 file_type: xlsx
 gitignore_language: Python

pyexcel_xlsx/book.py

@@ -0,0 +1,46 @@
+"""
+pyexcel_xlsx.xlsxr
+~~~~~~~~~~~~~~~~~~~
+
+Read xlsx file format using openpyxl
+
+:copyright: (c) 2015-2025 by Onni Software Ltd & its contributors
+:license: New BSD License
+"""
+
+import openpyxl
+
+
+class Sheet(object):
+    def __init__(self, xlsx_sheet):
+        self.xlsx_sheet = xlsx_sheet
+
+    def __getitem__(self, cell):
+        return self.xlsx_sheet[cell]
+
+    def __setitem__(self, cell, value):
+        self.xlsx_sheet[cell] = value
+
+    def append(self, data):
+        self.xlsx_sheet.append(data)
+
+
+class Book(object):
+    def __init__(self, file_name):
+        self.xlsx_book = openpyxl.load_workbook(
+            filename=file_name,
+        )
+
+    def save(self, file_name):
+        self.xlsx_book.save(file_name)
+
+    def close(self):
+        self.xlsx_book.close()
+
+    def __getitem__(self, key):
+        if key not in self.xlsx_book.sheetnames:
+            self.xlsx_book.create_sheet(key)
+        return Sheet(self.xlsx_book[key])
+
+    def __delitem__(self, other):
+        self.xlsx_book.remove(self.xlsx_book[other])

tests/test_book.py

@@ -0,0 +1,34 @@
+import os
+from datetime import time, datetime
+
+from pyexcel_xlsx import get_data
+from pyexcel_xlsx.book import Book
+from pyexcel_io._compact import OrderedDict
+
+from nose.tools import eq_
+
+
+def test_book():
+    test_file = "book_test.xlsx"
+    book = Book(os.path.join("tests", "fixtures", "date_field.xlsx"))
+    sheet = book["Sheet2"]
+    sheet["A1"] = "Test"
+    book.save(test_file)
+    book.close()
+
+    data = get_data(test_file)
+    eq_(data["Sheet2"], [["Test"]])
+    os.unlink(test_file)
+
+
+def test_create_new_sheet():
+    test_file = "book_test.xlsx"
+    book = Book(os.path.join("tests", "fixtures", "date_field.xlsx"))
+    sheet = book["alien"]
+    sheet["A1"] = "Test"
+    book.save(test_file)
+    book.close()
+
+    data = get_data(test_file)
+    eq_(data["alien"], [["Test"]])
+    os.unlink(test_file)