Commit Graph

167 Commits

Author SHA1 Message Date
Feanil Patel 6a396c9807 bpo-31128: Allow pydoc to bind to arbitrary hostnames (#3011)
New -n flag allow overriding localhost with custom value,
for example to run from containers.
2017-09-14 17:54:09 -04:00
Antoine Pitrou a6a4dc816d bpo-31370: Remove support for threads-less builds (#3385)
* Remove Setup.config
* Always define WITH_THREAD for compatibility.
2017-09-07 18:56:24 +02:00
Victor Stinner fd46561167 bpo-31028: Fix test_pydoc when run directly (#2864)
* bpo-31028: Fix test_pydoc when run directly

Fix get_pydoc_link() of test_pydoc to fix "./python
Lib/test/test_pydoc.py": get the absolute path to __file__ to prevent
relative directories.

* Use realpath() instead of abspath()
2017-07-27 11:21:26 +02:00
Victor Stinner d6debb24e0 bpo-29919: Remove unused imports found by pyflakes (#137)
Make also minor PEP8 coding style fixes on modified imports.
2017-03-27 16:05:26 +02:00
Guido van Rossum 265dce6cbb Issue #27989: Tweak inspect.formatannotation() to improve pydoc rendering of function annotations. Ivan L. (3.5->3.6) 2016-10-22 07:56:58 -07:00
Guido van Rossum 52e5004b59 Issue #27989: Tweak inspect.formatannotation() to improve pydoc rendering of function annotations. Ivan L. 2016-10-22 07:55:18 -07:00
Yury Selivanov f8cb8a16a3 Issue #27985: Implement PEP 526 -- Syntax for Variable Annotations.
Patch by Ivan Levkivskyi.
2016-09-08 20:50:03 -07:00
Eric Snow 4f29e75289 Issue #24254: Drop cls.__definition_order__. 2016-09-08 15:11:11 -07:00
Eric Snow 46f97b85a8 Issue #15767: Use ModuleNotFoundError. 2016-09-07 16:56:15 -07:00
Eric Snow 92a6c170e6 Issue #24254: Preserve class attribute definition order. 2016-09-05 14:50:11 -07:00
Nick Coghlan d78448e912 Issue #27366: Implement PEP 487
- __init_subclass__ called when new subclasses defined
- __set_name__ called when descriptors are part of a
  class definition
2016-07-30 16:26:03 +10:00
Martin Panter 5285545271 Issue #16484: Merge pydoc Windows fixes from 3.5 2016-06-12 04:31:25 +00:00
Martin Panter 4f8aaf6440 Issue #16484: Fix pydoc link and test on Windows, by Kaushik Nadikuditi 2016-06-12 04:24:06 +00:00
R David Murray 13ee7d15e3 Merge: #16484: Fix pydoc doc links to modules whose names are mixed case. 2016-06-03 19:29:18 -04:00
R David Murray ead9bfc5c3 #16484: Fix pydoc doc links to modules whose names are mixed case.
Patch by Sean Rodman, test by Kaushik N.
2016-06-03 19:28:35 -04:00
Martin Panter 3e04d5b306 Issue #27076: Merge spelling from 3.5 2016-05-26 06:03:19 +00:00
Martin Panter 46f50726a0 Issue #27076: Doc, comment and tests spelling fixes
Most fixes to Doc/ and Lib/ directories by Ville Skyttä.
2016-05-26 05:35:26 +00:00
Martin Panter e2e0deec45 Issue #18010: Merge pydoc web search fix from 3.5 2015-11-06 01:08:34 +00:00
Martin Panter 98da9d0e0d Issue #18010: Merge pydoc web search fix from 3.4 into 3.5 2015-11-06 00:51:38 +00:00
Martin Panter 9ad0aae656 Issue #18010: Fix pydoc web server search to handle package exceptions
Implementation by Antoine Pitrou.
2015-11-06 00:27:14 +00:00
Raymond Hettinger 95801bbe4e Issue #24879: Teach pydoc to display named tuple fields in the order they were defined. 2015-08-18 22:25:16 -07:00
Berker Peksag ce643913a9 Issue #9517: Move script_helper to the support package.
Patch by Christie Wilson.
2015-05-06 06:33:17 +03:00
Serhiy Storchaka f5e8540e1b Issue #23008: Fixed resolving attributes with boolean value is False in pydoc. 2015-04-21 21:11:13 +03:00
Serhiy Storchaka b6076fb13c Issue #23008: Fixed resolving attributes with boolean value is False in pydoc. 2015-04-21 21:09:48 +03:00
Serhiy Storchaka 3de4aae1d0 Fixed pydoc tests when run with -OO. 2015-03-01 15:32:17 +02:00
Serhiy Storchaka 4c094e5fd5 Fixed pydoc tests when run with -OO. 2015-03-01 15:31:36 +02:00
Serhiy Storchaka 1c205518a3 Issue #19980: Improved help() for non-recognized strings. help('') now
shows the help on str.  help('help') now shows the help on help().
Original patch by Mark Lawrence.
2015-03-01 00:42:54 +02:00
Serhiy Storchaka 7065f376e0 Issue #23374: Fixed pydoc failure with non-ASCII files when stdout encoding
differs from file system encoding (e.g. on Mac OS).
2015-02-20 23:47:09 +02:00
Serhiy Storchaka 5e3d7a401d Issue #23374: Fixed pydoc failure with non-ASCII files when stdout encoding
differs from file system encoding (e.g. on Mac OS).
2015-02-20 23:46:06 +02:00
Benjamin Peterson 77c041ba64 merge 3.4 (#21548) 2015-02-16 19:45:42 -05:00
Benjamin Peterson 54237f9fea fix pydoc.apropos and pydoc.synopsis on modules with empty docstrings (#21548)
Patch by Yuyang Guo and Berker Peksag.
2015-02-16 19:45:01 -05:00
Senthil Kumaran 810dc9bc81 Merge from 3.4
Issue #22421 - Secure pydoc server run. Bind it to localhost instead of all interfaces.
2014-09-17 13:19:34 +08:00
Senthil Kumaran aa72b1b448 Merge from 3.3
Issue #22421 - Secure pydoc server run. Bind it to localhost instead of all interfaces.
2014-09-17 13:19:01 +08:00
Senthil Kumaran 2a42a0bff3 Issue #22421 - Secure pydoc server run. Bind it to localhost instead of all interfaces. 2014-09-17 13:17:58 +08:00
Zachary Ware fff80d984c Issue #21942: Fixed source file viewing in pydoc's server mode on Windows. 2014-07-10 11:21:01 -05:00
Zachary Ware eb43214427 Issue #21942: Fixed source file viewing in pydoc's server mode on Windows. 2014-07-10 11:18:00 -05:00
Raymond Hettinger bb91c1d019 Issue 21786: Clean-up test_pydoc taking taking advantage of diffing in unittest. 2014-06-21 12:08:22 -07:00
Charles-François Natali 57398c31c4 Fix test_pydoc failure introduced by 7aa72075d440. Patch by Berker Peksag. 2014-06-20 22:59:12 +01:00
Terry Jan Reedy fe928de955 Issue #21768: fix type in test_pydoc, patch by Claudiu Popa. 2014-06-20 14:59:11 -04:00
Benjamin Peterson 159824ea2a make sure the builtin help function doesn't fail when sys.stdin is not a valid file (closes #11709)
Original patch by Amaury Forgeot d'Arc with a test by bdettmer.
2014-06-07 20:14:26 -07:00
Benjamin Peterson ed1160b39c don't remove self from example code in the HTML output (closes #13223)
Patch by Víctor Terrón.
2014-06-07 16:44:00 -07:00
Eric Snow a46ef70bdf Issue #20484: Disable the 2 remaining "modules" tests in test_pydoc.
I'll look into re-enabling them in issue #20128.
2014-02-22 13:57:08 -07:00
Larry Hastings 24a882bb7b Issue #20710: The pydoc summary line no longer displays the "self" parameter
for bound methods.  Previous to this change, it displayed "self" for methods
implemented in Python but not methods implemented in C; it is now both
internally consistent and consistent with inspect.Signature.
2014-02-20 23:34:46 -08:00
Serhiy Storchaka 056eb02719 Issue #20654: Fixed pydoc for enums with zero value. Patch by Vajrasky Kok. 2014-02-19 23:05:12 +02:00
Stefan Krah 5de3278b23 Fix test failures (--without-doc-strings). 2014-01-18 23:18:39 +01:00
Larry Hastings 1abd708681 Issue #20226: Added tests for new features and regressions. 2014-01-16 14:15:03 -08:00
Eric Snow 3a62d14b24 Issue #19703: Update pydoc to use the new importer APIs. 2014-01-06 20:42:59 -07:00
Eric Snow 5ea97506a2 Issue 20123: Disable a problematic test. 2014-01-04 23:04:27 -07:00
Eric Snow 0dddf4258a Issue 20123: try using a different builtin module in a pydoc test.
The test is failing on one of the stable FreeBSD buildbots.  It seems
unlikely that the gc module would not be available, so switching to
_imp may not fix the problem.
2014-01-04 21:56:07 -07:00
Eric Snow aed5b22ead Issue 20123: Fix pydoc.synopsis() for "binary" modules.
Also add missing tests to test_pydoc.
2014-01-04 20:38:11 -07:00
Terry Jan Reedy c1bd2fef8b Merge with 3.3 2013-11-04 21:44:17 -05:00
Terry Jan Reedy 5c81164077 Issue #19397: test_pydoc now works with -S (help not added to builtins).
Patch by Serhiy Storchaka and Vajrasky Kok.
2013-11-04 21:43:26 -05:00
Ethan Furman 3f2f19230c Issue #19030: fix new pydoc tests for --without-doc-strings 2013-10-22 07:30:24 -07:00
Charles-François Natali 1a82f7e6a5 Fix test_pydoc failure introduced by 2f09a6980e1a (issue #19030). 2013-10-21 14:46:34 +02:00
Ethan Furman b0c84cdaac Issue #19030: final pieces for proper location of various class attributes located in the metaclass.
Okay, hopefully the very last patch for this issue.  :/

I realized when playing with Enum that the metaclass attributes weren't always displayed properly.

New patch properly locates DynamicClassAttributes, virtual class attributes (returned by __getattr__ and friends), and metaclass class attributes (if they are also in the metaclass __dir__ method).

Also had to change one line in pydoc to get this to work.

Added tests in test_inspect and test_pydoc to cover these situations.
2013-10-20 22:37:39 -07:00
Brett Cannon 679ecb565b Issue #15767: back out 8a0ed9f63c6e, finishing the removal of
ModuleNotFoundError.
2013-07-04 17:51:50 -04:00
Brett Cannon b1611e2772 Issue #15767: Introduce ModuleNotFoundError, a subclass of
ImportError.

The exception is raised by import when a module could not be found.
Technically this is defined as no viable loader could be found for the
specified module. This includes ``from ... import`` statements so that
the module usage is consistent for all situations where import
couldn't find what was requested.

This should allow for the common idiom of::

  try:
    import something
  except ImportError:
    pass

to be updated to using ModuleNotFoundError and not accidentally mask
ImportError messages that should propagate (e.g. issues with a
loader).

This work was driven by the fact that the ``from ... import``
statement needed to be able to tell the difference between an
ImportError that simply couldn't find a module (and thus silence the
exception so that ceval can raise it) and an ImportError that
represented an actual problem.
2013-06-12 16:59:46 -04:00
Antoine Pitrou 916fc7bf28 Issue #11995: test_pydoc doesn't import all sys.path modules anymore. 2013-05-19 15:44:54 +02:00
Antoine Pitrou c52d113e28 Issue #11995: test_pydoc doesn't import all sys.path modules anymore. 2013-05-19 15:46:37 +02:00
Brett Cannon 9c1334ef7d #17115: Remove what appears to be a useless chunk of code which broke
other tests.
2013-05-04 17:27:59 -04:00
R David Murray ac0cea5fab Merge: #17476: make allmethods actually return all methods.
This fixes a regression relative to Python2.  (In 2, methods on a class were
unbound methods and matched the inspect queries being done, in 3 they are just
functions and so were missed).

This is an undocumented function that pydoc itself does not use, but
I found that numpy at least uses it in its documentation generator.

Original patch by Matt Bachmann.
2013-03-19 02:47:44 -04:00
R David Murray 52dfc74080 #17476: make allmethods actually return all methods.
This fixes a regression relative to Python2.  (In 2, methods on a class were
unbound methods and matched the inspect queries being done, in 3 they are just
functions and so were missed).

This is an undocumented function that pydoc itself does not use, but
I found that numpy at least uses it in its documentation generator.

Original patch by Matt Bachmann.
2013-03-19 02:32:35 -04:00
R David Murray 9929bc543a #17476: make allmethods actually return all methods.
This fixes a regression relative to Python2.  (In 2, methods on a class were
unbound methods and matched the inspect queries being done, in 3 they are just
functions and so were missed).

This is an undocumented function that pydoc itself does not use, but
I found that numpy at least uses it in its documentation generator.

Original patch by Matt Bachmann.
2013-03-19 02:31:06 -04:00
R David Murray 455f296188 #17464: improve pydoc test coverage.
Patch by Matt Bachmann.
2013-03-19 00:00:33 -04:00
Serhiy Storchaka 26f1166510 Issue #17041: Fix testing when Python is configured with the
--without-doc-strings.
2013-01-27 20:03:39 +02:00
Serhiy Storchaka 9d0add0c7e Issue #17041: Fix testing when Python is configured with the
--without-doc-strings.
2013-01-27 19:47:45 +02:00
Stefan Krah fb931902c8 Fix test_pydoc for build --without-doc-strings. 2013-01-26 13:57:15 +01:00
R David Murray a82c960c17 merge #14638: pydoc now treats non-str __name__ as None instead of raising
Original patch by Peter Otten.
2012-04-23 13:26:44 -04:00
R David Murray c43125a05c #14638: pydoc now treats non-str __name__ as None instead of raising
Original patch by Peter Otten.
2012-04-23 13:23:57 -04:00
Brett Cannon fd0741555b Issue #2377: Make importlib the implementation of __import__().
importlib._bootstrap is now frozen into Python/importlib.h and stored
as _frozen_importlib in sys.modules. Py_Initialize() loads the frozen
code along with sys and imp and then uses _frozen_importlib._install()
to set builtins.__import__() w/ _frozen_importlib.__import__().
2012-04-14 14:10:13 -04:00
Ned Deily f16d6771c7 Issue #13861: merge 2012-02-03 23:16:11 +01:00
Ned Deily 3429491950 Issue #13861: Prevent test_apropos* test case failures in test_pydoc. 2012-02-03 23:14:37 +01:00
Ned Deily 9403071277 merge from 3.2 2011-10-06 14:24:31 -07:00
Ned Deily 92a81a1eec Issue #7425: Refactor test_pydoc test case for '-k' behavior and add
new test cases for importing bad packages and unreadable packages dirs.
2011-10-06 14:19:03 -07:00
Ezio Melotti d8b509b192 #13012: use splitlines(keepends=True/False) instead of splitlines(0/1). 2011-09-28 17:37:55 +03:00
Éric Araujo c473f8ceac Merge fix for #8887 from 3.2 2011-07-29 17:38:23 +02:00
Éric Araujo e64e51bfa7 Make “pydoc somebuiltin.somemethod” work (#8887) 2011-07-29 17:03:55 +02:00
Antoine Pitrou afed6ecf21 Merge from 3.2 2011-07-15 22:43:33 +02:00
Antoine Pitrou f7f54759b5 Use test.script_helper in test_pydoc 2011-07-15 22:42:12 +02:00
Antoine Pitrou a6e81a23b3 test_pydoc needs to cleanup after itself 2011-07-15 22:32:25 +02:00
Victor Stinner 319672e8a6 (merge 3.2) Issue #12451: pydoc.synopsis() now reads the encoding cookie if
available, to read the Python script from the right encoding.
2011-06-30 15:58:29 +02:00
Victor Stinner e6c910e953 Issue #12451: pydoc.synopsis() now reads the encoding cookie if available, to
read the Python script from the right encoding.
2011-06-30 15:55:43 +02:00
Victor Stinner ba8ef7a81d (Merge 3.2) test_pydoc: skip PydocServerTest if thread support is disabled 2011-05-20 02:29:55 +02:00
Victor Stinner 62a68f2dbe test_pydoc: skip PydocServerTest if thread support is disabled 2011-05-20 02:29:13 +02:00
Ezio Melotti 60811c215f #11926: merge with 3.2. 2011-04-28 07:55:29 +03:00
Ezio Melotti 44aad855dd #11926: merge with 3.1. 2011-04-28 07:51:14 +03:00
Ezio Melotti b185a04aa1 #11926: add missing keywords to help("keywords"). 2011-04-28 07:42:55 +03:00
Raymond Hettinger 007bdbd7ab Issue #11666: Teach pydoc to display full help for named tuples 2011-03-25 14:16:13 -07:00
Raymond Hettinger 1103d05775 Issue #11666: Teach pydoc to display full help for named tuples 2011-03-25 14:15:24 -07:00
Victor Stinner 98dbba5d20 Issue #3080: Use repr() to format the module name on error 2011-03-14 15:15:47 -04:00
Brett Cannon 7a54073a56 Issue #10992: make tests pass when run under coverage.
Various tests fail when run under coverage. A primary culprit is refcount tests
which fail as the counts are thrown off by the coverage code. A new decorator
-- test.support.refcount_test -- is used to decorate tests which test refcounts
and to skip them when running under coverage. Other tests simply fail because
of changes in the system (e.g., __local__ suddenly appearing).

Thanks to Kristian Vlaardingerbroek for helping to diagnose the test failures.
2011-02-22 03:04:06 +00:00
Georg Brandl d2f3857c40 #10961: fix exception handling in new pydoc server code.
Patch by Ron Adam, reviewed by Eric Araujo.
2011-01-30 08:37:19 +00:00
Nick Coghlan ecace28ef4 Handle Windows paths and don't double up on HTML header sections in new pydoc URL handler 2010-12-03 16:08:46 +00:00
Nick Coghlan 7bb30b72d8 Improve Pydoc interactive browsing (#2001). Patch by Ron Adam.
* A -b option to start an enhanced browsing session.
* Allow -b and -p options to be used together.
* Specifying port 0 will pick an arbitrary unused socket port.
* A new browse() function to start the new server and browser.
* Show Python version information in the header.
* A *Get* field which takes the same input as the help() function.
* A *Search* field which replaces the Tkinter search box.
* Links to *Module Index*, *Topics*, and *Keywords*.
* Improved source file viewing.
* An HTMLDoc.filelink() method.
* The -g option and the gui() and serve() functions are deprecated.
2010-12-03 09:29:11 +00:00
Georg Brandl d80d5f4ee8 #940286: pydoc.Helper.help() ignores input/output init parameters. 2010-12-03 07:47:22 +00:00
Alexander Belopolsky 4979b9b91e Merged revisions 86504 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86504 | alexander.belopolsky | 2010-11-17 20:52:54 -0500 (Wed, 17 Nov 2010) | 15 lines

  Issue #10446: Several changes to module documentation generated by pydoc:

  1. Online reference manual link is now version-specific and the
     'MODULE DOCS' section renamed to 'MODULE REFERENCE'.

  2. 'FILE' section is moved to the end of the file.

  3. Special names processed by pydoc such as __version__ or __credits__
     are now excluded from the DATA section.

  4. Defined __all__ to prevent pydoc from exposing undocumented details
     about itself.

  5. Removed Python 2.3 compatibility code.
........
2010-11-18 01:58:16 +00:00
Alexander Belopolsky a47bbf5a4b Issue #10446: Several changes to module documentation generated by pydoc:
1. Online reference manual link is now version-specific and the
   'MODULE DOCS' section renamed to 'MODULE REFERENCE'.

2. 'FILE' section is moved to the end of the file.

3. Special names processed by pydoc such as __version__ or __credits__
   are now excluded from the DATA section.

4. Defined __all__ to prevent pydoc from exposing undocumented details
   about itself.

5. Removed Python 2.3 compatibility code.
2010-11-18 01:52:54 +00:00
Barry Warsaw 28a691b7fd PEP 3147 2010-04-17 00:19:56 +00:00
Brian Curtin 0d8a1dd647 Merged revisions 79520 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r79520 | brian.curtin | 2010-03-30 22:19:28 -0500 (Tue, 30 Mar 2010) | 9 lines

  Merged revisions 79518 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79518 | brian.curtin | 2010-03-30 22:10:21 -0500 (Tue, 30 Mar 2010) | 2 lines

    Fix #8225. xml.etree was displaying an incorrect link when viewed in help.
  ........
................
2010-03-31 03:22:46 +00:00
Brian Curtin 49c284c174 Merged revisions 79518 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r79518 | brian.curtin | 2010-03-30 22:10:21 -0500 (Tue, 30 Mar 2010) | 2 lines

  Fix #8225. xml.etree was displaying an incorrect link when viewed in help.
........
2010-03-31 03:19:28 +00:00