8000 ENH: add by_key by tacaswell · Pull Request #26 · matplotlib/cycler · GitHub
[go: up one dir, main page]
Skip to content

ENH: add by_key #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 13, 2015
Merged

ENH: add by_key #26

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17f8108
ENH: add by_key
tacaswell Nov 30, 2015
120633d
MNT: maintain back compatibility on private API
tacaswell Nov 30, 2015
dee6eca
TST: push back to 100% test coverage
tacaswell Dec 1, 2015
714b346
TST: add explicit tests for by_key
tacaswell Dec 1, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
ENH: add by_key 
Promote `_transpose` to the public method `by_key`.
  • Loading branch information
@tacaswell
tacaswell committed Nov 30, 2015
commit 17f810881cf5d5d0c9b9fdc9cb670ef19077f385
30 changes: 17 additions & 13 deletions cycler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ def _from_iter(cls, label, itr):
def __getitem__(self, key):
# TODO : maybe add numpy style fancy slicing
if isinstance(key, slice):
trans = self._transpose()
trans = self.by_key()
return reduce(add, (_cycler(k, v[key])
for k, v in six.iteritems(trans)))
else:
Expand Down Expand Up @@ -255,7 +255,7 @@ def __mul__(self, other):
if isinstance(other, Cycler):
return Cycler(self, other, product)
elif isinstance(other, int):
trans = self._transpose()
trans = self.by_key()
return reduce(add, (_cycler(k, v*other)
for k, v in six.iteritems(trans)))
else:
Expand Down Expand Up @@ -346,17 +346,21 @@ def _repr_html_(self):
output += "</table>"
return output

def _transpose(self):
"""
Internal helper function which iterates through the
styles and returns a dict of lists instead of a list of
dicts. This is needed for multiplying by integers and
for __getitem__
def by_key(self):
"""Values by key

This returns the transposed values of the cycler. Iterating
over a `Cycler` yields dicts with a single value for each key,
this method returns a `dict` of `list` which are the values
for the given key.

The returned value can be used to create an equivalent `Cycler`
using only `+`.

Returns
-------
trans : dict
dict of lists for the styles
transpose : dict
dict of lists of the values for each key.
"""

# TODO : sort out if this is a bottle neck, if there is a better way
Expand Down Expand Up @@ -386,7 +390,7 @@ def simplify(self):
# ((a + b) + (c + d))
# I would believe that there is some performance implications

trans = self._transpose()
trans = self.by_key()
return reduce(add, (_cycler(k, v) for k, v in six.iteritems(trans)))

def concat(self, other):
Expand Down Expand Up @@ -453,8 +457,8 @@ def concat(left, right):

raise ValueError(msg)

_l = left._transpose()
_r = right._transpose()
_l = left.by_key()
_r = right.by_key()
return reduce(add, (_cycler(k, _l[k] + _r[k]) for k in left.keys))


Expand Down
20 changes: 20 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,26 @@ Cycles can be sliced with :obj:`slice` objects

to return a sub-set of the cycle as a new `Cycler`.

Inspecting the `Cycler`
-----------------------

To inspect the values of the transposed `Cycler` use
the `Cycler.by_key` method:

.. ipython:: python

c_m.by_key()

This `dict` can be mutated and used to create a new `Cycler` with
the updated values

.. ipython:: python

bk = c_m.by_key()
bk['color'] = ['green'] * len(c_m)
cycler(**bk)


Examples
--------

Expand Down
0