Text of docs.python.org › pa › 3 › library › copyreg.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

copyreg --- Register pickle support functions — Python 3.15.2 documentation

Navigation index modules | next | previous | Python » 3.15.2 documentation » The Python standard library » Data Persistence » copyreg --- Register pickle support functions | Theme | copyreg --- Register pickle support functions ¶ Source code: Lib/copyreg.py The copyreg module offers a way to define functions used while pickling specific objects. The pickle and copy modules use those functions when pickling/copying those objects.

The module provides configuration information about object constructors which are not classes. Such constructors may be factory functions or class instances. copyreg. constructor ( object ) ¶ Declares object to be a valid constructor. If object is not callable (and hence not valid as a constructor), raises TypeError . copyreg. pickle ( type , function , constructor_ob = None ) ¶ Declares that function should be used as a "reduction" function for objects of type type . function must return either a string or a tuple containing between two and six elements.

See the dispatch_table for more details on the interface of function . The constructor_ob parameter is a legacy feature and is now ignored, but if passed it must be a callable. Note that the dispatch_table attribute of a pickler object or subclass of pickle.Pickler can also be used for declaring reduction functions. Example ¶ The example below would like to show how to register a pickle function and how it will be used: >>> import copyreg , copy , pickle >>> class C : ... def __init__ ( self , a ): ... self . a = a ... >>> def pickle_c ( c ): ... print ( "pickling a C instance..." ) ... return C , ( c . a ,) ... >>> copyreg . pickle ( C , pickle_c ) >>> c = C ( 1 ) >>> d = copy . copy ( c ) pickling a C instance... >>> p = pickle . dumps ( c ) pickling a C instance...

Table of Contents copyreg --- Register pickle support functions Example Previous topic pickle --- Python object serialization Next topic shelve --- Python object persistence This page Report a bug Improve this page Show source Show translation source « Navigation index modules | next | previous | Python » 3.15.2 documentation » The Python standard library » Data Persistence » copyreg --- Register pickle support functions | Theme | © Copyright 2001 Python Software Foundation.

This page is licensed under the Python Software Foundation License Version 2. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. See History and License for more information. The Python Software Foundation is a non-profit corporation. Please donate. Last updated on ਨਵੰ 19, 2026 (09:42 UTC). Found a bug ? Created using Sphinx 9.1.1.