traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Properly document copy and deepcopy as functions.

This commit is contained in:
Georg Brandl 2009-09-09 16:49:13 +00:00
parent 93ed82048f
commit ffdde9e959
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/library/copy.rst
View File

@ -1,25 +1,28 @@
:mod:`copy` --- Shallow and deep copy operations :mod:`copy` --- Shallow and deep copy operations
================================================ ================================================
.. module:: copy .. module:: copy
:synopsis: Shallow and deep copy operations. :synopsis: Shallow and deep copy operations.
.. index::
single: copy() (in copy)
single: deepcopy() (in copy)
This module provides generic (shallow and deep) copying operations. This module provides generic (shallow and deep) copying operations.
Interface summary::
import copy Interface summary:
x = copy.copy(y) # make a shallow copy of y .. function:: copy(x)
x = copy.deepcopy(y) # make a deep copy of y
Return a shallow copy of *x*.
.. function:: deepcopy(x)
Return a deep copy of *x*.
.. exception:: error
Raised for module specific errors.
For module specific errors, :exc:`copy.error` is raised.
The difference between shallow and deep copying is only relevant for compound The difference between shallow and deep copying is only relevant for compound
objects (objects that contain other objects, like lists or class instances): objects (objects that contain other objects, like lists or class instances):