twisted / twisted/twisted

Howto on debugging Twisted applications

Open
#5,469 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core documentation enhancement new priority-normal
Dominant language
Python
Stars
6k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
10

Description

itamarst's avatar @itamarst reported
Trac ID trac#5469
Type enhancement
Created 2012-01-31 17:23:35Z

There's the emacs appendix on debugging, but that's not quite sufficient or obvious.

Things to cover:

  1. Failure debug mode.
  2. Deferred debug mode.
  3. "Unhandled Deferred"'s gc dependency meaning errors might show up late
  4. trial/twistd -b.
  5. Encourage unit testing.
Searchable metadata
trac-id__5469 5469
type__enhancement enhancement
reporter__itamar itamar
priority__normal normal
milestone__ 
branch__ 
branch_author__ 
status__new new
resolution__None None
component__core core
keywords__documentation documentation
time__1328030615000000 1328030615000000
changetime__1328030615000000 1328030615000000
version__None None
owner__ 

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Emacs debugging appendix and the documentation for failure debug mode, Deferred debug mode, unhandled Deferred errors, trial/twistd -b, and unit testing. The work is done when a clear how-to explains all five topics and makes the debugging workflow obvious to Twisted application developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.