pax_global_header00006660000000000000000000000064126605255040014517gustar00rootroot0000000000000052 comment=e18a779489a03df408eb4da98d8e4826ead664b0 cycler-0.10.0/000077500000000000000000000000001266052550400130565ustar00rootroot00000000000000cycler-0.10.0/.gitignore000066400000000000000000000014761266052550400150560ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] # C extensions *.so # Distribution / packaging .Python env/ bin/ build/ develop-eggs/ dist/ eggs/ lib/ lib64/ parts/ sdist/ var/ *.egg-info/ .installed.cfg *.egg doc/_build # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ cover/ .coverage .cache nosetests.xml coverage.xml cover/ # Translations *.mo # Mr Developer .mr.developer.cfg .project .pydevproject # Rope .ropeproject # Django stuff: *.log *.pot # Sphinx documentation docs/_build/ doc/source/generated/ #mac .DS_Store *~ #pycharm .idea/* #Dolphin browser files .directory/ .directory #Binary data files *.volume *.am *.tiff *.tif *.dat *.DAT #generated documntation files doc/resource/api/generated/ # ipython caches .ipynb_checkpoints/ cycler-0.10.0/.travis.yml000066400000000000000000000004641266052550400151730ustar00rootroot00000000000000language: python matrix: include: - python: 2.7 - python: 3.4 - python: 3.5 - python: "nightly" env: PRE=--pre allow_failures: - python : "nightly" install: - python setup.py install - pip install coveralls six script: - python run_tests.py after_success: coveralls cycler-0.10.0/LICENSE000066400000000000000000000027311266052550400140660ustar00rootroot00000000000000Copyright (c) 2015, matplotlib project All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the matplotlib project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.cycler-0.10.0/MANIFEST.in000066400000000000000000000001701266052550400146120ustar00rootroot00000000000000include run_tests.py include LICENSE recursive-include conda-recipe * recursive-include doc Makefile make.bat *.rst *.pycycler-0.10.0/README.rst000066400000000000000000000001311266052550400145400ustar00rootroot00000000000000cycler: composable cycles ========================= Docs: http://matplotlib.org/cycler/ cycler-0.10.0/appveyor.yml000066400000000000000000000034631266052550400154540ustar00rootroot00000000000000# AppVeyor.com is a Continuous Integration service to build and run tests under # Windows environment: global: # SDK v7.0 MSVC Express 2008's SetEnv.cmd script will fail if the # /E:ON and /V:ON options are not enabled in the batch script intepreter # See: http://stackoverflow.com/a/13751649/163740 CMD_IN_ENV: "cmd /E:ON /V:ON /C .\\ci\\appveyor\\run_with_env.cmd" matrix: - PYTHON: "C:\\Python27_32" PYTHON_VERSION: "2.7" PYTHON_ARCH: "32" - PYTHON: "C:\\Python27_64" PYTHON_VERSION: "2.7" PYTHON_ARCH: "64" - PYTHON: "C:\\Python34_32" PYTHON_VERSION: "3.4.3" PYTHON_ARCH: "32" - PYTHON: "C:\\Python34_64" PYTHON_VERSION: "3.4.3" PYTHON_ARCH: "64" - PYTHON: "C:\\Python35" PYTHON_VERSION: "3.5.0" PYTHON_ARCH: "32" - PYTHON: "C:\\Python35-x64" PYTHON_VERSION: "3.5.0" PYTHON_ARCH: "64" install: # Install Python (from the official .msi of http://python.org) and pip when # not already installed. - "powershell ./ci/appveyor/install.ps1" - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%" # Check that we have the expected version and architecture for Python - "python --version" - "python -c \"import struct; print(struct.calcsize('P') * 8)\"" # Install the build and runtime dependencies of the project. - "%CMD_IN_ENV% pip install -v six nose coveralls" # Install the generated wheel package to test it - "python setup.py install" # Not a .NET project, we build scikit-image in the install step instead build: false test_script: # Run unit tests with nose - "python run_tests.py" artifacts: # Archive the generated wheel package in the ci.appveyor.com build report. - path: dist\* #on_success: # - TODO: upload the content of dist/*.whl to a public wheelhouse cycler-0.10.0/ci/000077500000000000000000000000001266052550400134515ustar00rootroot00000000000000cycler-0.10.0/ci/appveyor/000077500000000000000000000000001266052550400153165ustar00rootroot00000000000000cycler-0.10.0/ci/appveyor/install.ps1000066400000000000000000000135431266052550400174170ustar00rootroot00000000000000# Sample script to install Python and pip under Windows # Authors: Olivier Grisel, Jonathan Helmus and Kyle Kastner # License: CC0 1.0 Universal: http://creativecommons.org/publicdomain/zero/1.0/ $MINICONDA_URL = "http://repo.continuum.io/miniconda/" $BASE_URL = "https://www.python.org/ftp/python/" $GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py" $GET_PIP_PATH = "C:\get-pip.py" function DownloadPython ($python_version, $platform_suffix) { $webclient = New-Object System.Net.WebClient $filename = "python-" + $python_version + $platform_suffix + ".msi" $url = $BASE_URL + $python_version + "/" + $filename $basedir = $pwd.Path + "\" $filepath = $basedir + $filename if (Test-Path $filename) { Write-Host "Reusing" $filepath return $filepath } # Download and retry up to 3 times in case of network transient errors. Write-Host "Downloading" $filename "from" $url $retry_attempts = 2 for($i=0; $i -lt $retry_attempts; $i++){ try { $webclient.DownloadFile($url, $filepath) break } Catch [Exception]{ Start-Sleep 1 } } if (Test-Path $filepath) { Write-Host "File saved at" $filepath } else { # Retry once to get the error message if any at the last try $webclient.DownloadFile($url, $filepath) } return $filepath } function InstallPython ($python_version, $architecture, $python_home) { Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home if (Test-Path $python_home) { Write-Host $python_home "already exists, skipping." return $false } if ($architecture -eq "32") { $platform_suffix = "" } else { $platform_suffix = ".amd64" } $msipath = DownloadPython $python_version $platform_suffix Write-Host "Installing" $msipath "to" $python_home $install_log = $python_home + ".log" $install_args = "/qn /log $install_log /i $msipath TARGETDIR=$python_home" $uninstall_args = "/qn /x $msipath" RunCommand "msiexec.exe" $install_args if (-not(Test-Path $python_home)) { Write-Host "Python seems to be installed else-where, reinstalling." RunCommand "msiexec.exe" $uninstall_args RunCommand "msiexec.exe" $install_args } if (Test-Path $python_home) { Write-Host "Python $python_version ($architecture) installation complete" } else { Write-Host "Failed to install Python in $python_home" Get-Content -Path $install_log Exit 1 } } function RunCommand ($command, $command_args) { Write-Host $command $command_args Start-Process -FilePath $command -ArgumentList $command_args -Wait -Passthru } function InstallPip ($python_home) { $pip_path = $python_home + "\Scripts\pip.exe" $python_path = $python_home + "\python.exe" if (-not(Test-Path $pip_path)) { Write-Host "Installing pip..." $webclient = New-Object System.Net.WebClient $webclient.DownloadFile($GET_PIP_URL, $GET_PIP_PATH) Write-Host "Executing:" $python_path $GET_PIP_PATH Start-Process -FilePath "$python_path" -ArgumentList "$GET_PIP_PATH" -Wait -Passthru } else { Write-Host "pip already installed." } } function DownloadMiniconda ($python_version, $platform_suffix) { $webclient = New-Object System.Net.WebClient if ($python_version -eq "3.4") { $filename = "Miniconda3-3.5.5-Windows-" + $platform_suffix + ".exe" } else { $filename = "Miniconda-3.5.5-Windows-" + $platform_suffix + ".exe" } $url = $MINICONDA_URL + $filename $basedir = $pwd.Path + "\" $filepath = $basedir + $filename if (Test-Path $filename) { Write-Host "Reusing" $filepath return $filepath } # Download and retry up to 3 times in case of network transient errors. Write-Host "Downloading" $filename "from" $url $retry_attempts = 2 for($i=0; $i -lt $retry_attempts; $i++){ try { $webclient.DownloadFile($url, $filepath) break } Catch [Exception]{ Start-Sleep 1 } } if (Test-Path $filepath) { Write-Host "File saved at" $filepath } else { # Retry once to get the error message if any at the last try $webclient.DownloadFile($url, $filepath) } return $filepath } function InstallMiniconda ($python_version, $architecture, $python_home) { Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home if (Test-Path $python_home) { Write-Host $python_home "already exists, skipping." return $false } if ($architecture -eq "32") { $platform_suffix = "x86" } else { $platform_suffix = "x86_64" } $filepath = DownloadMiniconda $python_version $platform_suffix Write-Host "Installing" $filepath "to" $python_home $install_log = $python_home + ".log" $args = "/S /D=$python_home" Write-Host $filepath $args Start-Process -FilePath $filepath -ArgumentList $args -Wait -Passthru if (Test-Path $python_home) { Write-Host "Python $python_version ($architecture) installation complete" } else { Write-Host "Failed to install Python in $python_home" Get-Content -Path $install_log Exit 1 } } function InstallMinicondaPip ($python_home) { $pip_path = $python_home + "\Scripts\pip.exe" $conda_path = $python_home + "\Scripts\conda.exe" if (-not(Test-Path $pip_path)) { Write-Host "Installing pip..." $args = "install --yes pip" Write-Host $conda_path $args Start-Process -FilePath "$conda_path" -ArgumentList $args -Wait -Passthru } else { Write-Host "pip already installed." } } function main () { InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON InstallPip $env:PYTHON } main cycler-0.10.0/ci/appveyor/run_with_env.cmd000066400000000000000000000033721266052550400205170ustar00rootroot00000000000000:: To build extensions for 64 bit Python 3, we need to configure environment :: variables to use the MSVC 2010 C++ compilers from GRMSDKX_EN_DVD.iso of: :: MS Windows SDK for Windows 7 and .NET Framework 4 (SDK v7.1) :: :: To build extensions for 64 bit Python 2, we need to configure environment :: variables to use the MSVC 2008 C++ compilers from GRMSDKX_EN_DVD.iso of: :: MS Windows SDK for Windows 7 and .NET Framework 3.5 (SDK v7.0) :: :: 32 bit builds do not require specific environment configurations. :: :: Note: this script needs to be run with the /E:ON and /V:ON flags for the :: cmd interpreter, at least for (SDK v7.0) :: :: More details at: :: https://github.com/cython/cython/wiki/64BitCythonExtensionsOnWindows :: http://stackoverflow.com/a/13751649/163740 :: :: Author: Olivier Grisel :: License: BSD 3 clause @ECHO OFF SET COMMAND_TO_RUN=%* SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows SET MAJOR_PYTHON_VERSION="%PYTHON_VERSION:~0,1%" IF %MAJOR_PYTHON_VERSION% == "2" ( SET WINDOWS_SDK_VERSION="v7.0" ) ELSE IF %MAJOR_PYTHON_VERSION% == "3" ( SET WINDOWS_SDK_VERSION="v7.1" ) ELSE ( ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%" EXIT 1 ) IF "%PYTHON_ARCH%"=="64" ( ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture SET DISTUTILS_USE_SDK=1 SET MSSdk=1 "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION% "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release ECHO Executing: %COMMAND_TO_RUN% call %COMMAND_TO_RUN% || EXIT 1 ) ELSE ( ECHO Using default MSVC build environment for 32 bit architecture ECHO Executing: %COMMAND_TO_RUN% call %COMMAND_TO_RUN% || EXIT 1 ) cycler-0.10.0/conda-recipe/000077500000000000000000000000001266052550400154075ustar00rootroot00000000000000cycler-0.10.0/conda-recipe/bld.bat000066400000000000000000000003541266052550400166420ustar00rootroot00000000000000"%PYTHON%" setup.py install if errorlevel 1 exit 1 :: Add more build steps here, if they are necessary. :: See :: http://docs.continuum.io/conda/build.html :: for a list of environment variables that are set during the build process. cycler-0.10.0/conda-recipe/build.sh000066400000000000000000000003331266052550400170410ustar00rootroot00000000000000#!/bin/bash $PYTHON setup.py install # Add more build steps here, if they are necessary. # See # http://docs.continuum.io/conda/build.html # for a list of environment variables that are set during the build process. cycler-0.10.0/conda-recipe/meta.yaml000066400000000000000000000024671266052550400172320ustar00rootroot00000000000000package: name: cycler version: {{ environ['GIT_DESCRIBE_TAG'] }}.post{{ environ['GIT_DESCRIBE_NUMBER'] }} source: git_url: ../ # patches: # List any patch files here # - fix.patch build: string: {{ environ.get('GIT_BUILD_STR', '') }}_py{{ py }} # preserve_egg_dir: True # entry_points: # Put any entry points (scripts to be generated automatically) here. The # syntax is module:function. For example # # - cycler = cycler:main # # Would create an entry point called cycler that calls cycler.main() # If this is a new build for the same version, increment the build # number. If you do not include this key, it defaults to 0. # number: 1 requirements: build: - python - setuptools - six run: - python - six test: # Python imports imports: - cycler # commands: # You can put test commands to be run here. Use this to test that the # entry points work. # You can also put a file called run_test.py in the recipe that will be run # at test time. # requires: # Put any additional test requirements here. For example # - nose about: home: http://github.com/matplotlib/cycler license: BSD summary: 'Composable style cycles' # See # http://docs.continuum.io/conda/build.html for # more information about meta.yaml cycler-0.10.0/cycler.py000066400000000000000000000371271266052550400147230ustar00rootroot00000000000000""" Cycler ====== Cycling through combinations of values, producing dictionaries. You can add cyclers:: from cycler import cycler cc = (cycler(color=list('rgb')) + cycler(linestyle=['-', '--', '-.'])) for d in cc: print(d) Results in:: {'color': 'r', 'linestyle': '-'} {'color': 'g', 'linestyle': '--'} {'color': 'b', 'linestyle': '-.'} You can multiply cyclers:: from cycler import cycler cc = (cycler(color=list('rgb')) * cycler(linestyle=['-', '--', '-.'])) for d in cc: print(d) Results in:: {'color': 'r', 'linestyle': '-'} {'color': 'r', 'linestyle': '--'} {'color': 'r', 'linestyle': '-.'} {'color': 'g', 'linestyle': '-'} {'color': 'g', 'linestyle': '--'} {'color': 'g', 'linestyle': '-.'} {'color': 'b', 'linestyle': '-'} {'color': 'b', 'linestyle': '--'} {'color': 'b', 'linestyle': '-.'} """ from __future__ import (absolute_import, division, print_function, unicode_literals) import six from itertools import product, cycle from six.moves import zip, reduce from operator import mul, add import copy __version__ = '0.10.0' def _process_keys(left, right): """ Helper function to compose cycler keys Parameters ---------- left, right : iterable of dictionaries or None The cyclers to be composed Returns ------- keys : set The keys in the composition of the two cyclers """ l_peek = next(iter(left)) if left is not None else {} r_peek = next(iter(right)) if right is not None else {} l_key = set(l_peek.keys()) r_key = set(r_peek.keys()) if l_key & r_key: raise ValueError("Can not compose overlapping cycles") return l_key | r_key class Cycler(object): """ Composable cycles This class has compositions methods: ``+`` for 'inner' products (zip) ``+=`` in-place ``+`` ``*`` for outer products (itertools.product) and integer multiplication ``*=`` in-place ``*`` and supports basic slicing via ``[]`` Parameters ---------- left : Cycler or None The 'left' cycler right : Cycler or None The 'right' cycler op : func or None Function which composes the 'left' and 'right' cyclers. """ def __call__(self): return cycle(self) def __init__(self, left, right=None, op=None): """Semi-private init Do not use this directly, use `cycler` function instead. """ if isinstance(left, Cycler): self._left = Cycler(left._left, left._right, left._op) elif left is not None: # Need to copy the dictionary or else that will be a residual # mutable that could lead to strange errors self._left = [copy.copy(v) for v in left] else: self._left = None if isinstance(right, Cycler): self._right = Cycler(right._left, right._right, right._op) elif right is not None: # Need to copy the dictionary or else that will be a residual # mutable that could lead to strange errors self._right = [copy.copy(v) for v in right] else: self._right = None self._keys = _process_keys(self._left, self._right) self._op = op @property def keys(self): """ The keys this Cycler knows about """ return set(self._keys) def change_key(self, old, new): """ Change a key in this cycler to a new name. Modification is performed in-place. Does nothing if the old key is the same as the new key. Raises a ValueError if the new key is already a key. Raises a KeyError if the old key isn't a key. """ if old == new: return if new in self._keys: raise ValueError("Can't replace %s with %s, %s is already a key" % (old, new, new)) if old not in self._keys: raise KeyError("Can't replace %s with %s, %s is not a key" % (old, new, old)) self._keys.remove(old) self._keys.add(new) if self._right is not None and old in self._right.keys: self._right.change_key(old, new) # self._left should always be non-None # if self._keys is non-empty. elif isinstance(self._left, Cycler): self._left.change_key(old, new) else: # It should be completely safe at this point to # assume that the old key can be found in each # iteration. self._left = [{new: entry[old]} for entry in self._left] def _compose(self): """ Compose the 'left' and 'right' components of this cycle with the proper operation (zip or product as of now) """ for a, b in self._op(self._left, self._right): out = dict() out.update(a) out.update(b) yield out @classmethod def _from_iter(cls, label, itr): """ Class method to create 'base' Cycler objects that do not have a 'right' or 'op' and for which the 'left' object is not another Cycler. Parameters ---------- label : str The property key. itr : iterable Finite length iterable of the property values. Returns ------- cycler : Cycler New 'base' `Cycler` """ ret = cls(None) ret._left = list({label: v} for v in itr) ret._keys = set([label]) return ret def __getitem__(self, key): # TODO : maybe add numpy style fancy slicing if isinstance(key, slice): trans = self.by_key() return reduce(add, (_cycler(k, v[key]) for k, v in six.iteritems(trans))) else: raise ValueError("Can only use slices with Cycler.__getitem__") def __iter__(self): if self._right is None: return iter(dict(l) for l in self._left) return self._compose() def __add__(self, other): """ Pair-wise combine two equal length cycles (zip) Parameters ---------- other : Cycler The second Cycler """ if len(self) != len(other): raise ValueError("Can only add equal length cycles, " "not {0} and {1}".format(len(self), len(other))) return Cycler(self, other, zip) def __mul__(self, other): """ Outer product of two cycles (`itertools.product`) or integer multiplication. Parameters ---------- other : Cycler or int The second Cycler or integer """ if isinstance(other, Cycler): return Cycler(self, other, product) elif isinstance(other, int): trans = self.by_key() return reduce(add, (_cycler(k, v*other) for k, v in six.iteritems(trans))) else: return NotImplemented def __rmul__(self, other): return self * other def __len__(self): op_dict = {zip: min, product: mul} if self._right is None: return len(self._left) l_len = len(self._left) r_len = len(self._right) return op_dict[self._op](l_len, r_len) def __iadd__(self, other): """ In-place pair-wise combine two equal length cycles (zip) Parameters ---------- other : Cycler The second Cycler """ if not isinstance(other, Cycler): raise TypeError("Cannot += with a non-Cycler object") # True shallow copy of self is fine since this is in-place old_self = copy.copy(self) self._keys = _process_keys(old_self, other) self._left = old_self self._op = zip self._right = Cycler(other._left, other._right, other._op) return self def __imul__(self, other): """ In-place outer product of two cycles (`itertools.product`) Parameters ---------- other : Cycler The second Cycler """ if not isinstance(other, Cycler): raise TypeError("Cannot *= with a non-Cycler object") # True shallow copy of self is fine since this is in-place old_self = copy.copy(self) self._keys = _process_keys(old_self, other) self._left = old_self self._op = product self._right = Cycler(other._left, other._right, other._op) return self def __eq__(self, other): """ Check equality """ if len(self) != len(other): return False if self.keys ^ other.keys: return False return all(a == b for a, b in zip(self, other)) def __repr__(self): op_map = {zip: '+', product: '*'} if self._right is None: lab = self.keys.pop() itr = list(v[lab] for v in self) return "cycler({lab!r}, {itr!r})".format(lab=lab, itr=itr) else: op = op_map.get(self._op, '?') msg = "({left!r} {op} {right!r})" return msg.format(left=self._left, op=op, right=self._right) def _repr_html_(self): # an table showing the value of each key through a full cycle output = "" sorted_keys = sorted(self.keys, key=repr) for key in sorted_keys: output += "".format(key=key) for d in iter(self): output += "" for k in sorted_keys: output += "".format(val=d[k]) output += "" output += "
{key!r}
{val!r}
" return output 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 ------- 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 # and if we care. keys = self.keys # change this to dict comprehension when drop 2.6 out = dict((k, list()) for k in keys) for d in self: for k in keys: out[k].append(d[k]) return out # for back compatibility _transpose = by_key def simplify(self): """Simplify the Cycler Returned as a composition using only sums (no multiplications) Returns ------- simple : Cycler An equivalent cycler using only summation""" # TODO: sort out if it is worth the effort to make sure this is # balanced. Currently it is is # (((a + b) + c) + d) vs # ((a + b) + (c + d)) # I would believe that there is some performance implications trans = self.by_key() return reduce(add, (_cycler(k, v) for k, v in six.iteritems(trans))) def concat(self, other): """Concatenate this cycler and an other. The keys must match exactly. This returns a single Cycler which is equivalent to `itertools.chain(self, other)` Examples -------- >>> num = cycler('a', range(3)) >>> let = cycler('a', 'abc') >>> num.concat(let) cycler('a', [0, 1, 2, 'a', 'b', 'c']) Parameters ---------- other : `Cycler` The `Cycler` to concatenate to this one. Returns ------- ret : `Cycler` The concatenated `Cycler` """ return concat(self, other) def concat(left, right): """Concatenate two cyclers. The keys must match exactly. This returns a single Cycler which is equivalent to `itertools.chain(left, right)` Examples -------- >>> num = cycler('a', range(3)) >>> let = cycler('a', 'abc') >>> num.concat(let) cycler('a', [0, 1, 2, 'a', 'b', 'c']) Parameters ---------- left, right : `Cycler` The two `Cycler` instances to concatenate Returns ------- ret : `Cycler` The concatenated `Cycler` """ if left.keys != right.keys: msg = '\n\t'.join(["Keys do not match:", "Intersection: {both!r}", "Disjoint: {just_one!r}"]).format( both=left.keys & right.keys, just_one=left.keys ^ right.keys) raise ValueError(msg) _l = left.by_key() _r = right.by_key() return reduce(add, (_cycler(k, _l[k] + _r[k]) for k in left.keys)) def cycler(*args, **kwargs): """ Create a new `Cycler` object from a single positional argument, a pair of positional arguments, or the combination of keyword arguments. cycler(arg) cycler(label1=itr1[, label2=iter2[, ...]]) cycler(label, itr) Form 1 simply copies a given `Cycler` object. Form 2 composes a `Cycler` as an inner product of the pairs of keyword arguments. In other words, all of the iterables are cycled simultaneously, as if through zip(). Form 3 creates a `Cycler` from a label and an iterable. This is useful for when the label cannot be a keyword argument (e.g., an integer or a name that has a space in it). Parameters ---------- arg : Cycler Copy constructor for Cycler (does a shallow copy of iterables). label : name The property key. In the 2-arg form of the function, the label can be any hashable object. In the keyword argument form of the function, it must be a valid python identifier. itr : iterable Finite length iterable of the property values. Can be a single-property `Cycler` that would be like a key change, but as a shallow copy. Returns ------- cycler : Cycler New `Cycler` for the given property """ if args and kwargs: raise TypeError("cyl() can only accept positional OR keyword " "arguments -- not both.") if len(args) == 1: if not isinstance(args[0], Cycler): raise TypeError("If only one positional argument given, it must " " be a Cycler instance.") return Cycler(args[0]) elif len(args) == 2: return _cycler(*args) elif len(args) > 2: raise TypeError("Only a single Cycler can be accepted as the lone " "positional argument. Use keyword arguments instead.") if kwargs: return reduce(add, (_cycler(k, v) for k, v in six.iteritems(kwargs))) raise TypeError("Must have at least a positional OR keyword arguments") def _cycler(label, itr): """ Create a new `Cycler` object from a property name and iterable of values. Parameters ---------- label : hashable The property key. itr : iterable Finite length iterable of the property values. Returns ------- cycler : Cycler New `Cycler` for the given property """ if isinstance(itr, Cycler): keys = itr.keys if len(keys) != 1: msg = "Can not create Cycler from a multi-property Cycler" raise ValueError(msg) lab = keys.pop() # Doesn't need to be a new list because # _from_iter() will be creating that new list anyway. itr = (v[lab] for v in itr) return Cycler._from_iter(label, itr) cycler-0.10.0/doc/000077500000000000000000000000001266052550400136235ustar00rootroot00000000000000cycler-0.10.0/doc/Makefile000066400000000000000000000151631266052550400152710ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cycler.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cycler.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/cycler" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cycler" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." cycler-0.10.0/doc/_templates/000077500000000000000000000000001266052550400157605ustar00rootroot00000000000000cycler-0.10.0/doc/_templates/autosummary/000077500000000000000000000000001266052550400203465ustar00rootroot00000000000000cycler-0.10.0/doc/_templates/autosummary/class.rst000066400000000000000000000015411266052550400222060ustar00rootroot00000000000000{% extends "!autosummary/class.rst" %} {% block methods %} {% if methods %} .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: {% for item in all_methods %} {%- if not item.startswith('_') or item in ['__call__'] %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %} {% endif %} {% endblock %} {% block attributes %} {% if attributes %} .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: {% for item in all_attributes %} {%- if not item.startswith('_') %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %} {% endif %} {% endblock %} cycler-0.10.0/doc/make.bat000066400000000000000000000150661266052550400152400ustar00rootroot00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source set I18NSPHINXOPTS=%SPHINXOPTS% source if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\cycler.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cycler.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end cycler-0.10.0/doc/source/000077500000000000000000000000001266052550400151235ustar00rootroot00000000000000cycler-0.10.0/doc/source/conf.py000066400000000000000000000212621266052550400164250ustar00rootroot00000000000000#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # cycler documentation build configuration file, created by # sphinx-quickstart on Wed Jul 1 13:32:53 2015. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'matplotlib.sphinxext.only_directives', 'matplotlib.sphinxext.plot_directive', 'IPython.sphinxext.ipython_directive', 'IPython.sphinxext.ipython_console_highlighting', 'numpydoc', ] autosummary_generate = True numpydoc_show_class_members = False autodoc_default_flags = ['members'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'cycler' copyright = '2015, Matplotlib Developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '0.10.0' # The full version, including alpha/beta/rc tags. release = '0.10.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. default_role = 'obj' # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'basic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'cyclerdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'cycler.tex', 'cycler Documentation', 'Matplotlib Developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'cycler', 'cycler Documentation', ['Matplotlib Developers'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'cycler', 'cycler Documentation', 'Matplotlib Developers', 'cycler', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None), 'matplotlb': ('http://matplotlib.org', None)} ################# numpydoc config #################### numpydoc_show_class_members = False cycler-0.10.0/doc/source/index.rst000066400000000000000000000207121266052550400167660ustar00rootroot00000000000000.. currentmodule:: cycler =================== Composable cycles =================== .. htmlonly:: :Version: |version| :Date: |today| ====== ==================================== docs http://matplotlib.org/cycler pypi https://pypi.python.org/pypi/Cycler github https://github.com/matplotlib/cycler ====== ==================================== :py:mod:`cycler` API ==================== .. autosummary:: :toctree: generated/ cycler Cycler The public API of :py:mod:`cycler` consists of a class `Cycler` and a factory function :func:`cycler`. The function provides a simple interface for creating 'base' `Cycler` objects while the class takes care of the composition and iteration logic. `Cycler` Usage ============== Base ---- A single entry `Cycler` object can be used to easily cycle over a single style. To create the `Cycler` use the :py:func:`cycler` function to link a key/style/kwarg to series of values. The key must be hashable (as it will eventually be used as the key in a :obj:`dict`). .. ipython:: python from __future__ import print_function from cycler import cycler color_cycle = cycler(color=['r', 'g', 'b']) color_cycle The `Cycler` knows it's length and keys: .. ipython:: python len(color_cycle) color_cycle.keys Iterating over this object will yield a series of :obj:`dict` objects keyed on the label .. ipython:: python for v in color_cycle: print(v) `Cycler` objects can be passed as the argument to :func:`cycler` which returns a new `Cycler` with a new label, but the same values. .. ipython:: python cycler(ec=color_cycle) Iterating over a `Cycler` results in the finite list of entries, to get an infinite cycle, call the `Cycler` object (a-la a generator) .. ipython:: python cc = color_cycle() for j, c in zip(range(5), cc): print(j, c) Composition ----------- A single `Cycler` can just as easily be replaced by a single ``for`` loop. The power of `Cycler` objects is that they can be composed to easily create complex multi-key cycles. Addition ~~~~~~~~ Equal length `Cycler` s with different keys can be added to get the 'inner' product of two cycles .. ipython:: python lw_cycle = cycler(lw=range(1, 4)) wc = lw_cycle + color_cycle The result has the same length and has keys which are the union of the two input `Cycler`'s. .. ipython:: python len(wc) wc.keys and iterating over the result is the zip of the two input cycles .. ipython:: python for s in wc: print(s) As with arithmetic, addition is commutative .. ipython:: python lw_c = lw_cycle + color_cycle c_lw = color_cycle + lw_cycle for j, (a, b) in enumerate(zip(lw_c, c_lw)): print('({j}) A: {A!r} B: {B!r}'.format(j=j, A=a, B=b)) For convenience, the :func:`cycler` function can have multiple key-value pairs and will automatically compose them into a single `Cycler` via addition .. ipython:: python wc = cycler(c=['r', 'g', 'b'], lw=range(3)) for s in wc: print(s) Multiplication ~~~~~~~~~~~~~~ Any pair of `Cycler` can be multiplied .. ipython:: python m_cycle = cycler(marker=['s', 'o']) m_c = m_cycle * color_cycle which gives the 'outer product' of the two cycles (same as :func:`itertools.prod` ) .. ipython:: python len(m_c) m_c.keys for s in m_c: print(s) Note that unlike addition, multiplication is not commutative (like matrices) .. ipython:: python c_m = color_cycle * m_cycle for j, (a, b) in enumerate(zip(c_m, m_c)): print('({j}) A: {A!r} B: {B!r}'.format(j=j, A=a, B=b)) Integer Multiplication ~~~~~~~~~~~~~~~~~~~~~~ `Cycler` s can also be multiplied by integer values to increase the length. .. ipython:: python color_cycle * 2 2 * color_cycle Concatenation ~~~~~~~~~~~~~ `Cycler` objects can be concatenated either via the :py:meth:`Cycler.concat` method .. ipython:: python color_cycle.concat(color_cycle) or the top-level :py:func:`concat` function .. ipython:: python from cycler import concat concat(color_cycle, color_cycle) Slicing ------- Cycles can be sliced with :obj:`slice` objects .. ipython:: python color_cycle[::-1] color_cycle[:2] color_cycle[1:] 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 -------- We can use `Cycler` instances to cycle over one or more ``kwarg`` to `~matplotlib.axes.Axes.plot` : .. plot:: :include-source: from cycler import cycler from itertools import cycle fig, (ax1, ax2) = plt.subplots(1, 2, tight_layout=True, figsize=(8, 4)) x = np.arange(10) color_cycle = cycler(c=['r', 'g', 'b']) for i, sty in enumerate(color_cycle): ax1.plot(x, x*(i+1), **sty) for i, sty in zip(range(1, 5), cycle(color_cycle)): ax2.plot(x, x*i, **sty) .. plot:: :include-source: from cycler import cycler from itertools import cycle fig, (ax1, ax2) = plt.subplots(1, 2, tight_layout=True, figsize=(8, 4)) x = np.arange(10) color_cycle = cycler(c=['r', 'g', 'b']) ls_cycle = cycler('ls', ['-', '--']) lw_cycle = cycler('lw', range(1, 4)) sty_cycle = ls_cycle * (color_cycle + lw_cycle) for i, sty in enumerate(sty_cycle): ax1.plot(x, x*(i+1), **sty) sty_cycle = (color_cycle + lw_cycle) * ls_cycle for i, sty in enumerate(sty_cycle): ax2.plot(x, x*(i+1), **sty) Persistent Cycles ----------------- It can be useful to associate a given label with a style via dictionary lookup and to dynamically generate that mapping. This can easily be accomplished using a `~collections.defaultdict` .. ipython:: python from cycler import cycler as cy from collections import defaultdict cyl = cy('c', 'rgb') + cy('lw', range(1, 4)) To get a finite set of styles .. ipython:: python finite_cy_iter = iter(cyl) dd_finite = defaultdict(lambda : next(finite_cy_iter)) or repeating .. ipython:: python loop_cy_iter = cyl() dd_loop = defaultdict(lambda : next(loop_cy_iter)) This can be helpful when plotting complex data which has both a classification and a label :: finite_cy_iter = iter(cyl) styles = defaultdict(lambda : next(finite_cy_iter)) for group, label, data in DataSet: ax.plot(data, label=label, **styles[group]) which will result in every ``data`` with the same ``group`` being plotted with the same style. Exceptions ---------- A :obj:`ValueError` is raised if unequal length `Cycler` s are added together .. ipython:: python :okexcept: cycler(c=['r', 'g', 'b']) + cycler(ls=['-', '--']) or if two cycles which have overlapping keys are composed .. ipython:: python :okexcept: color_cycle = cycler(c=['r', 'g', 'b']) color_cycle + color_cycle Motivation ========== When plotting more than one line it is common to want to be able to cycle over one or more artist styles. For simple cases than can be done with out too much trouble: .. plot:: :include-source: fig, ax = plt.subplots(tight_layout=True) x = np.linspace(0, 2*np.pi, 1024) for i, (lw, c) in enumerate(zip(range(4), ['r', 'g', 'b', 'k'])): ax.plot(x, np.sin(x - i * np.pi / 4), label=r'$\phi = {{{0}}} \pi / 4$'.format(i), lw=lw + 1, c=c) ax.set_xlim([0, 2*np.pi]) ax.set_title(r'$y=\sin(\theta + \phi)$') ax.set_ylabel(r'[arb]') ax.set_xlabel(r'$\theta$ [rad]') ax.legend(loc=0) However, if you want to do something more complicated: .. plot:: :include-source: fig, ax = plt.subplots(tight_layout=True) x = np.linspace(0, 2*np.pi, 1024) for i, (lw, c) in enumerate(zip(range(4), ['r', 'g', 'b', 'k'])): if i % 2: ls = '-' else: ls = '--' ax.plot(x, np.sin(x - i * np.pi / 4), label=r'$\phi = {{{0}}} \pi / 4$'.format(i), lw=lw + 1, c=c, ls=ls) ax.set_xlim([0, 2*np.pi]) ax.set_title(r'$y=\sin(\theta + \phi)$') ax.set_ylabel(r'[arb]') ax.set_xlabel(r'$\theta$ [rad]') ax.legend(loc=0) the plotting logic can quickly become very involved. To address this and allow easy cycling over arbitrary ``kwargs`` the `Cycler` class, a composable kwarg iterator, was developed. cycler-0.10.0/run_tests.py000066400000000000000000000011071266052550400154550ustar00rootroot00000000000000#!/usr/bin/env python # This file is closely based on tests.py from matplotlib # # This allows running the matplotlib tests from the command line: e.g. # # $ python run_tests.py -v -d # # The arguments are identical to the arguments accepted by nosetests. # # See https://nose.readthedocs.org/ for a detailed description of # these options. import nose env = {"NOSE_WITH_COVERAGE": 1, 'NOSE_COVER_PACKAGE': ['cycler'], 'NOSE_COVER_HTML': 1} plugins = [] def run(): nose.main(addplugins=[x() for x in plugins], env=env) if __name__ == '__main__': run() cycler-0.10.0/setup.py000066400000000000000000000016341266052550400145740ustar00rootroot00000000000000from setuptools import setup setup(name='cycler', version='0.10.0', author='Thomas A Caswell', author_email='matplotlib-users@python.org', py_modules=['cycler'], description='Composable style cycles', url='http://github.com/matplotlib/cycler', platforms='Cross platform (Linux, Mac OSX, Windows)', install_requires=['six'], license="BSD", classifiers=['Development Status :: 4 - Beta', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', ], keywords='cycle kwargs', ) cycler-0.10.0/test_cycler.py000066400000000000000000000235621266052550400157600ustar00rootroot00000000000000from __future__ import (absolute_import, division, print_function) import six from six.moves import zip, range from cycler import cycler, Cycler, concat from nose.tools import (assert_equal, assert_not_equal, assert_raises, assert_true) from itertools import product, cycle, chain from operator import add, iadd, mul, imul from collections import defaultdict def _cycler_helper(c, length, keys, values): assert_equal(len(c), length) assert_equal(len(c), len(list(c))) assert_equal(c.keys, set(keys)) for k, vals in zip(keys, values): for v, v_target in zip(c, vals): assert_equal(v[k], v_target) def _cycles_equal(c1, c2): assert_equal(list(c1), list(c2)) def test_creation(): c = cycler(c='rgb') yield _cycler_helper, c, 3, ['c'], [['r', 'g', 'b']] c = cycler(c=list('rgb')) yield _cycler_helper, c, 3, ['c'], [['r', 'g', 'b']] c = cycler(cycler(c='rgb')) yield _cycler_helper, c, 3, ['c'], [['r', 'g', 'b']] def test_compose(): c1 = cycler(c='rgb') c2 = cycler(lw=range(3)) c3 = cycler(lw=range(15)) # addition yield _cycler_helper, c1+c2, 3, ['c', 'lw'], [list('rgb'), range(3)] yield _cycler_helper, c2+c1, 3, ['c', 'lw'], [list('rgb'), range(3)] yield _cycles_equal, c2+c1, c1+c2 # miss-matched add lengths assert_raises(ValueError, add, c1, c3) assert_raises(ValueError, add, c3, c1) # multiplication target = zip(*product(list('rgb'), range(3))) yield (_cycler_helper, c1 * c2, 9, ['c', 'lw'], target) target = zip(*product(range(3), list('rgb'))) yield (_cycler_helper, c2 * c1, 9, ['lw', 'c'], target) target = zip(*product(range(15), list('rgb'))) yield (_cycler_helper, c3 * c1, 45, ['lw', 'c'], target) def test_inplace(): c1 = cycler(c='rgb') c2 = cycler(lw=range(3)) c2 += c1 yield _cycler_helper, c2, 3, ['c', 'lw'], [list('rgb'), range(3)] c3 = cycler(c='rgb') c4 = cycler(lw=range(3)) c3 *= c4 target = zip(*product(list('rgb'), range(3))) yield (_cycler_helper, c3, 9, ['c', 'lw'], target) def test_constructor(): c1 = cycler(c='rgb') c2 = cycler(ec=c1) yield _cycler_helper, c1+c2, 3, ['c', 'ec'], [['r', 'g', 'b']]*2 c3 = cycler(c=c1) yield _cycler_helper, c3+c2, 3, ['c', 'ec'], [['r', 'g', 'b']]*2 # Using a non-string hashable c4 = cycler(1, range(3)) yield _cycler_helper, c4+c1, 3, [1, 'c'], [range(3), ['r', 'g', 'b']] # addition using cycler() yield (_cycler_helper, cycler(c='rgb', lw=range(3)), 3, ['c', 'lw'], [list('rgb'), range(3)]) yield (_cycler_helper, cycler(lw=range(3), c='rgb'), 3, ['c', 'lw'], [list('rgb'), range(3)]) # Purposely mixing them yield (_cycler_helper, cycler(c=range(3), lw=c1), 3, ['c', 'lw'], [range(3), list('rgb')]) def test_failures(): c1 = cycler(c='rgb') c2 = cycler(c=c1) assert_raises(ValueError, add, c1, c2) assert_raises(ValueError, iadd, c1, c2) assert_raises(ValueError, mul, c1, c2) assert_raises(ValueError, imul, c1, c2) assert_raises(TypeError, iadd, c2, 'aardvark') assert_raises(TypeError, imul, c2, 'aardvark') c3 = cycler(ec=c1) assert_raises(ValueError, cycler, c=c2+c3) def test_simplify(): c1 = cycler(c='rgb') c2 = cycler(ec=c1) for c in [c1 * c2, c2 * c1, c1 + c2]: yield _cycles_equal, c, c.simplify() def test_multiply(): c1 = cycler(c='rgb') yield _cycler_helper, 2*c1, 6, ['c'], ['rgb'*2] c2 = cycler(ec=c1) c3 = c1 * c2 yield _cycles_equal, 2*c3, c3*2 def test_mul_fails(): c1 = cycler(c='rgb') assert_raises(TypeError, mul, c1, 2.0) assert_raises(TypeError, mul, c1, 'a') assert_raises(TypeError, mul, c1, []) def test_getitem(): c1 = cycler(3, range(15)) widths = list(range(15)) for slc in (slice(None, None, None), slice(None, None, -1), slice(1, 5, None), slice(0, 5, 2)): yield _cycles_equal, c1[slc], cycler(3, widths[slc]) def test_fail_getime(): c1 = cycler(lw=range(15)) assert_raises(ValueError, Cycler.__getitem__, c1, 0) assert_raises(ValueError, Cycler.__getitem__, c1, [0, 1]) def _repr_tester_helper(rpr_func, cyc, target_repr): test_repr = getattr(cyc, rpr_func)() assert_equal(six.text_type(test_repr), six.text_type(target_repr)) def test_repr(): c = cycler(c='rgb') # Using an identifier that would be not valid as a kwarg c2 = cycler('3rd', range(3)) c_sum_rpr = "(cycler('c', ['r', 'g', 'b']) + cycler('3rd', [0, 1, 2]))" c_prod_rpr = "(cycler('c', ['r', 'g', 'b']) * cycler('3rd', [0, 1, 2]))" yield _repr_tester_helper, '__repr__', c + c2, c_sum_rpr yield _repr_tester_helper, '__repr__', c * c2, c_prod_rpr sum_html = "
'3rd''c'
0'r'
1'g'
2'b'
" prod_html = "
'3rd''c'
0'r'
1'r'
2'r'
0'g'
1'g'
2'g'
0'b'
1'b'
2'b'
" yield _repr_tester_helper, '_repr_html_', c + c2, sum_html yield _repr_tester_helper, '_repr_html_', c * c2, prod_html def test_call(): c = cycler(c='rgb') c_cycle = c() assert_true(isinstance(c_cycle, cycle)) j = 0 for a, b in zip(2*c, c_cycle): j += 1 assert_equal(a, b) assert_equal(j, len(c) * 2) def test_copying(): # Just about everything results in copying the cycler and # its contents (shallow). This set of tests is intended to make sure # of that. Our iterables will be mutable for extra fun! i1 = [1, 2, 3] i2 = ['r', 'g', 'b'] # For more mutation fun! i3 = [['y', 'g'], ['b', 'k']] c1 = cycler('c', i1) c2 = cycler('lw', i2) c3 = cycler('foo', i3) c_before = (c1 + c2) * c3 i1.pop() i2.append('cyan') i3[0].append('blue') c_after = (c1 + c2) * c3 assert_equal(c1, cycler('c', [1, 2, 3])) assert_equal(c2, cycler('lw', ['r', 'g', 'b'])) assert_equal(c3, cycler('foo', [['y', 'g', 'blue'], ['b', 'k']])) assert_equal(c_before, (cycler(c=[1, 2, 3], lw=['r', 'g', 'b']) * cycler('foo', [['y', 'g', 'blue'], ['b', 'k']]))) assert_equal(c_after, (cycler(c=[1, 2, 3], lw=['r', 'g', 'b']) * cycler('foo', [['y', 'g', 'blue'], ['b', 'k']]))) # Make sure that changing the key for a specific cycler # doesn't break things for a composed cycler c = (c1 + c2) * c3 c4 = cycler('bar', c3) assert_equal(c, (cycler(c=[1, 2, 3], lw=['r', 'g', 'b']) * cycler('foo', [['y', 'g', 'blue'], ['b', 'k']]))) assert_equal(c3, cycler('foo', [['y', 'g', 'blue'], ['b', 'k']])) def test_keychange(): c1 = cycler('c', 'rgb') c2 = cycler('lw', [1, 2, 3]) c3 = cycler('ec', 'yk') c3.change_key('ec', 'edgecolor') assert_equal(c3, cycler('edgecolor', c3)) c = c1 + c2 c.change_key('lw', 'linewidth') # Changing a key in one cycler should have no # impact in the original cycler. assert_equal(c2, cycler('lw', [1, 2, 3])) assert_equal(c, c1 + cycler('linewidth', c2)) c = (c1 + c2) * c3 c.change_key('c', 'color') assert_equal(c1, cycler('c', 'rgb')) assert_equal(c, (cycler('color', c1) + c2) * c3) # Perfectly fine, it is a no-op c.change_key('color', 'color') assert_equal(c, (cycler('color', c1) + c2) * c3) # Can't change a key to one that is already in there assert_raises(ValueError, Cycler.change_key, c, 'color', 'lw') # Can't change a key you don't have assert_raises(KeyError, Cycler.change_key, c, 'c', 'foobar') def _eq_test_helper(a, b, res): if res: assert_equal(a, b) else: assert_not_equal(a, b) def test_eq(): a = cycler(c='rgb') b = cycler(c='rgb') yield _eq_test_helper, a, b, True yield _eq_test_helper, a, b[::-1], False c = cycler(lw=range(3)) yield _eq_test_helper, a+c, c+a, True yield _eq_test_helper, a+c, c+b, True yield _eq_test_helper, a*c, c*a, False yield _eq_test_helper, a, c, False d = cycler(c='ymk') yield _eq_test_helper, b, d, False e = cycler(c='orange') yield _eq_test_helper, b, e, False def test_cycler_exceptions(): assert_raises(TypeError, cycler) assert_raises(TypeError, cycler, 'c', 'rgb', lw=range(3)) assert_raises(TypeError, cycler, 'c') assert_raises(TypeError, cycler, 'c', 'rgb', 'lw', range(3)) def test_starange_init(): c = cycler('r', 'rgb') c2 = cycler('lw', range(3)) cy = Cycler(list(c), list(c2), zip) assert_equal(cy, c + c2) def test_concat(): a = cycler('a', range(3)) b = cycler('a', 'abc') for con, chn in zip(a.concat(b), chain(a, b)): assert_equal(con, chn) for con, chn in zip(concat(a, b), chain(a, b)): assert_equal(con, chn) def test_concat_fail(): a = cycler('a', range(3)) b = cycler('b', range(3)) assert_raises(ValueError, concat, a, b) assert_raises(ValueError, a.concat, b) def _by_key_helper(cy): res = cy.by_key() target = defaultdict(list) for sty in cy: for k, v in sty.items(): target[k].append(v) assert_equal(res, target) def test_by_key_add(): input_dict = dict(c=list('rgb'), lw=[1, 2, 3]) cy = cycler(c=input_dict['c']) + cycler(lw=input_dict['lw']) res = cy.by_key() assert_equal(res, input_dict) yield _by_key_helper, cy def test_by_key_mul(): input_dict = dict(c=list('rg'), lw=[1, 2, 3]) cy = cycler(c=input_dict['c']) * cycler(lw=input_dict['lw']) res = cy.by_key() assert_equal(input_dict['lw'] * len(input_dict['c']), res['lw']) yield _by_key_helper, cy