annotate Lib/copy.py @ 27998:e27f58a50737 legacy-trunk

SF bug #690377: Dud footnote reference in distutils docs
author Raymond Hettinger <python@rcn.com>
date Fri, 21 Feb 2003 02:47:09 +0000
parents 226463445697
children 14f65d661084
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11708
4a23cc49e2b0 Actually, the previous batch's comment should have been different;
Guido van Rossum <guido@python.org>
parents: 9945
diff changeset
1 """Generic (shallow and deep) copying operations.
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
2
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
3 Interface summary:
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
4
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
5 import copy
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
6
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
7 x = copy.copy(y) # make a shallow copy of y
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
8 x = copy.deepcopy(y) # make a deep copy of y
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
9
27733
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
10 For module specific errors, copy.Error is raised.
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
11
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
12 The difference between shallow and deep copying is only relevant for
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
13 compound objects (objects that contain other objects, like lists or
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
14 class instances).
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
15
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
16 - A shallow copy constructs a new compound object and then (to the
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
17 extent possible) inserts *the same objects* into in that the
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
18 original contains.
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
19
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
20 - A deep copy constructs a new compound object and then, recursively,
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
21 inserts *copies* into it of the objects found in the original.
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
22
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
23 Two problems often exist with deep copy operations that don't exist
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
24 with shallow copy operations:
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
25
5659
6f9a2c874018 Remove '(' in column 0 of doc strings.
Guido van Rossum <guido@python.org>
parents: 3685
diff changeset
26 a) recursive objects (compound objects that, directly or indirectly,
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
27 contain a reference to themselves) may cause a recursive loop
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
28
5659
6f9a2c874018 Remove '(' in column 0 of doc strings.
Guido van Rossum <guido@python.org>
parents: 3685
diff changeset
29 b) because deep copy copies *everything* it may copy too much, e.g.
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
30 administrative data structures that should be shared even between
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
31 copies
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
32
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
33 Python's deep copy operation avoids these problems by:
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
34
5659
6f9a2c874018 Remove '(' in column 0 of doc strings.
Guido van Rossum <guido@python.org>
parents: 3685
diff changeset
35 a) keeping a table of objects already copied during the current
6f9a2c874018 Remove '(' in column 0 of doc strings.
Guido van Rossum <guido@python.org>
parents: 3685
diff changeset
36 copying pass
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
37
5659
6f9a2c874018 Remove '(' in column 0 of doc strings.
Guido van Rossum <guido@python.org>
parents: 3685
diff changeset
38 b) letting user-defined classes override the copying operation or the
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
39 set of components copied
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
40
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
41 This version does not copy types like module, class, function, method,
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
42 nor stack trace, stack frame, nor file, socket, window, nor array, nor
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
43 any similar types.
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
44
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
45 Classes can use the same interfaces to control copying that they use
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
46 to control pickling: they can define methods called __getinitargs__(),
6771
33e2145250af Apply the same change to classes without an __getinitargs__() method
Guido van Rossum <guido@python.org>
parents: 6527
diff changeset
47 __getstate__() and __setstate__(). See the documentation for module
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
48 "pickle" for information on these methods.
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
49 """
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
50
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 import types
27960
cb3f18908ceb Remove now unused _better_reduce.
Guido van Rossum <guido@python.org>
parents: 27959
diff changeset
52 from copy_reg import dispatch_table
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
53
14022
d44603f2b928 Convert some old-style string exceptions to class exceptions.
Fred Drake <fdrake@acm.org>
parents: 11708
diff changeset
54 class Error(Exception):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
55 pass
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
56 error = Error # backward compatibility
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
15437
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
58 try:
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
59 from org.python.core import PyStringMap
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
60 except ImportError:
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
61 PyStringMap = None
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
62
27733
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
63 __all__ = ["Error", "copy", "deepcopy"]
16070
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 15867
diff changeset
64
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 def copy(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
66 """Shallow copy operation on arbitrary Python objects.
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
67
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
68 See the module's __doc__ string for more info.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
69 """
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
70
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
71 cls = type(x)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
72
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
73 copier = _copy_dispatch.get(cls)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
74 if copier:
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
75 return copier(x)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
76
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
77 copier = getattr(cls, "__copy__", None)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
78 if copier:
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
79 return copier(x)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
80
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
81 reductor = dispatch_table.get(cls)
27959
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
82 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
83 rv = reductor(x)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
84 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
85 reductor = getattr(x, "__reduce_ex__", None)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
86 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
87 rv = reductor(2)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
88 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
89 reductor = getattr(x, "__reduce__", None)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
90 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
91 rv = reductor()
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
92 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
93 raise Error("un(shallow)copyable object of type %s" % cls)
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
94
27959
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
95 return _reconstruct(x, rv, 0)
27963
226463445697 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 27960
diff changeset
96
27733
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
97
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
98 _copy_dispatch = d = {}
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
99
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 def _copy_atomic(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
101 return x
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 d[types.NoneType] = _copy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 d[types.IntType] = _copy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 d[types.LongType] = _copy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 d[types.FloatType] = _copy_atomic
27262
77428e835d67 Support copying booleans. Fixes #668925.
Martin v. Löwis <martin@v.loewis.de>
parents: 24766
diff changeset
106 d[types.BooleanType] = _copy_atomic
20153
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
107 try:
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
108 d[types.ComplexType] = _copy_atomic
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
109 except AttributeError:
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
110 pass
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 d[types.StringType] = _copy_atomic
19343
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
112 try:
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
113 d[types.UnicodeType] = _copy_atomic
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
114 except AttributeError:
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
115 pass
9945
c39c4bc45d39 Don't die if CodeType doesn't exist -- ignore the error. This could
Guido van Rossum <guido@python.org>
parents: 7752
diff changeset
116 try:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
117 d[types.CodeType] = _copy_atomic
9945
c39c4bc45d39 Don't die if CodeType doesn't exist -- ignore the error. This could
Guido van Rossum <guido@python.org>
parents: 7752
diff changeset
118 except AttributeError:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
119 pass
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 d[types.TypeType] = _copy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 d[types.XRangeType] = _copy_atomic
2540
d7ae5fb1d255 rename copy.Error to copy.error
Guido van Rossum <guido@python.org>
parents: 2303
diff changeset
122 d[types.ClassType] = _copy_atomic
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
123
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 def _copy_list(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
125 return x[:]
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 d[types.ListType] = _copy_list
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
127
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
128 def _copy_tuple(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
129 return x[:]
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 d[types.TupleType] = _copy_tuple
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
131
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 def _copy_dict(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
133 return x.copy()
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
134 d[types.DictionaryType] = _copy_dict
15437
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
135 if PyStringMap is not None:
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
136 d[PyStringMap] = _copy_dict
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
137
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
138 def _copy_inst(x):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
139 if hasattr(x, '__copy__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
140 return x.__copy__()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
141 if hasattr(x, '__getinitargs__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
142 args = x.__getinitargs__()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
143 y = apply(x.__class__, args)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
144 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
145 y = _EmptyClass()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
146 y.__class__ = x.__class__
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
147 if hasattr(x, '__getstate__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
148 state = x.__getstate__()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
149 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
150 state = x.__dict__
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
151 if hasattr(y, '__setstate__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
152 y.__setstate__(state)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
153 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
154 y.__dict__.update(state)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
155 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
156 d[types.InstanceType] = _copy_inst
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
157
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
158 del d
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
159
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
160 def deepcopy(x, memo=None, _nil=[]):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
161 """Deep copy operation on arbitrary Python objects.
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
162
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
163 See the module's __doc__ string for more info.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
164 """
2303
505fc478ff08 added __doc__ strings etc.
Guido van Rossum <guido@python.org>
parents: 2101
diff changeset
165
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
166 if memo is None:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
167 memo = {}
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
168
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
169 d = id(x)
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
170 y = memo.get(d, _nil)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
171 if y is not _nil:
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
172 return y
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
173
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
174 cls = type(x)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
175
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
176 copier = _deepcopy_dispatch.get(cls)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
177 if copier:
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
178 y = copier(x, memo)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
179 else:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
180 try:
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
181 issc = issubclass(cls, type)
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
182 except TypeError: # cls is not a class (old Boost; see SF #502085)
23768
4680ef4fe90a SF patch 560794 (Greg Chapman): deepcopy can't handle custom
Guido van Rossum <guido@python.org>
parents: 23705
diff changeset
183 issc = 0
4680ef4fe90a SF patch 560794 (Greg Chapman): deepcopy can't handle custom
Guido van Rossum <guido@python.org>
parents: 23705
diff changeset
184 if issc:
27959
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
185 y = _deepcopy_atomic(x, memo)
23768
4680ef4fe90a SF patch 560794 (Greg Chapman): deepcopy can't handle custom
Guido van Rossum <guido@python.org>
parents: 23705
diff changeset
186 else:
27959
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
187 copier = getattr(x, "__deepcopy__", None)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
188 if copier:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
189 y = copier(memo)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
190 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
191 reductor = dispatch_table.get(cls)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
192 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
193 rv = reductor(x)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
194 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
195 reductor = getattr(x, "__reduce_ex__", None)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
196 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
197 rv = reductor(2)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
198 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
199 reductor = getattr(x, "__reduce__", None)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
200 if reductor:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
201 rv = reductor()
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
202 else:
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
203 raise Error(
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
204 "un(deep)copyable object of type %s" % cls)
cc4ad9afa21d Use __reduce_ex__ in copy.py. The test_*copy_cant() tests are simpler again.
Guido van Rossum <guido@python.org>
parents: 27755
diff changeset
205 y = _reconstruct(x, rv, 1, memo)
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
206
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
207 memo[d] = y
24766
58ea420ddc5e Make sure that *any* object whose id() is used as a memo key is kept
Guido van Rossum <guido@python.org>
parents: 23768
diff changeset
208 _keep_alive(x, memo) # Make sure x lives at least as long as d
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
209 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
210
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
211 _deepcopy_dispatch = d = {}
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
212
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
213 def _deepcopy_atomic(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
214 return x
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
215 d[types.NoneType] = _deepcopy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
216 d[types.IntType] = _deepcopy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
217 d[types.LongType] = _deepcopy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
218 d[types.FloatType] = _deepcopy_atomic
27262
77428e835d67 Support copying booleans. Fixes #668925.
Martin v. Löwis <martin@v.loewis.de>
parents: 24766
diff changeset
219 d[types.BooleanType] = _deepcopy_atomic
20153
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
220 try:
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
221 d[types.ComplexType] = _deepcopy_atomic
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
222 except AttributeError:
c68ef47b1709 Add complex to the dispatch tables, to avoid going through the whole
Guido van Rossum <guido@python.org>
parents: 20152
diff changeset
223 pass
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
224 d[types.StringType] = _deepcopy_atomic
19343
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
225 try:
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
226 d[types.UnicodeType] = _deepcopy_atomic
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
227 except AttributeError:
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 16070
diff changeset
228 pass
22135
9fdde8ccdca6 backport gvanrossum's checkin of
Michael W. Hudson <mwh@python.net>
parents: 21587
diff changeset
229 try:
9fdde8ccdca6 backport gvanrossum's checkin of
Michael W. Hudson <mwh@python.net>
parents: 21587
diff changeset
230 d[types.CodeType] = _deepcopy_atomic
9fdde8ccdca6 backport gvanrossum's checkin of
Michael W. Hudson <mwh@python.net>
parents: 21587
diff changeset
231 except AttributeError:
9fdde8ccdca6 backport gvanrossum's checkin of
Michael W. Hudson <mwh@python.net>
parents: 21587
diff changeset
232 pass
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
233 d[types.TypeType] = _deepcopy_atomic
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
234 d[types.XRangeType] = _deepcopy_atomic
27755
98c34cc1cf40 Somehow, copy() of a classic class object was handled
Guido van Rossum <guido@python.org>
parents: 27754
diff changeset
235 d[types.ClassType] = _deepcopy_atomic
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
236
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
237 def _deepcopy_list(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
238 y = []
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
239 memo[id(x)] = y
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
240 for a in x:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
241 y.append(deepcopy(a, memo))
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
242 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
243 d[types.ListType] = _deepcopy_list
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
244
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
245 def _deepcopy_tuple(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
246 y = []
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
247 for a in x:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
248 y.append(deepcopy(a, memo))
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
249 d = id(x)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
250 try:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
251 return memo[d]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
252 except KeyError:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
253 pass
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
254 for i in range(len(x)):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
255 if x[i] is not y[i]:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
256 y = tuple(y)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
257 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
258 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
259 y = x
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
260 memo[d] = y
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
261 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
262 d[types.TupleType] = _deepcopy_tuple
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
263
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
264 def _deepcopy_dict(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
265 y = {}
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
266 memo[id(x)] = y
23634
dbee2f628a90 Replaced .keys() with dictionary iterators
Raymond Hettinger <python@rcn.com>
parents: 23620
diff changeset
267 for key, value in x.iteritems():
dbee2f628a90 Replaced .keys() with dictionary iterators
Raymond Hettinger <python@rcn.com>
parents: 23620
diff changeset
268 y[deepcopy(key, memo)] = deepcopy(value, memo)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
269 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
270 d[types.DictionaryType] = _deepcopy_dict
15437
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
271 if PyStringMap is not None:
d5f0696c37e8 Patch by Finn Bock to support PyStringMap in Jython.
Guido van Rossum <guido@python.org>
parents: 14449
diff changeset
272 d[PyStringMap] = _deepcopy_dict
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
273
6116
07b7d4320b14 Make sure the objects returned by __getinitargs__() are kept alive (in
Guido van Rossum <guido@python.org>
parents: 5659
diff changeset
274 def _keep_alive(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
275 """Keeps a reference to the object x in the memo.
6116
07b7d4320b14 Make sure the objects returned by __getinitargs__() are kept alive (in
Guido van Rossum <guido@python.org>
parents: 5659
diff changeset
276
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
277 Because we remember objects by their id, we have
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
278 to assure that possibly temporary objects are kept
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
279 alive by referencing them.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
280 We store a reference at the id of the memo, which should
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
281 normally not be used unless someone tries to deepcopy
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
282 the memo itself...
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
283 """
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
284 try:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
285 memo[id(memo)].append(x)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
286 except KeyError:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
287 # aha, this is the first one :-)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
288 memo[id(memo)]=[x]
6116
07b7d4320b14 Make sure the objects returned by __getinitargs__() are kept alive (in
Guido van Rossum <guido@python.org>
parents: 5659
diff changeset
289
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
290 def _deepcopy_inst(x, memo):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
291 if hasattr(x, '__deepcopy__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
292 return x.__deepcopy__(memo)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
293 if hasattr(x, '__getinitargs__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
294 args = x.__getinitargs__()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
295 args = deepcopy(args, memo)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
296 y = apply(x.__class__, args)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
297 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
298 y = _EmptyClass()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
299 y.__class__ = x.__class__
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
300 memo[id(x)] = y
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
301 if hasattr(x, '__getstate__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
302 state = x.__getstate__()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
303 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
304 state = x.__dict__
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
305 state = deepcopy(state, memo)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
306 if hasattr(y, '__setstate__'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
307 y.__setstate__(state)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
308 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
309 y.__dict__.update(state)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
310 return y
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
311 d[types.InstanceType] = _deepcopy_inst
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
312
21587
097ae0adf47f Fix for SF bug ##497426: can't deepcopy recursive new objects
Guido van Rossum <guido@python.org>
parents: 20153
diff changeset
313 def _reconstruct(x, info, deep, memo=None):
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
314 if isinstance(info, str):
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
315 return x
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
316 assert isinstance(info, tuple)
21587
097ae0adf47f Fix for SF bug ##497426: can't deepcopy recursive new objects
Guido van Rossum <guido@python.org>
parents: 20153
diff changeset
317 if memo is None:
097ae0adf47f Fix for SF bug ##497426: can't deepcopy recursive new objects
Guido van Rossum <guido@python.org>
parents: 20153
diff changeset
318 memo = {}
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
319 n = len(info)
27727
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
320 assert n in (2, 3, 4, 5)
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
321 callable, args = info[:2]
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
322 if n > 2:
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
323 state = info[2]
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
324 else:
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
325 state = {}
27727
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
326 if n > 3:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
327 listiter = info[3]
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
328 else:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
329 listiter = None
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
330 if n > 4:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
331 dictiter = info[4]
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
332 else:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
333 dictiter = None
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
334 if deep:
21587
097ae0adf47f Fix for SF bug ##497426: can't deepcopy recursive new objects
Guido van Rossum <guido@python.org>
parents: 20153
diff changeset
335 args = deepcopy(args, memo)
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
336 y = callable(*args)
27727
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
337 if listiter is not None:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
338 for item in listiter:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
339 if deep:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
340 item = deepcopy(item, memo)
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
341 y.append(item)
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
342 if dictiter is not None:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
343 for key, value in dictiter:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
344 if deep:
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
345 key = deepcopy(key, memo)
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
346 value = deepcopy(value, memo)
d502187b2b06 Support __reduce__ returning a 4-tuple or 5-tuple.
Guido van Rossum <guido@python.org>
parents: 27262
diff changeset
347 y[key] = value
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
348 if state:
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
349 if deep:
21587
097ae0adf47f Fix for SF bug ##497426: can't deepcopy recursive new objects
Guido van Rossum <guido@python.org>
parents: 20153
diff changeset
350 state = deepcopy(state, memo)
23705
f85f4531c3c1 Fix from SF patch 565085: copy._reduction doesn't __setstate__.
Guido van Rossum <guido@python.org>
parents: 23634
diff changeset
351 if hasattr(y, '__setstate__'):
f85f4531c3c1 Fix from SF patch 565085: copy._reduction doesn't __setstate__.
Guido van Rossum <guido@python.org>
parents: 23634
diff changeset
352 y.__setstate__(state)
f85f4531c3c1 Fix from SF patch 565085: copy._reduction doesn't __setstate__.
Guido van Rossum <guido@python.org>
parents: 23634
diff changeset
353 else:
27733
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
354 if isinstance(state, tuple) and len(state) == 2:
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
355 state, slotstate = state
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
356 else:
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
357 slotstate = None
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
358 if state is not None:
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
359 y.__dict__.update(state)
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
360 if slotstate is not None:
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
361 for key, value in slotstate.iteritems():
e5e242cf46b1 Support all the new stuff supported by the new pickle code:
Guido van Rossum <guido@python.org>
parents: 27727
diff changeset
362 setattr(y, key, value)
20152
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
363 return y
72a5347d2f9a Changes to copy() and deepcopy() in copy.py to support __reduce__ as a
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
364
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
365 del d
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
366
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
367 del types
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
368
6771
33e2145250af Apply the same change to classes without an __getinitargs__() method
Guido van Rossum <guido@python.org>
parents: 6527
diff changeset
369 # Helper for instance creation without calling __init__
33e2145250af Apply the same change to classes without an __getinitargs__() method
Guido van Rossum <guido@python.org>
parents: 6527
diff changeset
370 class _EmptyClass:
33e2145250af Apply the same change to classes without an __getinitargs__() method
Guido van Rossum <guido@python.org>
parents: 6527
diff changeset
371 pass
33e2145250af Apply the same change to classes without an __getinitargs__() method
Guido van Rossum <guido@python.org>
parents: 6527
diff changeset
372
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
373 def _test():
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
374 l = [None, 1, 2L, 3.14, 'xyzzy', (1, 2L), [3.14, 'abc'],
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
375 {'abc': 'ABC'}, (), [], {}]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
376 l1 = copy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
377 print l1==l
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
378 l1 = map(copy, l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
379 print l1==l
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
380 l1 = deepcopy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
381 print l1==l
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
382 class C:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
383 def __init__(self, arg=None):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
384 self.a = 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
385 self.arg = arg
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
386 if __name__ == '__main__':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
387 import sys
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
388 file = sys.argv[0]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
389 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
390 file = __file__
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
391 self.fp = open(file)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
392 self.fp.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
393 def __getstate__(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
394 return {'a': self.a, 'arg': self.arg}
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
395 def __setstate__(self, state):
23634
dbee2f628a90 Replaced .keys() with dictionary iterators
Raymond Hettinger <python@rcn.com>
parents: 23620
diff changeset
396 for key, value in state.iteritems():
dbee2f628a90 Replaced .keys() with dictionary iterators
Raymond Hettinger <python@rcn.com>
parents: 23620
diff changeset
397 setattr(self, key, value)
27754
6b1789ac2f95 Add support for copy_reg.dispatch_table.
Guido van Rossum <guido@python.org>
parents: 27738
diff changeset
398 def __deepcopy__(self, memo=None):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
399 new = self.__class__(deepcopy(self.arg, memo))
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
400 new.a = self.a
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
401 return new
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
402 c = C('argument sketch')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
403 l.append(c)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
404 l2 = copy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
405 print l == l2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
406 print l
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
407 print l2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
408 l2 = deepcopy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
409 print l == l2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
410 print l
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
411 print l2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
412 l.append({l[1]: l, 'xyz': l[2]})
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
413 l3 = copy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
414 import repr
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
415 print map(repr.repr, l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
416 print map(repr.repr, l1)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
417 print map(repr.repr, l2)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
418 print map(repr.repr, l3)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
419 l3 = deepcopy(l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
420 import repr
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
421 print map(repr.repr, l)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
422 print map(repr.repr, l1)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
423 print map(repr.repr, l2)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
424 print map(repr.repr, l3)
2101
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
425
fdccc3222d0a shallow and deep copy operations
Guido van Rossum <guido@python.org>
parents:
diff changeset
426 if __name__ == '__main__':
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15437
diff changeset
427 _test()