Deprecate twisted.persisted.journal

[thijs]

twisted.persisted.journal is one of the not-quite-reliable storage systems still floating around from Twisted's sordid past. No one has any intention of finishing it (clearly, as it's been 4 years since its last change), and by current standards we probably wouldn't want it in Twisted anyway due to how far afield from Twisted's primary goals it is.

It should be deprecated so we can remove it in a few more releases.

[itamar]

I'd rather not spend typing time on this, but it's certainly worth doing.

[djfroofy]

Unit test from first patch is stupid and causes breakage in test suite anyhow. I'm not sure how to correctly test deprecation warning in module import or if this is even necessary.

[thijs]

This is blocked by #4111 and doesn't need a higher priority, apps aren't breaking or anything.

[exarkun]

Thanks! Some simple comments:

1. Missing docstrings on the test class and test method
2. The test will fail if it is run twice in one process. You could either:
   1. pop it out of sys.modules before the test runs
   2. deprecate the journal attribute of twisted.persisted instead, using deprecateModuleAttribute (although I've never done it this way and I don't know what will happen).

[amacleod]

(In [28690]) Branching to 'deprecatepersistedjournal-4298'

[amacleod]

Updated changes in [28590:28694].

[amacleod]

Er.. I mean [28690:28694].

[amacleod]

Here's a better revision link: ​http://twistedmatrix.com/trac/changeset?new=/branches/deprecatepersistedjournal-4298@28694&old=/branches/deprecatepersistedjournal-4298@28690

[amacleod]

Ready for re-review.

[cyli]

Deprecation should be "as of 10.1", since the current version of Twisted is 10.0.

Everything else seems to be great though, and the tests pass. This can probably be merged into trunk after that change.

[amacleod]

Incremented deprecated-at version in r28714

[cyli]

Sorry, I should have spotted this last time, but it's missing an entry in the relevant topfile directory listing what change this branch will make (see ​http://twistedmatrix.com/trac/wiki/ReviewProcess#Newsfiles).

[amacleod]

Thanks for the heads-up cyli. I will add a news file next time I'm home and have free time.

[thijs]

Thanks. Could you also:

• update the copyright in twisted/persisted/journal/init.py
• use 2010 instead of 2001-2010 in the new test_journal.py

Merge after that.

[glyph]

Poke, poke, amacleod: this is almost done! Are you going to take it across the finish line or what? :)

[amacleod]

Finally got off my duff and did it: [29264].

[exarkun]

Hi amacleod,

Please read ​http://twistedmatrix.com/trac/wiki/ReviewProcess before your next trunk commit. :)

[exarkun]

This was reverted in r29265 because it was missing a news file. Should be easy for anyone to finish up.

[cyli]

(In [30451]) Branching to 're-deprecate-persisted-journal-4298'

[cyli]

(In [30458]) Changed some spacing and whitespace to comply with coding standard.

refs #4298

[cyli]

Oops - majority of the changes were in ​r30457

[cyli]

Here are some ​build results

[thijs]

Merge after updating the copyright in twisted/test/test_journal.

[thijs]

Replying to thijs:

It should be deprecated so we can remove it in a few more releases.

Opened #4805 for removing it in a future release.

[cyli]

Replying to thijs:

Merge after updating the copyright in twisted/test/test_journal.

I did so in ​r30458. It's just when I entered the commit message for ​r30457, I used the word "ref" instead of "refs", so trac didn't pick it up. Hence I linked to ​r30457 manually, but ​r30458 has some additional changes.

Anyway, thanks for the review. Merging. :)

[cyli]

(In [30460]) Merge re-deprecate-persisted-journal-4298: Deprecate twisted.persisted.journal

Author: djfroofy, amacleod, cyli

Reviewer: thijs, exarkun, cyli

Fixes: #4298

Re-deprecate twisted.persisted.journal as of 11.0, after reversion (of deprecation as of 10.1) due to lack of newsfile.