Opened 8 years ago

Closed 5 months ago

#5533 defect closed fixed (fixed)

request.prepath and request.postpath are undocumented

Reported by: Wilfredo Sánchez Vega Owned by: Wim Lewis
Priority: normal Milestone:
Component: web Keywords: documentation
Cc: jknight, Wim Lewis, Tom Most Branch: 5533-irequest-postpath-attribute
branch-diff, diff-cov, branch-cov, buildbot
Author:

Description

request.prepath and request.postpath are undocumented, which makes learning about them somewhat more challenging than is perhaps necessary.

Change History (12)

comment:1 Changed 8 years ago by DefaultCC Plugin

Cc: jknight added

comment:2 Changed 8 years ago by Wilfredo Sánchez Vega

Summary: `request.prepath` and `request.postpath` are undocumentedrequest.prepath and request.postpath are undocumented

comment:3 Changed 7 months ago by Wim Lewis

This has been bothering me as well (as I've been working on a typeshed for Twisted). There is one brief mention of postpath in the docstring for t.w.resource.Resource.getChild() but that's it.

Both are sequences of bytes.

comment:4 Changed 7 months ago by Wim Lewis

Owner: set to Wim Lewis
Status: newassigned

Hm, are prepath and postpath part of the IRequest interface, or only the t.w.s.Request implementation? I'd guess they should be on IRequest, since IRequest has the method prePathURL() which depends on the information in prepath.

comment:6 Changed 6 months ago by Wim Lewis

Branch: 5533-irequest-postpath-attribute
Cc: Wim Lewis added
Keywords: documentation review added

comment:7 Changed 6 months ago by Wim Lewis

Owner: Wim Lewis deleted
Status: assignednew

comment:8 Changed 6 months ago by Glyph

The PR in review appears to be this one https://github.com/twisted/twisted/pull/1113

comment:9 Changed 5 months ago by Glyph

Keywords: review removed

Hopefully these two PRs won't conflict too much. These docs are such a huge improvement; I feel like now that we've got these things actually written out, we can finally start to actually refactor them and transition away from them (and people maintaining applications which depend on them will have a much easier time in the meanwhile!)

https://github.com/twisted/twisted/pull/1113#pullrequestreview-223639365

comment:10 Changed 5 months ago by Glyph

Owner: set to Wim Lewis

comment:11 Changed 5 months ago by Tom Most

Cc: Tom Most added

comment:12 Changed 5 months ago by Wim Lewis <wiml@…>

Resolution: fixed
Status: newclosed

In fb05f93f:

Merge pull request #1113 from twisted/5533-irequest-postpath-attribute

Author: wiml
Reviewer: glyph
Fixes: ticket:5533 ticket:9091 ticket:9458

Add the prepath and postpath attributes to IRequest; fix other docstrings.

Note: See TracTickets for help on using tickets.