FilesExpand file tree

develop

/

api.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

37 lines (29 loc) · 1.15 KB

develop

/

api.py

Copy path

Top

File metadata and controls

• Code
• Blame

37 lines (29 loc) · 1.15 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

# encoding: utf-8

"""

Directly exposed API functions and classes, :func:`Document` for now.

Provides a syntactically more convenient API for interacting with the

OpcPackage graph.

"""

from __future__ import absolute_import, division, print_function

import os

from docx.opc.constants import CONTENT_TYPE as CT

from docx.package import Package

def Document(docx=None):

"""

Return a |Document| object loaded from *docx*, where *docx* can be

either a path to a ``.docx`` file (a string) or a file-like object. If

*docx* is missing or ``None``, the built-in default document "template"

is loaded.

"""

docx = _default_docx_path() if docx is None else docx

document_part = Package.open(docx).main_document_part

if document_part.content_type != CT.WML_DOCUMENT_MAIN:

tmpl = "file '%s' is not a Word file, content type is '%s'"

raise ValueError(tmpl % (docx, document_part.content_type))

return document_part.document

def _default_docx_path():

"""

Return the path to the built-in default .docx package.

"""

_thisdir = os.path.split(__file__)[0]

return os.path.join(_thisdir, 'templates', 'default.docx')