Get and set the shading color on run and paragraphs

[translation-robot]

I use this code to get the shading color on run and on paragraphs, how to add a function on run and paragraph in python-docx code repo to get shading color when it is found ? I found this feature missing in the python-docx.

from lxml import etree

def get_paragraph_shading_color(xml_paragraph_str):
    paragraph_xml = etree.fromstring(xml_paragraph_str)
    attrib_fill = None
    
    namespaces = {'w':'http://schemas.openxmlformats.org/wordprocessingml/2006/main'}
    try:
        namespaces = {paragraph_xml.prefix : paragraph_xml.nsmap[paragraph_xml.prefix]}
    except:
        #print("Could not determine namespace")
        pass
    attrib_fill = None
    
    for e in paragraph_xml.findall('.//w:pPr/w:shd', namespaces):
        #print("e:", etree.tostring(e, pretty_print=True))
        try:
            attrib_val = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}val')
            attrib_color = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}color')
            attrib_fill = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}fill')
            #print(f"attrib_color : {attrib_color}")
            #print(f"attrib_fill : {attrib_fill}")
            #print(f"attrib_val : {attrib_val}")
        except:
            pass
    return attrib_fill

def get_run_shading_color(xml_run_str):
    run_xml = etree.fromstring(xml_run_str)
    
    namespaces = {'w':'http://schemas.openxmlformats.org/wordprocessingml/2006/main'}
    try:
        namespaces = {run_xml.prefix : run_xml.nsmap[run_xml.prefix]}
    except:
        #print("Could not determine namespace")
        pass
    attrib_fill = None
    
    for e in run_xml.findall('.//w:rPr/w:shd', namespaces):
        #print("e:", etree.tostring(e, pretty_print=True))
        try:
            attrib_val = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}val')
            attrib_color = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}color')
            attrib_fill = e.attrib.get('{http://schemas.openxmlformats.org/wordprocessingml/2006/main}fill')
        except:
            pass
    return attrib_fill

root = etree.fromstring(run.element.xml)
run_shading_color = get_run_shading_color(run.element.xml)

root = etree.fromstring(paragraph._p.xml)
p_shading_color = get_paragraph_shading_color(paragraph._p.xml)

[translation-robot]

This is a sample paragraph with shading:

<w:r xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:cx="http://schemas.microsoft.com/office/drawing/2014/chartex" xmlns:cx1="http://schemas.microsoft.com/office/drawing/2015/9/8/chartex" xmlns:cx2="http://schemas.microsoft.com/office/drawing/2015/10/21/chartex" xmlns:cx3="http://schemas.microsoft.com/office/drawing/2016/5/9/chartex" xmlns:cx4="http://schemas.microsoft.com/office/drawing/2016/5/10/chartex" xmlns:cx5="http://schemas.microsoft.com/office/drawing/2016/5/11/chartex" xmlns:cx6="http://schemas.microsoft.com/office/drawing/2016/5/12/chartex" xmlns:cx7="http://schemas.microsoft.com/office/drawing/2016/5/13/chartex" xmlns:cx8="http://schemas.microsoft.com/office/drawing/2016/5/14/chartex" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:aink="http://schemas.microsoft.com/office/drawing/2016/ink" xmlns:am3d="http://schemas.microsoft.com/office/drawing/2017/model3d" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:oel="http://schemas.microsoft.com/office/2019/extlst" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" xmlns:w16cex="http://schemas.microsoft.com/office/word/2018/wordml/cex" xmlns:w16cid="http://schemas.microsoft.com/office/word/2016/wordml/cid" xmlns:w16="http://schemas.microsoft.com/office/word/2018/wordml" xmlns:w16sdtdh="http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash" xmlns:w16se="http://schemas.microsoft.com/office/word/2015/wordml/symex" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape">
  <w:rPr>
    <w:sz w:val="28"/>
    <w:shd w:val="clear" w:color="auto" w:fill="FFAAAA"/>
    <w:lang w:val="en-US"/>
  </w:rPr>
  <w:t>This paragraph's text has shading color.</w:t>
</w:r>

[translation-robot]

In this example, we add shading to a paragraph:

from docx import Document
from docx.shared import Pt
from docx.oxml.ns import qn
from docx.oxml.shared import OxmlElement

# Create a template
doc = Document()

# Add a paragraph
p = doc.add_paragraph('This text is shadowed')

# Create XML element
shd = OxmlElement('w:shd')

# Add attributes to the element
shd.set(qn('w:val'), 'clear')
shd.set(qn('w:color'), 'auto')
shd.set(qn('w:fill'), 'FFAAAA')

# Make sure the paragraph styling element exists
p.paragraph_format.element.get_or_add_pPr()

# Append the shading element
p.paragraph_format.element.pPr.append(shd)

# Save document
doc.save('d.docx')

[translation-robot]

I see there was no release since past 2 years, project is abandonned ?

[scanny]

@translation-robot No, not abandoned.