python / cpython

The Python programming language
https://www.python.org
Other
62.27k stars 29.92k forks source link

Deprecate trace module undocumented API #54580

Closed abalkin closed 13 years ago

abalkin commented 13 years ago
BPO 10371
Nosy @brettcannon, @terryjreedy, @abalkin
Files
  • trace-deprecations.diff
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields: ```python assignee = 'https://github.com/abalkin' closed_at = created_at = labels = ['type-feature', 'library'] title = 'Deprecate trace module undocumented API' updated_at = user = 'https://github.com/abalkin' ``` bugs.python.org fields: ```python activity = actor = 'belopolsky' assignee = 'belopolsky' closed = True closed_date = closer = 'belopolsky' components = ['Library (Lib)'] creation = creator = 'belopolsky' dependencies = [] files = ['19553'] hgrepos = [] issue_num = 10371 keywords = ['patch'] message_count = 4.0 messages = ['120833', '120886', '121028', '121704'] nosy_count = 4.0 nosy_names = ['brett.cannon', 'terry.reedy', 'belopolsky', 'eli.bendersky'] pr_nums = [] priority = 'normal' resolution = 'accepted' stage = 'resolved' status = 'closed' superseder = None type = 'enhancement' url = 'https://bugs.python.org/issue10371' versions = ['Python 3.2'] ```

    abalkin commented 13 years ago

    Following python-dev discussion on the issue, I would like to propose trace-deprecations.diff patch for review.

    I would like to make these changes before turning to bpo-10342 which will require changing many of these APIs that take a source path to take a module object (or possibly a loader).

    Note that CoverageResults presents an interesting case of a class that does not need to be public, but its methods, particularly write_results() need to be documented.

    terryjreedy commented 13 years ago

    Looks good in a cursory reading. I presume trace test still passes.

    If you change the signature of the renamed functions, that would break the current wrappings. Would you use new private functions with different names, or change the wrappings where possible?

    786d3f11-b763-4414-a03f-abc264e0b72d commented 13 years ago

    Alexander, http://bugs.python.org/file19553/trace-deprecations.diff looks good to me

    abalkin commented 13 years ago

    Committed in revision 86594.