Commit Graph

57 Commits

Author SHA1 Message Date
CAM Gerlach 31fa41ed68
gh-92611: Clarify planned removal version in PEP 594-deprecated modules (GH-92793)
As discussed in #92611 and #92564 and as a followup to PR #92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts.

Related to #92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one.
2022-05-20 14:47:51 -07:00
Zackery Spytz dea3223740
bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) 2020-06-13 10:35:08 -07:00
Windson yang 967b84c913 bpo-35325: Doc: imp.find_module() return value documentation discrepancy (GH-11040) 2019-09-12 14:10:50 +02:00
Serhiy Storchaka 2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00
Stéphane Wirtel e483f02423 bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037) 2018-10-26 12:52:11 +02:00
Terry Jan Reedy 4da945f361 Merge Issue #22558. 2016-06-11 15:06:08 -04:00
Terry Jan Reedy fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Brett Cannon a85e927e39 Issue #25802: Add an examples section to importlib.
Thanks to Berker Peksag for the patch review.
2016-01-08 14:33:09 -08:00
R David Murray deed215313 Merge: #24081: Remove obsolete caveat from import docs. 2015-05-02 14:58:32 -04:00
R David Murray 6d877ef026 #24081: Remove obsolete caveat from import docs.
Per Eric Snow's research, this changed in Python 2.4 in changeset 331e60d8ce,
but these docs were not updated.

Patch by Peter Viktorin.
2015-05-02 14:57:54 -04:00
Brett Cannon f299abdafa Issue #23731: Implement PEP 488.
The concept of .pyo files no longer exists. Now .pyc files have an
optional `opt-` tag which specifies if any extra optimizations beyond
the peepholer were applied.
2015-04-13 14:21:02 -04:00
Brett Cannon f26702b86e Issue #21157: Touch up imp docs to be more explicit about importlib
alternatives.
2014-05-09 10:37:31 -04:00
Georg Brandl df48b97855 Fix a few scoping issues with versionadded/versionchanged directives. 2014-03-24 09:06:18 +01:00
Brett Cannon 24f60b4616 Issues #20194,20195: Add missing :deprecated: markers to some module
docs.
2014-01-17 12:06:28 -05:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Brett Cannon 6fd25c39c4 Issue #19392: Document that imp.reload() now relies on __loader__
being defined on top of __name__.
2013-10-25 13:46:15 -04:00
Brett Cannon 50aa32409b merge from 3.3 2013-10-25 13:49:20 -04:00
Andrew Kuchling f862dc53e8 Merge from 3.3 2013-06-20 21:20:20 -04:00
Andrew Kuchling 1d7d580d0e Closes #18272: use 'builtins' for 3.3 instead of __builtin__ 2013-06-20 21:17:41 -04:00
Brett Cannon 89df7b4e64 Issue #17177: Clarify some deprecations 2013-06-18 20:49:55 -04:00
Brett Cannon e4f41deccf Issue #17177: The imp module is pending deprecation.
To make sure there is no issue with code that is both Python 2 and 3
compatible, there are no plans to remove the module any sooner than
Python 4 (unless the community moves to Python 3 solidly before then).
2013-06-16 13:13:40 -04:00
Brett Cannon a3c96154d2 Issue #17907: touch up the code for imp.new_module(). 2013-06-14 22:26:30 -04:00
Brett Cannon 2d77204180 Issue #17907: Document types.ModuleType's constructor and attributes,
allowing for documenting imp.new_module() as deprecated.
2013-06-14 19:19:57 -04:00
Brett Cannon 05a647deed Issue #18192: Introduce importlib.util.MAGIC_NUMBER and document the
deprecation of imp.get_magic().
2013-06-14 19:02:34 -04:00
Brett Cannon 3fe35e6503 Issue #18193: Add importlib.reload(), documenting (but not
implementing in code) the deprecation of imp.reload().

Thanks to Berker Peksag for the patch.
2013-06-14 15:04:26 -04:00
R David Murray bca1a2629a #17135: Add note in imp to use importlib for new programs. 2013-04-18 09:51:17 -04:00
R David Murray 33a3c50db5 #17135: mark imp as deprecated as of 3.4. 2013-04-17 18:50:12 -04:00
Brett Cannon 115309acec Issue #17176: Document that imp.NullImporter is no longer
automatically used by import.
2013-03-13 10:58:50 -07:00
Brett Cannon 2514b4871f Issue #17176: Document that imp.NullImporter is no longer inserted
into sys.path_importer_cache.
2013-03-13 10:46:22 -07:00
Brett Cannon d104eef118 Issue #15053: Make sure all functions related to the import lock have
the Python 3.3 change notice on them in case someone directly links to
the function(s).
2012-07-13 11:26:19 -04:00
Brett Cannon 19a2f5961c Issue #15056: imp.cache_from_source() and source_from_cache() raise
NotimplementedError when sys.implementation.cache_tag is None.

Thanks to Pranav Ravichandran for taking an initial stab at the patch.
2012-07-09 13:58:07 -04:00
Antoine Pitrou 6c6d3a2f9f Move import lock-related functions to a separate doc section. 2012-05-17 19:00:35 +02:00
Antoine Pitrou ea3eb88bca Issue #9260: A finer-grained import lock.
Most of the import sequence now uses per-module locks rather than the
global import lock, eliminating well-known issues with threads and imports.
2012-05-17 18:55:59 +02:00
Brett Cannon 62961dde31 Issue #13959: Document imp.find_module/load_module as deprecated.
The code itself does not raise a DeprecationWarning as the functions
are technically fine, it's just a bad API. Unfortunately experience
has shown that the terrible API has been exposed in various places,
necessitating that it stick around probably until py4k comes around
since it is such a shift to move over to importlib.find_loader().
2012-05-13 13:04:21 -04:00
Brett Cannon 0c59b039b8 Deprecate the imp constants related to imp.get_suffixes(). 2012-05-11 14:27:29 -04:00
Brett Cannon cb66eb0dec Issue #13959: Deprecate imp.get_suffixes() for new attributes on
importlib.machinery that provide the suffix details for import.
The attributes were not put on imp so as to compartmentalize
everything importlib needs for setting up imports in
importlib.machinery.

This also led to an indirect deprecation of inspect.getmoduleinfo() as
it directly returned imp.get_suffix's returned tuple which no longer
makes sense.
2012-05-11 12:58:42 -04:00
Senthil Kumaran cc4979092f minor .rst fix 2012-04-10 19:51:00 +08:00
R David Murray 1623afff67 #14355: remove obsolete doc reference to previously removed init_frozen.
Patch by Eric Snow.
2012-03-18 20:50:03 -04:00
Georg Brandl 59b44721e3 Remove mentions of the Demo directory. 2010-12-30 22:12:40 +00:00
Éric Araujo 930df31987 Add missing docs and directives related to PEP 3147 and byte-compilation 2010-12-16 06:28:48 +00:00
Antoine Pitrou b387ad6eec Remove reference to stuff which is already obsolete in 2.x. 2010-12-12 18:12:40 +00:00
Antoine Pitrou 11cb961b38 Add cross-references to the glossary entry for file objects. 2010-09-15 11:11:28 +00:00
Benjamin Peterson 0f4dd9a8e5 add spaces 2010-09-13 01:31:57 +00:00
Benjamin Peterson c7b1cfa463 remove less complete of duplicate docs 2010-09-13 01:30:04 +00:00
Benjamin Peterson c985f1f013 remove duplicate statement 2010-09-13 01:25:38 +00:00
Victor Stinner 766ad36de5 Merged revisions 81163 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81163 | victor.stinner | 2010-05-14 16:20:07 +0200 (ven., 14 mai 2010) | 2 lines

  Doc: replace PEP xxx by :pep:`xxx` to create a link on the PEP
........
2010-05-14 14:36:18 +00:00
Barry Warsaw 28a691b7fd PEP 3147 2010-04-17 00:19:56 +00:00
Alexandre Vassalotti 711ed4aedf Merged revisions 73930-73932,73937-73939,73945,73951,73954,73962-73963,73970 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r73930 | amaury.forgeotdarc | 2009-07-10 12:47:42 -0400 (Fri, 10 Jul 2009) | 2 lines

  #6447: typo in subprocess docstring
........
  r73931 | ezio.melotti | 2009-07-10 16:25:56 -0400 (Fri, 10 Jul 2009) | 1 line

  more cleanups and if zlib -> skipUnless(zlib)
........
  r73932 | kristjan.jonsson | 2009-07-11 04:44:43 -0400 (Sat, 11 Jul 2009) | 3 lines

  http://bugs.python.org/issue6460
  Need to be careful with thread switching when testing the xmlrpc server.  The server thread may not have updated stats when the client thread tests them.
........
  r73937 | georg.brandl | 2009-07-11 06:12:36 -0400 (Sat, 11 Jul 2009) | 1 line

  Fix style.
........
  r73938 | georg.brandl | 2009-07-11 06:14:54 -0400 (Sat, 11 Jul 2009) | 1 line

  #6446: fix import_spam() function to use correct error and reference handling.
........
  r73939 | georg.brandl | 2009-07-11 06:18:10 -0400 (Sat, 11 Jul 2009) | 1 line

  #6448: clarify docs for find_module().
........
  r73945 | georg.brandl | 2009-07-11 06:51:31 -0400 (Sat, 11 Jul 2009) | 1 line

  #6456: clarify the meaning of constants used as arguments to nl_langinfo().
........
  r73951 | georg.brandl | 2009-07-11 10:23:38 -0400 (Sat, 11 Jul 2009) | 2 lines

  array.array is actually a class.
........
  r73954 | tarek.ziade | 2009-07-11 13:21:00 -0400 (Sat, 11 Jul 2009) | 1 line

  reverted changes for #6459 (doesn't apply on 2.x)
........
  r73962 | benjamin.peterson | 2009-07-11 18:15:13 -0400 (Sat, 11 Jul 2009) | 1 line

  put downloaded test support files in Lib/test/data instead of the cwd
........
  r73963 | benjamin.peterson | 2009-07-11 18:25:24 -0400 (Sat, 11 Jul 2009) | 1 line

  ignore things in Lib/test/data/
........
  r73970 | hirokazu.yamamoto | 2009-07-11 22:04:47 -0400 (Sat, 11 Jul 2009) | 1 line

  Fixed distutils test.
........
2009-07-17 10:42:05 +00:00
Georg Brandl 3dd3388229 Convert all "i" docs to new style optional args. 2009-06-01 17:35:27 +00:00