René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Cleaning up the Formatter API","articleBody":"Still on my offset-text rewrite spree...\n\nCurrently, the formatter API (in charge of picking the strings for the tick labels, axis offset and cursor position in the status bar) is a bit messy: the public methods available are\n- `Formatter.__call__(self, val, idx)`: computes the label texts\n- `Formatter.format_data(self, val)`: not publicly used\n- `Formatter.format_data_short(self, val)`: computes the cursor position text\n- `Formatter.get_offset(self)`: returns the offset text\n- `Formatter.set_locs(self, locs)`: required for computing the labels\n- `Formatter.fix_minus(self, s)`: overriden only by ScalarFormatter to use a unicode minus\n\nFixedFormatter also provides `set_offset_string`.\n\nThe commonly used ScalarFormatter and LogFormatter also provide `pprint_val` (with different signatures, and not publicly used).\n\nScalarFormatter also provides a couple of getter/setters (for `useOffset`, `useLocale`, `scientific`, `powerlimits`); LogFormatter provides `base` and `label_minor` as _setters_ for instance variables.\n\nLogFormatterExponent and LogFormatterMathtext are variants of LogFormatter.\n\nEngFormatter also provides `format_eng` (not publicly used).\n\nThere are also a bunch of instance attributes which are public but probably intended as private.\n\nI propose simplifying the API to the following:\n- `Formatter.get_label_text(self, val: float, idx: int)`: computes the label texts\n- `Formatter.get_cursor_text(self, val: float)`: computes the cursor position text\n- `Formatter.get_offset_text(self)` and `Formatter.set_offset_text(self, s: str)`: get/set the offset text\n- `Formatter.set_locs(self, locs: array-like)`: because we need it\n- `Formatter.set_uselocale(self, b: bool)`: because there's no reason only ScalarFormatter has it\n\n(the new method names can be made to fallback on the old method names with a deprecation warning in the base class)\n\nand drop or make private basically everything else:\n- `fix_minus` (let's first check if any backend doesn't support unicode)\n- `pprint_val/format_eng`\n- the various instance attributes which should have been private to start with (keeping: `scientific`, `powerlimits`, `base`, `label_minor`, using getter/setters)\n\nand fold the `LogFormatterExponent` and `LogFormatterMathText` classes into options for the `LogFormatter` class.\n\nThoughts?\n","author":{"url":"https://github.com/anntzer","@type":"Person","name":"anntzer"},"datePublished":"2016-01-02T20:22:01.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":9},"url":"https://github.com/5787/matplotlib/issues/5787"}