diff options
author | Benjamin Peterson <benjamin@python.org> | 2008-05-12 21:42:13 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2008-05-12 21:42:13 (GMT) |
commit | 236819310db3fe6f2fb22d48b780fa6ec253b6c7 (patch) | |
tree | ce5ca9792381d9ced99e8e871324891ddbeb0e28 /Doc | |
parent | f9b54c24114b15ff920249244fe361aee276c248 (diff) | |
download | cpython-236819310db3fe6f2fb22d48b780fa6ec253b6c7.zip cpython-236819310db3fe6f2fb22d48b780fa6ec253b6c7.tar.gz cpython-236819310db3fe6f2fb22d48b780fa6ec253b6c7.tar.bz2 |
Add warnings to and deprecated all those Mac modules
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/aepack.rst | 6 | ||||
-rw-r--r-- | Doc/library/aetools.rst | 6 | ||||
-rw-r--r-- | Doc/library/aetypes.rst | 7 | ||||
-rw-r--r-- | Doc/library/autogil.rst | 5 | ||||
-rw-r--r-- | Doc/library/binhex.rst | 5 | ||||
-rw-r--r-- | Doc/library/carbon.rst | 31 | ||||
-rw-r--r-- | Doc/library/colorpicker.rst | 5 | ||||
-rw-r--r-- | Doc/library/easydialogs.rst | 6 | ||||
-rw-r--r-- | Doc/library/framework.rst | 5 | ||||
-rw-r--r-- | Doc/library/ic.rst | 6 | ||||
-rw-r--r-- | Doc/library/mac.rst | 4 | ||||
-rw-r--r-- | Doc/library/macos.rst | 5 | ||||
-rw-r--r-- | Doc/library/macostools.rst | 5 | ||||
-rw-r--r-- | Doc/library/plistlib.rst | 10 | ||||
-rw-r--r-- | Doc/library/undoc.rst | 25 |
15 files changed, 127 insertions, 4 deletions
diff --git a/Doc/library/aepack.rst b/Doc/library/aepack.rst index d8aef6b..798d603 100644 --- a/Doc/library/aepack.rst +++ b/Doc/library/aepack.rst @@ -5,6 +5,7 @@ .. module:: aepack :platform: Mac :synopsis: Conversion between Python variables and AppleEvent data containers. + :deprecated: .. sectionauthor:: Vincent Marchetti <vincem@en.com> .. moduleauthor:: Jack Jansen @@ -13,6 +14,11 @@ variables to AppleEvent descriptors and back (unpacking). Within Python the AppleEvent descriptor is handled by Python objects of built-in type :class:`AEDesc`, defined in module :mod:`Carbon.AE`. +.. warning:: + + This module is removed in 3.0. + + The :mod:`aepack` module defines the following functions: diff --git a/Doc/library/aetools.rst b/Doc/library/aetools.rst index da427eb..76b5e17 100644 --- a/Doc/library/aetools.rst +++ b/Doc/library/aetools.rst @@ -5,6 +5,7 @@ .. module:: aetools :platform: Mac :synopsis: Basic support for sending Apple Events + :deprecated: .. sectionauthor:: Jack Jansen <Jack.Jansen@cwi.nl> .. moduleauthor:: Jack Jansen @@ -21,6 +22,11 @@ The :mod:`aetools` module itself uses the AppleEvent support provided by the manager, see section :ref:`osx-gui-scripts` for details. This restriction may be lifted in future releases. +.. warning:: + + This module is removed in 3.0. + + The :mod:`aetools` module defines the following functions: diff --git a/Doc/library/aetypes.rst b/Doc/library/aetypes.rst index c8c5d80..997203e 100644 --- a/Doc/library/aetypes.rst +++ b/Doc/library/aetypes.rst @@ -5,6 +5,7 @@ .. module:: aetypes :platform: Mac :synopsis: Python representation of the Apple Event Object Model. + :deprecated: .. sectionauthor:: Vincent Marchetti <vincem@en.com> .. moduleauthor:: Jack Jansen @@ -30,6 +31,12 @@ application for which you have not generated the stub package this module also contains object specifiers for a number of common OSA classes such as ``Document``, ``Window``, ``Character``, etc. +.. warning:: + + This module is removed in 3.0. + + + The :mod:`AEObjects` module defines the following classes to represent Apple Event descriptor data: diff --git a/Doc/library/autogil.rst b/Doc/library/autogil.rst index 7625be6..ca26226 100644 --- a/Doc/library/autogil.rst +++ b/Doc/library/autogil.rst @@ -5,6 +5,7 @@ .. module:: autoGIL :platform: Mac :synopsis: Global Interpreter Lock handling in event loops. + :deprecated: .. moduleauthor:: Just van Rossum <just@letterror.com> @@ -12,6 +13,10 @@ The :mod:`autoGIL` module provides a function :func:`installAutoGIL` that automatically locks and unlocks Python's :term:`Global Interpreter Lock` when running an event loop. +.. warning:: + + This module is removed in 3.0. + .. exception:: AutoGILError diff --git a/Doc/library/binhex.rst b/Doc/library/binhex.rst index 3b0485c..0049c70 100644 --- a/Doc/library/binhex.rst +++ b/Doc/library/binhex.rst @@ -11,6 +11,11 @@ representation of Macintosh files in ASCII. On the Macintosh, both forks of a file and the finder information are encoded (or decoded), on other platforms only the data fork is handled. +.. warning:: + + In 3.0, special Macintosh support is removed. + + The :mod:`binhex` module defines the following functions: diff --git a/Doc/library/carbon.rst b/Doc/library/carbon.rst index 886fa82..94e0c9a 100644 --- a/Doc/library/carbon.rst +++ b/Doc/library/carbon.rst @@ -22,8 +22,9 @@ framework and Qt is in the QuickTime framework. The normal use pattern is :: from Carbon import AE -**Warning!** These modules are not yet documented. If you wish to contribute -documentation of any of these modules, please get in touch with docs@python.org. +.. warning:: + + The Carbon modules are removed in 3.0. :mod:`Carbon.AE` --- Apple Events @@ -32,6 +33,7 @@ documentation of any of these modules, please get in touch with docs@python.org. .. module:: Carbon.AE :platform: Mac :synopsis: Interface to the Apple Events toolbox. + :deprecated: @@ -41,6 +43,7 @@ documentation of any of these modules, please get in touch with docs@python.org. .. module:: Carbon.AH :platform: Mac :synopsis: Interface to the Apple Help manager. + :deprecated: @@ -50,6 +53,7 @@ documentation of any of these modules, please get in touch with docs@python.org. .. module:: Carbon.App :platform: Mac :synopsis: Interface to the Appearance Manager. + :deprecated: @@ -59,6 +63,7 @@ documentation of any of these modules, please get in touch with docs@python.org. .. module:: Carbon.CF :platform: Mac :synopsis: Interface to the Core Foundation. + :deprecated: The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and @@ -71,6 +76,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.CG :platform: Mac :synopsis: Interface to Core Graphics. + :deprecated: @@ -80,6 +86,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.CarbonEvt :platform: Mac :synopsis: Interface to the Carbon Event Manager. + :deprecated: @@ -89,6 +96,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Cm :platform: Mac :synopsis: Interface to the Component Manager. + :deprecated: @@ -98,6 +106,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Ctl :platform: Mac :synopsis: Interface to the Control Manager. + :deprecated: @@ -107,6 +116,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Dlg :platform: Mac :synopsis: Interface to the Dialog Manager. + :deprecated: @@ -116,6 +126,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Evt :platform: Mac :synopsis: Interface to the classic Event Manager. + :deprecated: @@ -125,6 +136,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Fm :platform: Mac :synopsis: Interface to the Font Manager. + :deprecated: @@ -134,6 +146,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Folder :platform: Mac :synopsis: Interface to the Folder Manager. + :deprecated: @@ -143,6 +156,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Help :platform: Mac :synopsis: Interface to the Carbon Help Manager. + :deprecated: @@ -152,6 +166,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.List :platform: Mac :synopsis: Interface to the List Manager. + :deprecated: @@ -161,6 +176,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Menu :platform: Mac :synopsis: Interface to the Menu Manager. + :deprecated: @@ -170,6 +186,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Mlte :platform: Mac :synopsis: Interface to the MultiLingual Text Editor. + :deprecated: @@ -179,6 +196,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Qd :platform: Mac :synopsis: Interface to the QuickDraw toolbox. + :deprecated: @@ -188,6 +206,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Qdoffs :platform: Mac :synopsis: Interface to the QuickDraw Offscreen APIs. + :deprecated: @@ -197,6 +216,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Qt :platform: Mac :synopsis: Interface to the QuickTime toolbox. + :deprecated: @@ -206,6 +226,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and .. module:: Carbon.Res :platform: Mac :synopsis: Interface to the Resource Manager and Handles. + :deprecated: @@ -216,6 +237,7 @@ The ``CFBase``, ``CFArray``, ``CFData``, ``CFDictionary``, ``CFString`` and :platform: Mac :synopsis: The Scrap Manager provides basic services for implementing cut & paste and clipboard operations. + :deprecated: This module is only fully available on MacOS9 and earlier under classic PPC @@ -266,6 +288,7 @@ Manager. It contains the following functions: .. module:: Carbon.Snd :platform: Mac :synopsis: Interface to the Sound Manager. + :deprecated: @@ -275,6 +298,7 @@ Manager. It contains the following functions: .. module:: Carbon.TE :platform: Mac :synopsis: Interface to TextEdit. + :deprecated: @@ -284,5 +308,4 @@ Manager. It contains the following functions: .. module:: Carbon.Win :platform: Mac :synopsis: Interface to the Window Manager. - - + :deprecated: diff --git a/Doc/library/colorpicker.rst b/Doc/library/colorpicker.rst index 4244104..e0771ac 100644 --- a/Doc/library/colorpicker.rst +++ b/Doc/library/colorpicker.rst @@ -5,6 +5,7 @@ .. module:: ColorPicker :platform: Mac :synopsis: Interface to the standard color selection dialog. + :deprecated: .. moduleauthor:: Just van Rossum <just@letterror.com> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> @@ -12,6 +13,10 @@ The :mod:`ColorPicker` module provides access to the standard color picker dialog. +.. warning:: + + This module is removed in 3.0. + .. function:: GetColor(prompt, rgb) diff --git a/Doc/library/easydialogs.rst b/Doc/library/easydialogs.rst index 50b312f..dbda57f 100644 --- a/Doc/library/easydialogs.rst +++ b/Doc/library/easydialogs.rst @@ -5,6 +5,7 @@ .. module:: EasyDialogs :platform: Mac :synopsis: Basic Macintosh dialogs. + :deprecated: The :mod:`EasyDialogs` module contains some simple dialogs for the Macintosh. @@ -13,6 +14,11 @@ override the :const:`DLOG` resource used for the dialog, provided that the dialog items correspond (both type and item number) to those in the default :const:`DLOG` resource. See source code for details. +.. warning:: + + This module is removed in 3.0. + + The :mod:`EasyDialogs` module defines the following functions: diff --git a/Doc/library/framework.rst b/Doc/library/framework.rst index c665fb7..71a07c1 100644 --- a/Doc/library/framework.rst +++ b/Doc/library/framework.rst @@ -5,6 +5,7 @@ .. module:: FrameWork :platform: Mac :synopsis: Interactive application framework. + :deprecated: The :mod:`FrameWork` module contains classes that together provide a framework @@ -15,6 +16,10 @@ often be done on various different levels, i.e. to handle clicks in a single dialog window in a non-standard way it is not necessary to override the complete event handling. +.. warning:: + + This module is removed in 3.0. + Work on the :mod:`FrameWork` has pretty much stopped, now that :mod:`PyObjC` is available for full Cocoa access from Python, and the documentation describes only the most important functionality, and not in the most logical manner at diff --git a/Doc/library/ic.rst b/Doc/library/ic.rst index d5e03bd..88d4eee 100644 --- a/Doc/library/ic.rst +++ b/Doc/library/ic.rst @@ -5,11 +5,17 @@ .. module:: ic :platform: Mac :synopsis: Access to the Mac OS X Internet Config. + :deprecated: This module provides access to various internet-related preferences set through :program:`System Preferences` or the :program:`Finder`. +.. warning:: + + This module is removed in 3.0. + + .. index:: module: icglue There is a low-level companion module :mod:`icglue` which provides the basic diff --git a/Doc/library/mac.rst b/Doc/library/mac.rst index 791eb81..6d81d74 100644 --- a/Doc/library/mac.rst +++ b/Doc/library/mac.rst @@ -10,6 +10,10 @@ See the chapters :ref:`mac-scripting` and :ref:`undoc-mac-modules` for more modules, and the HOWTO :ref:`using-on-mac` for a general introduction to Mac-specific Python programming. +.. warning:: + + These modules are deprecated and are removed in 3.0 + .. toctree:: diff --git a/Doc/library/macos.rst b/Doc/library/macos.rst index 543f868..832dacb 100644 --- a/Doc/library/macos.rst +++ b/Doc/library/macos.rst @@ -5,12 +5,17 @@ .. module:: MacOS :platform: Mac :synopsis: Access to Mac OS-specific interpreter features. + :deprecated: This module provides access to MacOS specific functionality in the Python interpreter, such as how the interpreter eventloop functions and the like. Use with care. +.. warning:: + + This module is removed in 3.0. + Note the capitalization of the module name; this is a historical artifact. diff --git a/Doc/library/macostools.rst b/Doc/library/macostools.rst index 275100e..eae867d 100644 --- a/Doc/library/macostools.rst +++ b/Doc/library/macostools.rst @@ -5,6 +5,7 @@ .. module:: macostools :platform: Mac :synopsis: Convenience routines for file manipulation. + :deprecated: This module contains some convenience routines for file-manipulation on the @@ -12,6 +13,10 @@ Macintosh. All file parameters can be specified as pathnames, :class:`FSRef` or :class:`FSSpec` objects. This module expects a filesystem which supports forked files, so it should not be used on UFS partitions. +.. warning:: + + This module is removed in 3.0. + The :mod:`macostools` module defines the following functions: diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 508f8e8..b987a5f 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -75,12 +75,22 @@ This module defines the following functions: Read a plist from the resource with type *restype* from the resource fork of *path*. Availability: MacOS X. + .. warning:: + + In 3.0, this function is removed. + + .. function:: writePlistToResource(rootObject, path[, restype='plst'[, resid=0]]) Write *rootObject* as a resource with type *restype* to the resource fork of *path*. Availability: MacOS X. + .. warning:: + + In 3.0, this function is removed. + + The following class is available: diff --git a/Doc/library/undoc.rst b/Doc/library/undoc.rst index 9875a07..a1b4b25 100644 --- a/Doc/library/undoc.rst +++ b/Doc/library/undoc.rst @@ -80,7 +80,9 @@ Undocumented Mac OS modules .. module:: applesingle :platform: Mac :synopsis: Rudimentary decoder for AppleSingle format files. + :deprecated: +.. deprecated:: 2.6 :mod:`buildtools` --- Helper module for BuildApplet and Friends @@ -89,6 +91,7 @@ Undocumented Mac OS modules .. module:: buildtools :platform: Mac :synopsis: Helper module for BuildApplet, BuildApplication and macfreeze. + :deprecated: .. deprecated:: 2.4 @@ -99,6 +102,7 @@ Undocumented Mac OS modules .. module:: cfmfile :platform: Mac :synopsis: Code Fragment Resource module. + :deprecated: :mod:`cfmfile` is a module that understands Code Fragments and the accompanying @@ -113,11 +117,14 @@ BuildApplication to combine all plugin modules to a single executable. .. module:: icopen :platform: Mac :synopsis: Internet Config replacement for open(). + :deprecated: Importing :mod:`icopen` will replace the builtin :meth:`open` with a version that uses Internet Config to set file type and creator for new files. +.. deprecated:: 2.6 + :mod:`macerrors` --- Mac OS Errors ---------------------------------- @@ -125,10 +132,13 @@ that uses Internet Config to set file type and creator for new files. .. module:: macerrors :platform: Mac :synopsis: Constant definitions for many Mac OS error codes. + :deprecated: :mod:`macerrors` contains constant definitions for many Mac OS error codes. +.. deprecated:: 2.6 + :mod:`macresource` --- Locate script resources ---------------------------------------------- @@ -136,12 +146,15 @@ that uses Internet Config to set file type and creator for new files. .. module:: macresource :platform: Mac :synopsis: Locate script resources. + :deprecated: :mod:`macresource` helps scripts finding their resources, such as dialogs and menus, without requiring special case code for when the script is run under MacPython, as a MacPython applet or under OSX Python. +.. deprecated:: 2.6 + :mod:`Nav` --- NavServices calls -------------------------------- @@ -149,10 +162,13 @@ MacPython, as a MacPython applet or under OSX Python. .. module:: Nav :platform: Mac :synopsis: Interface to Navigation Services. + :deprecated: A low-level interface to Navigation Services. +.. deprecated:: 2.6 + :mod:`PixMapWrapper` --- Wrapper for PixMap objects --------------------------------------------------- @@ -160,12 +176,15 @@ A low-level interface to Navigation Services. .. module:: PixMapWrapper :platform: Mac :synopsis: Wrapper for PixMap objects. + :deprecated: :mod:`PixMapWrapper` wraps a PixMap object with a Python object that allows access to the fields by name. It also has methods to convert to and from :mod:`PIL` images. +.. deprecated:: 2.6 + :mod:`videoreader` --- Read QuickTime movies -------------------------------------------- @@ -173,11 +192,14 @@ access to the fields by name. It also has methods to convert to and from .. module:: videoreader :platform: Mac :synopsis: Read QuickTime movies frame by frame for further processing. + :deprecated: :mod:`videoreader` reads and decodes QuickTime movies and passes a stream of images to your program. It also provides some support for audio tracks. +.. deprecated:: 2.6 + :mod:`W` --- Widgets built on :mod:`FrameWork` ---------------------------------------------- @@ -185,10 +207,13 @@ images to your program. It also provides some support for audio tracks. .. module:: W :platform: Mac :synopsis: Widgets for the Mac, built on top of FrameWork. + :deprecated: The :mod:`W` widgets are used extensively in the :program:`IDE`. +.. deprecated:: 2.6 + .. _obsolete-modules: |