openpyxl条件格式设置数字格式

Posted 2023-04-13

【中文标题】openpyxl条件格式设置数字格式

【英文标题】：openpyxl conditional formatting set number format

【发布时间】：2015-11-12 21:00:22

【问题描述】：

我正在尝试将数字格式设置为条件格式。我找到了如何设置字体、边框和填充颜色，但我无法设置数字格式。我目前拥有的代码是：

from openpyxl import load_workbook
from openpyxl.styles import PatternFill, Font, Border, Side
from openpyxl.formatting.rule import FormulaRule, DifferentialStyle, Rule

wb = load_workbook(filename='Excel_Templates\MyTemplate.xlsx')
ws = wb.get_sheet_by_name('Sheet1')
red_fill = PatternFill(start_color='FFFF0000', end_color='FFFF0000', fill_type='solid')
pink_fill = PatternFill(start_color='FFFF5050', end_color='FFFF5050', fill_type='solid')
light_pink_fill = PatternFill(start_color='FFFF9B99', end_color='FFFF9B99', fill_type='solid')
blue_fill = PatternFill(start_color='FF0000FF', end_color='FF0000FF', fill_type='solid')
light_blue_fill = PatternFill(start_color='FF0066FF', end_color='FF0066FF', fill_type='solid')
v_light_blue_fill = PatternFill(start_color='FF9BC2E6', end_color='FF9BC2E6', fill_type='solid')

side = Side(style='thin', color='FF000000')
myBorder = Border(left=side, right=side, bottom=side, top=side)
my_white_font = Font(color='FFFFFFFF', size=12)
my_black_font = Font(size=12)
p='E3'
num = 'E8'
denom = 'E9'
ws['0'.format(p)] = '=IF(0/1 >= 2, 0/1, IF(AND(0/1>=0, 0/1 <2),0/1-1, 1-0/1))'.format(
    num, denom)

    ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['0 < -0.5'.format(p)], fill=red_fill, font=my_black_font))

ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['AND(0 < -0.25, 0 >=-0.5)'.format(p)], fill=pink_fill,
                                          font=my_black_font))

ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['AND(0 < 0, 0 >=-0.25)'.format(p)], fill=light_pink_fill,
                                          font=my_black_font))

ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['AND(0 >=0, 0 < 1)'.format(p)], fill=v_light_blue_fill,
                                          font=my_black_font))

ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['AND(0 >=1, 0 <= 3)'.format(p)], fill=light_blue_fill,
                                          font=my_white_font))

ws.conditional_formatting.add('0'.format(p),
                              FormulaRule(formula=['0 > 3'.format(p)], fill=blue_fill,
                                          font=my_white_font))

我想将前 4 种格式的格式设置为不带小数点的百分比，我想将后两种格式设置为“+”0.0“X”。我查看了源代码，但找不到这样做的方法。任何帮助，将不胜感激。我正在使用 Python 3，以及带有 Excel 2010 的 Openpyxl 2.3.0。

更新 1：

我根据查理的建议更新了我的代码。我补充说：

dxf = DifferentialStyle(fill=blue_fill, font=my_white_font, numFmt='0.00%')
ws.conditional_formatting.add('0'.format(p), Rule(formula=['0 > 3'.format(p)], dxf=dxf))

这给了我以下错误消息。

File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\styles\differential.py", line 57, in __init__
self.numFmt = numFmt
File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\descriptors\base.py", line 42, in __set__
raise TypeError('expected ' + str(self.expected_type))
TypeError: expected <class 'openpyxl.styles.differential.NumFmt'>

更新 2：

事实证明，Differential Style 中的 numFmt 选项需要一个 NumFmt 的类实例，该类实例定义在 openpyxl.style.differential 中。我将我的 Update 1 代码更改为以下内容：

from openpyxl.styles.differential import NumFmt
dxf = DifferentialStyle(fill=blue_fill, font=my_white_font, numFmt=NumFmt(10, '0.00%'))
r = Rule('expression', formula=['0 > 3'.format(p)], dxf=dxf)
ws.conditional_formatting.add('0'.format(p), r)

现在这些都可以正常工作，但是，当我打电话时

wb.save("test.xlsx")

我收到以下错误消息

    File "C:/TestProj/openpyxl_test.py", line 90, in <module>
    wb.save("test.xlsx")
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\workbook\workbook.py", line 263, in save
    save_workbook(self, filename)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\excel.py", line 230, in save_workbook
    writer.save(filename, as_template=as_template)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\excel.py", line 213, in save
    self.write_data(archive, as_template=as_template)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\excel.py", line 87, in write_data
    self._write_worksheets(archive)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\excel.py", line 158, in _write_worksheets
    xml = sheet._write(self.workbook.shared_strings)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\worksheet\worksheet.py", line 772, in _write
    return write_worksheet(self, shared_strings)
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\worksheet.py", line 223, in write_worksheet
    for cf in cfs:
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\writer\worksheet.py", line 119, in write_conditional_formatting
    if rule.dxf != DifferentialStyle():
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\styles\hashable.py", line 77, in __ne__
    return not self == other
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\styles\hashable.py", line 73, in __eq__
    return self.key == other.key
  File "C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\styles\hashable.py", line 65, in key
    self._key = hash(tuple(fields))
TypeError: unhashable type: 'NumFmt'

【参考方案1】：

我强烈怀疑问题的根源是 openpyxl 中的错误。问题似乎是 NumFmt 类不可散列。我认为这可能源于它源自Serialisable，而不是HashableObject。因此，它本质上缺少__hash__ 函数。我认为您可以通过向 NumFmt 类添加 __hash__ 函数来解决此问题，如下所示：

class NumFmt(Serialisable):

    numFmtId = Integer()
    formatCode = String()

    def __init__(self,
                 numFmtId=None,
                 formatCode=None,
                ):
        self.numFmtId = numFmtId
        self.formatCode = formatCode

    def __hash__(self):
        return hash((self.numFmtId, self.formatCode))

有了这个，我可以让下面的例子工作： 从 openpyxl 导入 load_workbook 从 openpyxl.styles 导入 PatternFill 从 openpyxl.formatting.rule 导入差分样式，规则 from openpyxl.styles.differential import NumFmt

wb = load_workbook(filename=r'C:\users\vanhamme\Desktop\foobar.xlsx')
ws = wb['Sheet1']

blue_fill = PatternFill(start_color='FF0000FF', end_color='FF0000FF', fill_type='solid')

dxf = DifferentialStyle(fill=blue_fill, numFmt=NumFmt(10, '0.00%'))
rule = Rule('expression', formula=['E3 > 3'], dxf=dxf)
ws.conditional_formatting.add('E3', rule)

wb.save(r'C:\users\vanhamme\Desktop\foobar2.xlsx')

这可能不是最优雅的解决方案。不幸的是，我不太了解 openpyxl 类层次结构，无法知道是否有更短、更清晰的路线。

【讨论】：

我认为您可能是正确的。但是，我们可能可以使用描述符来允许读取格式并允许仅分配具有默认代码编号的字符串。然后序列化将负责格式代码查找/注册。不用说，这以前没有被提出过。

【参考方案2】：

直接使用openpyxl.formatting.rule.Rule 进行完全控制。 FormulaRule 只是为了向后兼容而保留的，并没有暴露所有的可能性，但是如果你查看它的源代码，你会发现你可以传入 DifferentialStyle 的任何实例

【讨论】：

我试过了，但我不知道如何指定 numFmt=NumFmt(numFmtId, formatCode) 函数。从代码或文档中不清楚 numFmtId 和 formatCode 的内容。那些是在 Lib\site-packages\openpyxl\numbers.py 文件中定义的值吗？我尝试的一切都在崩溃。此外，通过查看 numbers.py 文件，我的自定义格式“+”0.0“X”似乎会出错，因为它没有定义。另外，我没有足够的声誉来支持您的答案。对不起。

不要让事情变得比需要的更难：数字格式始终只是一个字符串。

我显然不明白。我将此行添加到我的代码中： ws.conditional_formatting.add('0'.format(p), DifferentialStyle(fill=blue_fill, font=my_white_font, numFmt='0.00%')) 它给了我这个错误： init 中的文件“C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\styles\differential.py”，第 57 行，self.numFmt = numFmt 文件“C:\WinPython-32bit-3.4.3.3\python-3.4.3\lib\site-packages\openpyxl\descriptors\base.py”，第 42 行，在 set 中引发 TypeError( '预期' + str(self.expected_type)) 类型错误：预期

1.创建 Dxf，2. 创建规则，3. 将规则分配给单元格范围。