twisted / twisted/twisted

ProcessEndpoint should have a useful repr

Open
#9,342 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

twm's avatar @twm reported
Trac ID trac#9342
Type enhancement
Created 2017-11-27 20:26:25Z

I have log messages like this:

Scheduling retry 1 to connect <twisted.internet.endpoints.ProcessEndpoint object at 0x7f3fa4b13490> in 2.34234234 seconds.

It would be helpful if ProcessEndpoint.__repr__ indicated what it is executing. The full set of parameters is probably too much to include in the repr, but at the least the executable should be shown. The initial arguments would also be useful

Searchable metadata
trac-id__9342 9342
type__enhancement enhancement
reporter__twm twm
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__new new
resolution__None None
component__core core
keywords__None None
time__1511814385400212 1511814385400212
changetime__1511814385400212 1511814385400212
version__None None
owner__None None

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

Locate ProcessEndpoint and its repr implementation, then inspect nearby endpoint representation behavior and tests. Use the reported retry log as the baseline, and confirm that the representation identifies the executable and, where appropriate, the initial arguments without becoming overly verbose.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.