Page MenuHomePhabricator
Create Task
Maniphest T74424

ModuleDeprecationWrapper breaks code inspection tools, including epydoc, sphinx autodoc
Closed, ResolvedPublic
Actions

Description

epydoc documentation was broken with the introduction of ModuleDeprecationWrapper in __init__.

$ epydoc --debug pywikibot
Warning: Module pywikibot is shadowed by a variable with the same name.
Traceback (most recent call last):                                   Progress:                                                          28:32
  File "/usr/bin/epydoc", line 13, in <module>-----------------------------------------------------------------------------------------------]
    cli()                Building documentation: pywikibot'.i18n (.../pywikibot/i18n.pyc)                  
  File "/usr/lib/python2.7/dist-packages/epydoc/cli.py", line 965, in cli
    main(options, names)
  File "/usr/lib/python2.7/dist-packages/epydoc/cli.py", line 757, in main
    exclude_parse=exclude_parse)
  File "/usr/lib/python2.7/dist-packages/epydoc/docbuilder.py", line 206, in build_doc_index
    doc_pairs = _get_docs_from_items(items, options)
  File "/usr/lib/python2.7/dist-packages/epydoc/docbuilder.py", line 398, in _get_docs_from_items
    item, doc_pairs[-1], options, progress_estimator)
  File "/usr/lib/python2.7/dist-packages/epydoc/docbuilder.py", line 595, in _get_docs_from_submodules
    module_filename, options, progress_estimator, pkg_docs)
  File "/usr/lib/python2.7/dist-packages/epydoc/docbuilder.py", line 541, in _get_docs_from_module_file
    filename=filename, context=parent_docs[0])
  File "/usr/lib/python2.7/dist-packages/epydoc/docintrospecter.py", line 106, in introspect_docs
    value = get_value_from_filename(filename, context)
  File "/usr/lib/python2.7/dist-packages/epydoc/docintrospecter.py", line 828, in get_value_from_filename
    pkg_dir = os.path.split(context.filename)[0]
AttributeError: 'GenericValueDoc' object has no attribute 'filename'

removing the last two lines of __init__.py fixes that problem, but likely others exist; here is the output after that is removed, showing mostly a problem with the deprecators/redirectors.

$ epydoc --debug pywikibot
+-------------------------------------------------------------------------------------------------------------------------------------------
| In .../pywikibot/botirc.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named ircbot (line 23)
|   
Warning: No information available for pywikibot.data.api.CTEBinaryBytesGenerator's base email.generator.BytesGenerator
Warning: No information available for pywikibot.data.api.CTEBinaryMIMEMultipart's base email.mime.multipart.MIMEMultipart
Warning: No information available for pywikibot.data.api.CTEBinaryBytesGenerator's base email.generator.BytesGenerator
Warning: No information available for pywikibot.data.api.CTEBinaryMIMEMultipart's base email.mime.multipart.MIMEMultipart
  Debug: <RoutineDoc pywikibot.categoryFormat> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.compileLinkR> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.extract_templates_and_params> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.getCategoryLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.getLanguageLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.interwikiFormat> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.interwikiSort> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.isDisabled> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeCategoryLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeCategoryLinksAndSeparator> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeDisabledParts> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeHTMLParts> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeLanguageLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.removeLanguageLinksAndSeparator> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.replaceCategoryInPlace> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.replaceCategoryLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.replaceExcept> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.replaceLanguageLinks> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.unescape> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.site.APISite.forceLogin> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.site.BaseSite.getNamespaceIndex> is in <ModuleDoc pywikibot.tools> but name does not dominate
  Debug: <RoutineDoc pywikibot.site.BaseSite.normalizeNamespace> is in <ModuleDoc pywikibot.tools> but name does not dominate
Warning: 304 markup errors were found while processing docstrings.  Use the verbose switch (-v) to display markup errors.

Details

Reference
bz72424
SubjectRepoBranchLines +/-
[IMPR] No longer drop site decorators for optimized codespywikibot/coremaster+14 -32
[FIX] ModuleDeprecationWrapper: Expose __dict__pywikibot/coremaster+1 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

• bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 3:44 AM
• bzimport added a project: Pywikibot-Documentation.
• bzimport set Reference to bz72424.
• bzimport added a subscriber: Unknown Object (????).
jayvdb created this task.Oct 23 2014, 1:35 PM
gerritbot added a comment.Oct 29 2014, 7:59 PM

Change 169788 had a related patch set uploaded by John Vandenberg:
Detect epydoc and disable decorators, etc

https://gerrit.wikimedia.org/r/169788

gerritbot added a comment.Oct 30 2014, 2:33 AM

Change 169985 had a related patch set uploaded by John Vandenberg:
Epydoc syntax issues

https://gerrit.wikimedia.org/r/169985

jayvdb added a comment.Oct 30 2014, 2:40 AM

One rather annoying warning is @return on property getters. See http://sourceforge.net/p/epydoc/bugs/290/

jayvdb added a comment.Nov 18 2014, 1:27 PM

Looking for an alternative to the unmaintained epydoc, I came across pydoctor.

https://bugs.launchpad.net/pydoctor

I've found one bug that makes our output look a bit silly.

https://bugs.launchpad.net/pydoctor/+bug/1393776

gerritbot added a comment.Nov 19 2014, 5:07 PM

Change 169788 merged by jenkins-bot:
Disable decorators and wrappers when not debug

https://gerrit.wikimedia.org/r/169788

jayvdb added a comment.Nov 19 2014, 9:21 PM

It is still not ideal.

jayvdb added a comment.Nov 19 2014, 9:24 PM

An old version of the patch contains a way to detect epydoc
https://gerrit.wikimedia.org/r/#/c/169788/6/pywikibot/tools.py,cm

However that is an quite expensive task to run during startup.

If we can get Sphinx doc builds to work easily, I think we can live with epydoc being difficult to run.

Aklapper added a project: Pywikibot.Nov 27 2014, 4:10 PM
Aklapper added a project: Documentation.Jan 4 2015, 11:38 PM
jayvdb renamed this task from ModuleDeprecationWrapper breaks epydoc to ModuleDeprecationWrapper breaks code inspection tools, including epydoc, sphinx autodoc.Feb 13 2015, 10:48 PM
jayvdb set Security to None.
jayvdb mentioned this in T112491: Fix bugs in Pywikibot doc generation.Sep 15 2015, 4:20 AM
jayvdb mentioned this in T112488: jenkins doc generation rule should vote against changes which create sphinx errors.Sep 15 2015, 12:26 PM
gerritbot subscribed.Sep 15 2015, 2:28 PM

Change 238449 had a related patch set uploaded (by XZise):
[FIX] ModuleDeprecationWrapper: Expose dict

https://gerrit.wikimedia.org/r/238449

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 15 2015, 2:28 PM
gerritbot added a project: Patch-For-Review.Sep 15 2015, 2:28 PM
gerritbot added a comment.Sep 15 2015, 10:04 PM

Change 238449 merged by jenkins-bot:
[FIX] ModuleDeprecationWrapper: Expose dict

https://gerrit.wikimedia.org/r/238449

XZise mentioned this in rPWBCda6605817b8f: [FIX] ModuleDeprecationWrapper: Expose __dict__.Sep 15 2015, 10:05 PM
jayvdb updated the task description. (Show Details)Sep 16 2015, 6:18 AM
jayvdb updated the task description. (Show Details)
jayvdb mentioned this in T112830: Sphinx autodoc fails to inspect classes deprecated using ModuleDeprecationWrapper.Sep 16 2015, 10:37 PM
jayvdb added a subtask: T112830: Sphinx autodoc fails to inspect classes deprecated using ModuleDeprecationWrapper.
Danny_B removed a parent task: T66840: [DO NOT USE] Pywikibot Documentation (tracking) [superseded by #Pywikibot-documentation].Jul 11 2016, 6:11 PM
Magul removed a project: Patch-For-Review.Nov 15 2016, 9:23 PM
• srodlund moved this task from Backlog to Automated and Inline Technical Documentation on the Documentation board.Aug 20 2018, 8:59 PM
Xqt closed subtask T112830: Sphinx autodoc fails to inspect classes deprecated using ModuleDeprecationWrapper as Resolved.Nov 15 2021, 7:45 PM
Xqt closed this task as Resolved.Nov 16 2021, 4:59 AM
Xqt claimed this task.
Xqt subscribed.

epydoc is dropped and I haven’t seen this bug for years

Xqt removed Xqt as the assignee of this task.Nov 16 2021, 4:59 AM
gerritbot added a comment.Sep 20 2023, 10:17 AM

Change 959178 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] [IMPR] No longer drop decorators for optimized codes

https://gerrit.wikimedia.org/r/959178

gerritbot added a project: Patch-For-Review.Sep 20 2023, 10:17 AM
gerritbot added a comment.Oct 21 2023, 10:00 AM

Change 959178 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] No longer drop site decorators for optimized codes

https://gerrit.wikimedia.org/r/959178

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL