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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
.. _dwgmanagement:
Document Management
===================
Create New Drawings
-------------------
.. autofunction:: ezdxf.new(dxfversion='AC1027', setup=False, units=6) -> Drawing
Open Drawings
-------------
Open DXF drawings from file system or text stream, byte stream usage is not supported.
DXF files prior to R2007 requires file encoding defined by header variable $DWGCODEPAGE, DXF R2007 and later
requires an UTF-8 encoding.
`ezdxf` supports reading of files for following DXF versions:
=========== ========== ============== ===================================
Version Release Encoding Remarks
=========== ========== ============== ===================================
< AC1009 $DWGCODEPAGE pre AutoCAD R12 upgraded to AC1009
AC1009 R12 $DWGCODEPAGE AutoCAD R12
AC1012 R13 $DWGCODEPAGE AutoCAD R13 upgraded to AC1015
AC1014 R14 $DWGCODEPAGE AutoCAD R14 upgraded to AC1015
AC1015 R2000 $DWGCODEPAGE AutoCAD R2000
AC1018 R2004 $DWGCODEPAGE AutoCAD R2004
AC1021 R2007 UTF-8 AutoCAD R2007
AC1024 R2010 UTF-8 AutoCAD R2010
AC1027 R2013 UTF-8 AutoCAD R2013
AC1032 R2018 UTF-8 AutoCAD R2018
=========== ========== ============== ===================================
.. autofunction:: ezdxf.readfile
.. autofunction:: ezdxf.read
.. autofunction:: ezdxf.readzip
.. autofunction:: ezdxf.decode_base64
.. hint::
This works well with DXF files from trusted sources like AutoCAD or BricsCAD,
for loading DXF files with minor or major flaws look at the
:mod:`ezdxf.recover` module.
Save Drawings
-------------
Save the DXF document to the file system by :class:`~ezdxf.document.Drawing` methods
:meth:`~ezdxf.document.Drawing.save` or :meth:`~ezdxf.document.Drawing.saveas`.
Write the DXF document to a text stream with :meth:`~ezdxf.document.Drawing.write`,
the text stream requires at least a :meth:`write` method. Get required output
encoding for text streams by property :attr:`Drawing.output_encoding`
.. _globaloptions:
Drawing Settings
----------------
The :class:`~ezdxf.sections.header.HeaderSection` stores meta data like modelspace extensions, user name or saving time
and current application settings, like actual layer, text style or dimension style settings. These settings are not
necessary to process DXF data and therefore many of this settings are not maintained by `ezdxf` automatically.
Header variables set at new
~~~~~~~~~~~~~~~~~~~~~~~~~~~
================ =================================
$ACADVER DXF version
$TDCREATE date/time at creating the drawing
$FINGERPRINTGUID every drawing gets a GUID
================ =================================
Header variables updated at saving
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
================ =================================
$TDUPDATE actual date/time at saving
$HANDSEED next available handle as hex string
$DWGCODEPAGE encoding setting
$VERSIONGUID every saved version gets a new GUID
================ =================================
.. seealso::
- Howto: :ref:`set/get header variables`
- Howto: :ref:`set drawing units`
.. _ezdxf_metadata:
Ezdxf Metadata
~~~~~~~~~~~~~~
.. versionadded:: 0.17
Store internal metadata like *ezdxf* version and creation time for
a new created document as metadata in the DXF file. Only standard DXF features
are used to store meta data and this meta data is preserved by Autodesk products,
BricsCAD and of course *ezdxf*. Other 3rd party DXF libraries may remove this
meta data.
For DXF R12 the meta data is stored as XDATA by AppID ``EZDXF`` in the model
space BLOCK entity in the BLOCKS section.
For DXF R2000+ the meta data is stored in the "root" DICTIONARY in the
OBJECTS section as a DICTIONARY object by the key ``EZDXF_META``.
The :class:`MetaData` object has a dict-like interface and can also store
custom metadata::
metadata = doc.ezdxf_metadata()
# set data
metadata["MY_CUSTOM_META_DATA"] = "a string with max. length of 254"
# get data, raises a KeyError() if key not exist
value = metadata["MY_CUSTOM_META_DATA"]
# get data, returns an empty string if key not exist
value = metadata.get("MY_CUSTOM_META_DATA")
# delete entry, raises a KeyError() if key not exist
del metadata["MY_CUSTOM_META_DATA"]
# discard entry, does not raise a KeyError() if key not exist
metadata.discard("MY_CUSTOM_META_DATA")
Keys and values are limited to strings with a max. length of 254 characters
and line ending ``\n`` will be replaced by ``\P``.
Keys used by *ezdxf*:
- ``WRITTEN_BY_EZDXF``: *ezdxf* version and UTC time in ISO format
- ``CREATED_BY_EZDXF``: *ezdxf* version and UTC time in ISO format
Example of the ezdxf marker string: ``0.16.4b1 @ 2021-06-12T07:35:34.898808+00:00``
.. class:: ezdxf.document.MetaData
.. automethod:: __contains__
.. automethod:: __getitem__
.. automethod:: get
.. automethod:: __setitem__
.. automethod:: __delitem__
.. automethod:: discard
|
