[tor-bugs] #29333 [Core Tor/Stem]: Use the bandwidth-file-spec.txt keywords as BandwidthFile attributes

Tor Bug Tracker & Wiki blackhole at torproject.org
Wed Feb 6 18:35:35 UTC 2019


#29333: Use the bandwidth-file-spec.txt keywords as BandwidthFile attributes
---------------------------+------------------------
 Reporter:  juga           |          Owner:  atagar
     Type:  defect         |         Status:  new
 Priority:  Medium         |      Milestone:
Component:  Core Tor/Stem  |        Version:
 Severity:  Normal         |     Resolution:
 Keywords:  tor-bwauth     |  Actual Points:
Parent ID:                 |         Points:
 Reviewer:                 |        Sponsor:
---------------------------+------------------------

Comment (by atagar):

 > So, i'd propose that we delay these changes until we solve #28547, and
 mark this as needs_information. Sounds good?

 Hi juga. I'd be happy to rename these attributes, keep them as-is, or
 wait. Your call.

 Every other Stem Descriptor subclasses uses nicer attribute names than the
 spec. Bandwidth files are not unique in this regard. My goal with Stem is
 to provide the most developer friendly library I can, not to mirror spec
 terminology. If you feel the names proposed above improve code readability
 we can go with that but personally I think it's a step backward.

 To be clear we can only await the tickets you cite until Stem's next
 release. That won't be for a long while (rough guess: six months?), but
 once Stem makes a release these attribute names can no longer change. (*)

 How would you care to proceed?

 > Feel free to open tickets for the specification regarding software
 versions and not specification versions.

 I'll leave this at your discretion. Our spec determines the API I provide
 in Stem and those struck me as rough edges as I implemented it, but I
 don't have a personal interest in if the spec changes or not. Just
 feedback - that's all.

 Cheers! -Damian

 (*) Not entirely true, but something to be avoided. We can still rename
 attributes but it's done so via aliases, with the deprecated name
 remaining around until Stem 2.x which will be released in 2020 when Python
 2.7 is deprecated.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29333#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list