diff --git a/.cirrus.yml b/.cirrus.yml new file mode 100644 index 0000000..2616d5f --- /dev/null +++ b/.cirrus.yml @@ -0,0 +1,101 @@ +# Reference: +# - https://cirrus-ci.org/guide/writing-tasks/ +# - https://cirrus-ci.org/guide/linux/ +# - https://hub.docker.com/_/gcc/ +# - https://hub.docker.com/_/python/ + +# +# Global defaults. +# +container: + image: python:latest + cpu: 2 + memory: 4G + + +env: + # Maximum cache period (in weeks) before forcing a new cache upload. + CACHE_PERIOD: "2" + # Increment the build number to force new mambaforge cache upload. + MAMBA_CACHE_BUILD: "0" + # Increment the build number to force new mint cache upload. + NCTA_CACHE_BUILD: "0" + # Base environment conda packages to be installed + MAMBA_CACHE_PACKAGES: "pip conda-lock" + # Increment the build number to forve new pip cache upload. + PIP_CACHE_BUILD: "0" + # Linting packages to be installed. + PIP_CACHE_PACKAGES: "black flake8 isort" + + +# +# Linting +# +lint_task: + auto_cancellation: true + name: "${CIRRUS_OS}: linting" + pip_cache: + folder: ~/.cache/pip + fingerprint_script: + - echo "${CIRRUS_TASK_NAME} py${PYTHON_VERSION}" + - echo "$(date +%Y).$(expr $(date +%U) / ${CACHE_PERIOD}):${PIP_CACHE_BUILD} ${PIP_CACHE_PACKAGES}" + lint_script: + - pip list + - python -m pip install --retries 3 --upgrade ${PIP_CACHE_PACKAGES} + - pip list + - black --check ${CIRRUS_WORKING_DIR} + - flake8 ${CIRRUS_WORKING_DIR} + - isort --check ${CIRRUS_WORKING_DIR} + + +# +# Testing (Linux) +# +linux_task: + auto_cancellation: true + matrix: + env: + PY_VER: "3.7" + env: + PY_VER: "3.8" + env: + PY_VER: "3.9" + COVERAGE: "codecov" + name: "${CIRRUS_OS}: py${PY_VER}" + container: + image: gcc:latest + env: + PATH: ${HOME}/mambaforge/bin:${PATH} + mamba_cache: + folder: ${HOME}/mambaforge + fingerprint_script: + - wget --quiet https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Linux-x86_64.sh -O mambaforge.sh + - echo "${CIRRUS_OS} $(sha256sum mambaforge.sh)" + - echo "${MAMBA_CACHE_PACKAGES}" + - echo "$(date +%Y).$(expr $(date +%U) / ${CACHE_PERIOD}):${MAMBA_CACHE_BUILD}" + populate_script: + - bash mambaforge.sh -b -p ${HOME}/mambaforge + - conda config --set always_yes yes --set changeps1 no + - conda config --set show_channel_urls True + - conda config --add channels conda-forge + - conda install --quiet --name base ${MAMBA_CACHE_PACKAGES} + check_script: + - conda info --all + - conda list --name base + ncta_cache: + folder: ${HOME}/mambaforge/envs/py${PY_VER} + fingerprint_script: + - echo "${CIRRUS_OS} py${PY_VER} tests" + - echo "$(date +%Y).$(expr $(date +%U) / ${CACHE_PERIOD}):${NCTA_CACHE_BUILD}" + - cat ${CIRRUS_WORKING_DIR}/requirements/py$(echo ${PY_VER} | tr -d ".").yml + populate_script: + - conda-lock --mamba --platform linux-64 --file ${CIRRUS_WORKING_DIR}/requirements/py$(echo ${PY_VER} | tr -d ".").yml + - mamba create --name py${PY_VER} --quiet --file conda-linux-64.lock + - cp conda-linux-64.lock ${HOME}/mambaforge/envs/py${PY_VER} + test_script: + - cat ${HOME}/mambaforge/envs/py${PY_VER}/conda-linux-64.lock >&2 + - source ${HOME}/mambaforge/etc/profile.d/conda.sh >/dev/null 2>&1 + - conda activate py${PY_VER} >/dev/null 2>&1 + - pip install --no-deps --editable . + - pytest --cov-report=xml --cov + - ${COVERAGE} diff --git a/.coveragerc b/.coveragerc index 2e69d9c..b5412bb 100644 --- a/.coveragerc +++ b/.coveragerc @@ -3,12 +3,12 @@ # [run] -source = nc_time_axis branch = True +source = nc_time_axis omit = nc_time_axis/_version.py nc_time_axis/tests/* - + setup.py [report] exclude_lines = diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..d8ba528 --- /dev/null +++ b/.flake8 @@ -0,0 +1,28 @@ +[flake8] + +# References: +# https://flake8.readthedocs.io/en/latest/user/configuration.html +# https://flake8.readthedocs.io/en/latest/user/error-codes.html +# https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes + +select = C,E,F,W,B,B950 +ignore = + # E203: whitespace before ':' + E203, + # E226: missing whitespace around arithmetic operator + E226, + # E231: missing whitespace after ',', ';', or ':' + E231, + # E402: module level imports on one line + E402, + # E501: line too long + E501, + # E731: do not assign a lambda expression, use a def + E731, + # W503: line break before binary operator + W503, + # W504: line break after binary operator + W504 +exclude = + .eggs + build diff --git a/.gitignore b/.gitignore index 490110e..bd780d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,26 +1,43 @@ +# Directory-based project format: +.idea/ + +# Created by editors +*~ +\#* +\.\#* +*.swp + +# setuptools-scm +_version.py + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] +*$py.class # C extensions *.so # Distribution / packaging .Python -env/ build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ +lib/ lib64/ parts/ sdist/ var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ *.egg-info/ .installed.cfg *.egg +MANIFEST # PyInstaller # Usually these files are written by a python script from a template @@ -35,12 +52,16 @@ pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ +.nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml -*,cover +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ # Translations *.mo @@ -48,6 +69,16 @@ coverage.xml # Django stuff: *.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy # Sphinx documentation docs/_build/ @@ -55,8 +86,56 @@ docs/_build/ # PyBuilder target/ -# Created by editiors -*~ -\#* -\.\#* -*.swp +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..cfc4910 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,37 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: 'v4.0.1' + hooks: + # Prevent giant files from being committed. + - id: check-added-large-files + # Check whether files parse as valid Python. + - id: check-ast + # Check for file name conflicts on case-insensitive filesytems. + - id: check-case-conflict + # Check for files that contain merge conflict strings. + - id: check-merge-conflict + # Check for debugger imports and py37+ `breakpoint()` calls in Python source. + - id: debug-statements + # Don't commit to master branch. + - id: no-commit-to-branch +- repo: https://github.com/psf/black + rev: '21.5b2' + hooks: + - id: black + # Force black to run on whole repo, using settings from pyproject.toml + pass_filenames: false + args: [--config=./pyproject.toml, .] +- repo: https://github.com/PyCQA/flake8 + rev: '3.9.2' + hooks: + # Run flake8. + - id: flake8 + args: [--config=./.flake8] +- repo: https://github.com/pycqa/isort + rev: '5.8.0' + hooks: + - id: isort + name: isort + args: ["--profile", "black", "--filter-files"] diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 21f60c0..0000000 --- a/.travis.yml +++ /dev/null @@ -1,41 +0,0 @@ -language: python - -python: - - 2.7 - - 3.6 - -install: - # Install miniconda - # ----------------- - - export CONDA_BASE=http://repo.continuum.io/miniconda/Miniconda - - if [[ "$TRAVIS_PYTHON_VERSION" == 2* ]]; then - wget ${CONDA_BASE}-3.7.0-Linux-x86_64.sh -O miniconda.sh; - else - wget ${CONDA_BASE}3-3.7.0-Linux-x86_64.sh -O miniconda.sh; - fi - - bash miniconda.sh -b -p $HOME/miniconda - - export PATH="$HOME/miniconda/bin:$PATH" - - # Create the testing environment - # ------------------------------------ - - conda config --set always_yes yes --set changeps1 no - - conda config --set show_channel_urls True - - conda update --quiet conda - - ENV_NAME='test-environment' - - conda create --quiet -n $ENV_NAME python=$TRAVIS_PYTHON_VERSION coveralls - - source activate $ENV_NAME - - # Install the package itself - # -------------------------- - - pip install . - - # Output debug info - # ----------------- - - conda list - - conda info -a - -script: - - coverage run setup.py test - - -after_success: coveralls diff --git a/MANIFEST.in b/MANIFEST.in index 6d46496..d4b42b8 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,4 @@ include LICENSE -include versioneer.py -include nc_time_axis/_version.py + +recursive-include nc_time_axis/tests *.py +graft requirements diff --git a/README.md b/README.md new file mode 100644 index 0000000..5eb5b3a --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# nc-time-axis + +

+ Support for a cftime axis in matplotlib +

+ +

+ + + cirrus-ci + + + codecov + + + pre-commit.ci + + + conda-forge + + + pypi + + + black + + + license + + + contributors + +

+ + +## Installation +Install `nc-time-axis` either with `conda`: +```shell + conda install -c conda-forge nc-time-axis +``` +Or `pip`: +```shell + pip install nc-time-axis +``` + + +## Example + + import random + + import cftime + import matplotlib.pyplot as plt + + from nc_time_axis import CalendarDateTime + + calendar = "360_day" + dt = [ + cftime.datetime(year=2017, month=2, day=day, calendar=calendar) + for day in range(1, 31) + ] + cdt = [CalendarDateTime(item, calendar) for item in dt] + temperatures = [round(random.uniform(0, 12), 3) for _ in range(len(cdt))] + + plt.plot(cdt, temperatures) + plt.margins(0.1) + plt.ylim(0, 12) + plt.xlabel("Date") + plt.ylabel("Temperature") + plt.show() + +![alt text](https://github.com/SciTools/nc-time-axis/raw/master/example_plot.png "Example plot with cftime axis") + + +## Reference +* [cftime](https://github.com/Unidata/cftime) - Time-handling functionality from netcdf4-python. +* [matplotlib](http://matplotlib.org/) - Plotting with Python. diff --git a/README.rst b/README.rst deleted file mode 100644 index bd3a999..0000000 --- a/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -nc-time-axis -============ - -|Travis|_ |Coveralls|_ - -Support for a cftime axis in matplotlib. - - -See also --------- - -* `matplotlib `_ -* `cftime `_ - -Installation ------------- -:: - - conda install -c conda-forge nc-time-axis - - -Example Code ------------- -:: - - import random - - import matplotlib.pyplot as plt - import nc_time_axis - import cftime - - d_time = [cftime.datetime(year=2017, month=2, day=n) for n in range(1, 31)] - c_d_time = [nc_time_axis.CalendarDateTime(item, "360_day") for item in d_time] - temperatures = [round(random.uniform(0, 12), 3) for _ in range(len(c_d_time))] - - plt.plot(c_d_time, temperatures) - plt.margins(0.1) - plt.ylim(0, 12) - plt.xlabel("Date") - plt.ylabel("Temperature") - plt.show() - -.. image:: example_plot.png - -.. |Travis| image:: https://travis-ci.org/SciTools/nc-time-axis.svg?branch=master -.. _Travis: https://travis-ci.org/SciTools/nc-time-axis - -.. |Coveralls| image:: https://coveralls.io/repos/github/SciTools/nc-time-axis/badge.svg?branch=master -.. _Coveralls: https://coveralls.io/github/SciTools/nc-time-axis?branch=master diff --git a/nc_time_axis/__init__.py b/nc_time_axis/__init__.py index b3e0804..0d60ed4 100644 --- a/nc_time_axis/__init__.py +++ b/nc_time_axis/__init__.py @@ -3,48 +3,46 @@ """ -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa - from collections import namedtuple +import cftime import matplotlib.dates as mdates import matplotlib.ticker as mticker import matplotlib.transforms as mtransforms import matplotlib.units as munits -import cftime import numpy as np -# Define __version__ based on versioneer's interpretation. -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions - +from ._version import version as __version__ # noqa: F401 # Lower and upper are in number of days. -FormatOption = namedtuple('FormatOption', ['lower', 'upper', 'format_string']) +FormatOption = namedtuple("FormatOption", ["lower", "upper", "format_string"]) -class CalendarDateTime(object): +class CalendarDateTime: """ Container for :class:`cftime.datetime` object and calendar. """ + def __init__(self, datetime, calendar): self.datetime = datetime self.calendar = calendar def __eq__(self, other): - return (isinstance(other, self.__class__) and - self.datetime == other.datetime and - self.calendar == other.calendar) + return ( + isinstance(other, self.__class__) + and self.datetime == other.datetime + and self.calendar == other.calendar + ) def __ne__(self, other): return not self.__eq__(other) def __repr__(self): - msg = '<{}: datetime={}, calendar={}>' - return msg.format(type(self).__name__, self.datetime, self.calendar) + return ( + f"<{type(self).__name__}: datetime={self.datetime}, " + "calendar={self.calendar}>" + ) class NetCDFTimeDateFormatter(mticker.Formatter): @@ -52,13 +50,16 @@ class NetCDFTimeDateFormatter(mticker.Formatter): Formatter for cftime.datetime data. """ + # Some magic numbers. These seem to work pretty well. - format_options = [FormatOption(0.0, 0.2, '%H:%M:%S'), - FormatOption(0.2, 0.8, '%H:%M'), - FormatOption(0.8, 15, '%Y-%m-%d %H:%M'), - FormatOption(15, 90, '%Y-%m-%d'), - FormatOption(90, 900, '%Y-%m'), - FormatOption(900, 6000000, '%Y')] + format_options = [ + FormatOption(0.0, 0.2, "%H:%M:%S"), + FormatOption(0.2, 0.8, "%H:%M"), + FormatOption(0.8, 15, "%Y-%m-%d %H:%M"), + FormatOption(15, 90, "%Y-%m-%d"), + FormatOption(90, 900, "%Y-%m"), + FormatOption(900, 6000000, "%Y"), + ] def __init__(self, locator, calendar, time_units): #: The locator associated with this formatter. This is used to get hold @@ -76,12 +77,12 @@ def pick_format(self, ndays): if option.lower < ndays <= option.upper: return option.format_string else: - msg = 'No formatter found for an interval of {} days.' - raise ValueError(msg.format(ndays)) + emsg = f"No formatter found for an interval of {ndays} days." + raise ValueError(emsg) def __call__(self, x, pos=0): format_string = self.pick_format(ndays=self.locator.ndays) - dt = cftime.utime(self.time_units, self.calendar).num2date(x) + dt = cftime.num2date(x, self.time_units, calendar=self.calendar) return dt.strftime(format_string) @@ -90,6 +91,14 @@ class NetCDFTimeDateLocator(mticker.Locator): Determines tick locations when plotting cftime.datetime data. """ + + real_world_calendars = ( + "gregorian", + "julian", + "proleptic_gregorian", + "standard", + ) + def __init__(self, max_n_ticks, calendar, date_unit, min_n_ticks=3): # The date unit must be in the form of days since ... @@ -97,12 +106,16 @@ def __init__(self, max_n_ticks, calendar, date_unit, min_n_ticks=3): self.min_n_ticks = min_n_ticks self._max_n_locator = mticker.MaxNLocator(max_n_ticks, integer=True) self._max_n_locator_days = mticker.MaxNLocator( - max_n_ticks, integer=True, steps=[1, 2, 4, 7, 10]) + max_n_ticks, integer=True, steps=[1, 2, 4, 7, 10] + ) self.calendar = calendar self.date_unit = date_unit - if not self.date_unit.lower().startswith('days since'): - msg = 'The date unit must be days since for a NetCDF time locator.' - raise ValueError(msg) + if not self.date_unit.lower().startswith("days since"): + emsg = ( + "The date unit must be days since for a NetCDF " + "time locator." + ) + raise ValueError(emsg) self._cached_resolution = {} @@ -113,22 +126,22 @@ def compute_resolution(self, num1, num2, date1, date2): """ num_days = float(np.abs(num1 - num2)) - resolution = 'SECONDLY' + resolution = "SECONDLY" n = mdates.SEC_PER_DAY if num_days * mdates.MINUTES_PER_DAY > self.max_n_ticks: - resolution = 'MINUTELY' + resolution = "MINUTELY" n = int(num_days / mdates.MINUTES_PER_DAY) if num_days * mdates.HOURS_PER_DAY > self.max_n_ticks: - resolution = 'HOURLY' + resolution = "HOURLY" n = int(num_days / mdates.HOURS_PER_DAY) if num_days > self.max_n_ticks: - resolution = 'DAILY' + resolution = "DAILY" n = int(num_days) if num_days > 30 * self.max_n_ticks: - resolution = 'MONTHLY' + resolution = "MONTHLY" n = num_days // 30 if num_days > 365 * self.max_n_ticks: - resolution = 'YEARLY' + resolution = "YEARLY" n = abs(date1.year - date2.year) return resolution, n @@ -138,23 +151,39 @@ def __call__(self): return self.tick_values(vmin, vmax) def tick_values(self, vmin, vmax): - vmin, vmax = mtransforms.nonsingular(vmin, vmax, expander=1e-7, - tiny=1e-13) + vmin, vmax = mtransforms.nonsingular( + vmin, vmax, expander=1e-7, tiny=1e-13 + ) self.ndays = float(abs(vmax - vmin)) - utime = cftime.utime(self.date_unit, self.calendar) - lower = utime.num2date(vmin) - upper = utime.num2date(vmax) + lower = cftime.num2date(vmin, self.date_unit, calendar=self.calendar) + upper = cftime.num2date(vmax, self.date_unit, calendar=self.calendar) resolution, n = self.compute_resolution(vmin, vmax, lower, upper) - if resolution == 'YEARLY': + def has_year_zero(year): + result = dict() + if self.calendar in self.real_world_calendars and not bool(year): + result = dict(has_year_zero=True) + return result + + if resolution == "YEARLY": # TODO START AT THE BEGINNING OF A DECADE/CENTURY/MILLENIUM as # appropriate. + years = self._max_n_locator.tick_values(lower.year, upper.year) - ticks = [cftime.datetime(int(year), 1, 1) for year in years] - elif resolution == 'MONTHLY': + ticks = [ + cftime.datetime( + int(year), + 1, + 1, + calendar=self.calendar, + **has_year_zero(year), + ) + for year in years + ] + elif resolution == "MONTHLY": # TODO START AT THE BEGINNING OF A DECADE/CENTURY/MILLENIUM as # appropriate. months_offset = self._max_n_locator.tick_values(0, n) @@ -162,34 +191,58 @@ def tick_values(self, vmin, vmax): for offset in months_offset: year = lower.year + np.floor((lower.month + offset) / 12) month = ((lower.month + offset) % 12) + 1 - ticks.append(cftime.datetime(int(year), int(month), 1)) - elif resolution == 'DAILY': + dt = cftime.datetime( + int(year), + int(month), + 1, + calendar=self.calendar, + **has_year_zero(year), + ) + ticks.append(dt) + elif resolution == "DAILY": # TODO: It would be great if this favoured multiples of 7. days = self._max_n_locator_days.tick_values(vmin, vmax) - ticks = [utime.num2date(dt) for dt in days] - elif resolution == 'HOURLY': - hour_unit = 'hours since 2000-01-01' - hour_utime = cftime.utime(hour_unit, self.calendar) - in_hours = hour_utime.date2num([lower, upper]) + ticks = [ + cftime.num2date(dt, self.date_unit, calendar=self.calendar) + for dt in days + ] + elif resolution == "HOURLY": + hour_unit = "hours since 2000-01-01" + in_hours = cftime.date2num( + [lower, upper], hour_unit, calendar=self.calendar + ) hours = self._max_n_locator.tick_values(in_hours[0], in_hours[1]) - ticks = [hour_utime.num2date(dt) for dt in hours] - elif resolution == 'MINUTELY': - minute_unit = 'minutes since 2000-01-01' - minute_utime = cftime.utime(minute_unit, self.calendar) - in_minutes = minute_utime.date2num([lower, upper]) - minutes = self._max_n_locator.tick_values(in_minutes[0], - in_minutes[1]) - ticks = [minute_utime.num2date(dt) for dt in minutes] - elif resolution == 'SECONDLY': - second_unit = 'seconds since 2000-01-01' - second_utime = cftime.utime(second_unit, self.calendar) - in_seconds = second_utime.date2num([lower, upper]) - seconds = self._max_n_locator.tick_values(in_seconds[0], - in_seconds[1]) - ticks = [second_utime.num2date(dt) for dt in seconds] + ticks = [ + cftime.num2date(dt, hour_unit, calendar=self.calendar) + for dt in hours + ] + elif resolution == "MINUTELY": + minute_unit = "minutes since 2000-01-01" + in_minutes = cftime.date2num( + [lower, upper], minute_unit, calendar=self.calendar + ) + minutes = self._max_n_locator.tick_values( + in_minutes[0], in_minutes[1] + ) + ticks = [ + cftime.num2date(dt, minute_unit, calendar=self.calendar) + for dt in minutes + ] + elif resolution == "SECONDLY": + second_unit = "seconds since 2000-01-01" + in_seconds = cftime.date2num( + [lower, upper], second_unit, calendar=self.calendar + ) + seconds = self._max_n_locator.tick_values( + in_seconds[0], in_seconds[1] + ) + ticks = [ + cftime.num2date(dt, second_unit, calendar=self.calendar) + for dt in seconds + ] else: - msg = 'Resolution {} not implemented yet.'.format(resolution) - raise ValueError(msg) + emsg = f"Resolution {resolution} not implemented yet." + raise ValueError(emsg) # Some calenders do not allow a year 0. # Remove ticks to avoid raising an error. if self.calendar in [ @@ -197,9 +250,9 @@ def tick_values(self, vmin, vmax): "gregorian", "julian", "standard", - ]: + ]: ticks = [t for t in ticks if t.year != 0] - return utime.date2num(ticks) + return cftime.date2num(ticks, self.date_unit, calendar=self.calendar) class NetCDFTimeConverter(mdates.DateConverter): @@ -207,7 +260,8 @@ class NetCDFTimeConverter(mdates.DateConverter): Converter for cftime.datetime data. """ - standard_unit = 'days since 2000-01-01' + + standard_unit = "days since 2000-01-01" @staticmethod def axisinfo(unit, axis): @@ -219,20 +273,28 @@ def axisinfo(unit, axis): """ calendar, date_unit, date_type = unit - majloc = NetCDFTimeDateLocator(4, calendar=calendar, - date_unit=date_unit) - majfmt = NetCDFTimeDateFormatter(majloc, calendar=calendar, - time_units=date_unit) + majloc = NetCDFTimeDateLocator( + 4, calendar=calendar, date_unit=date_unit + ) + majfmt = NetCDFTimeDateFormatter( + majloc, calendar=calendar, time_units=date_unit + ) if date_type is CalendarDateTime: - datemin = CalendarDateTime(cftime.datetime(2000, 1, 1), - calendar=calendar) - datemax = CalendarDateTime(cftime.datetime(2010, 1, 1), - calendar=calendar) + datemin = CalendarDateTime( + cftime.datetime(2000, 1, 1), calendar=calendar + ) + datemax = CalendarDateTime( + cftime.datetime(2010, 1, 1), calendar=calendar + ) else: datemin = date_type(2000, 1, 1) datemax = date_type(2010, 1, 1) - return munits.AxisInfo(majloc=majloc, majfmt=majfmt, label='', - default_limits=(datemin, datemax)) + return munits.AxisInfo( + majloc=majloc, + majfmt=majfmt, + label="", + default_limits=(datemin, datemax), + ) @classmethod def default_units(cls, sample_point, axis): @@ -240,7 +302,7 @@ def default_units(cls, sample_point, axis): Computes some units for the given data point. """ - if hasattr(sample_point, '__iter__'): + if hasattr(sample_point, "__iter__"): # Deal with nD `sample_point` arrays. if isinstance(sample_point, np.ndarray): sample_point = sample_point.reshape(-1) @@ -248,13 +310,14 @@ def default_units(cls, sample_point, axis): if np.all(calendars == calendars[0]): calendar = calendars[0] else: - raise ValueError('Calendar units are not all equal.') + raise ValueError("Calendar units are not all equal.") date_type = type(sample_point[0]) else: # Deal with a single `sample_point` value. - if not hasattr(sample_point, 'calendar'): - msg = ('Expecting cftimes with an extra ' - '"calendar" attribute.') + if not hasattr(sample_point, "calendar"): + msg = ( + "Expecting cftimes with an extra " '"calendar" attribute.' + ) raise ValueError(msg) else: calendar = sample_point.calendar @@ -265,13 +328,13 @@ def default_units(cls, sample_point, axis): def convert(cls, value, unit, axis): """ Converts value, if it is not already a number or sequence of numbers, - with :func:`cftime.utime().date2num`. + with :func:`cftime.date2num`. """ shape = None if isinstance(value, np.ndarray): # Don't do anything with numeric types. - if value.dtype != np.object: + if value.dtype != object: return value shape = value.shape value = value.reshape(-1) @@ -283,25 +346,30 @@ def convert(cls, value, unit, axis): first_value = value if not isinstance(first_value, (CalendarDateTime, cftime.datetime)): - raise ValueError('The values must be numbers or instances of ' - '"nc_time_axis.CalendarDateTime" or ' - '"cftime.datetime".') + raise ValueError( + "The values must be numbers or instances of " + '"nc_time_axis.CalendarDateTime" or ' + '"cftime.datetime".' + ) if isinstance(first_value, CalendarDateTime): if not isinstance(first_value.datetime, cftime.datetime): - raise ValueError('The datetime attribute of the ' - 'CalendarDateTime object must be of type ' - '`cftime.datetime`.') - - ut = cftime.utime(cls.standard_unit, calendar=first_value.calendar) + raise ValueError( + "The datetime attribute of the " + "CalendarDateTime object must be of type " + "`cftime.datetime`." + ) if isinstance(value, (CalendarDateTime, cftime.datetime)): value = [value] if isinstance(first_value, CalendarDateTime): - result = ut.date2num([v.datetime for v in value]) - else: - result = ut.date2num(value) + value = [v.datetime for v in value] + + result = cftime.date2num( + value, cls.standard_unit, calendar=first_value.calendar + ) + print(result) if shape is not None: result = result.reshape(shape) @@ -314,9 +382,14 @@ def convert(cls, value, unit, axis): if CalendarDateTime not in munits.registry: munits.registry[CalendarDateTime] = NetCDFTimeConverter() -CFTIME_TYPES = [cftime.DatetimeNoLeap, cftime.DatetimeAllLeap, - cftime.DatetimeProlepticGregorian, cftime.DatetimeGregorian, - cftime.Datetime360Day, cftime.DatetimeJulian] +CFTIME_TYPES = [ + cftime.DatetimeNoLeap, + cftime.DatetimeAllLeap, + cftime.DatetimeProlepticGregorian, + cftime.DatetimeGregorian, + cftime.Datetime360Day, + cftime.DatetimeJulian, +] for date_type in CFTIME_TYPES: if date_type not in munits.registry: munits.registry[date_type] = NetCDFTimeConverter() diff --git a/nc_time_axis/_version.py b/nc_time_axis/_version.py deleted file mode 100644 index d2eef2a..0000000 --- a/nc_time_axis/_version.py +++ /dev/null @@ -1,587 +0,0 @@ - -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.15+dev (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "$Format:%d$" - git_full = "$Format:%H$" - keywords = {"refnames": git_refnames, "full": git_full} - return keywords - - -class VersioneerConfig: - - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "pep440-branch-based" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "conda-testenv-" - cfg.versionfile_source = "conda_testenv/_version.py" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - return None - return stdout - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes - both the project name and a version string. - """ - dirname = os.path.basename(root) - if not dirname.startswith(parentdir_prefix): - if verbose: - print("guessing rootdir is '%s', but '%s' doesn't start with " - "prefix '%s'" % (root, dirname, parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None} - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = [r.strip() for r in refnames.strip("()").split(",")] - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(set(refs) - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, "branch": None - } - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", - "branch": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - if not os.path.exists(os.path.join(root, ".git")): - if verbose: - print("no .git in %s" % root) - raise NotThisMethod("no .git directory") - - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM). Note, for git v1.7 - # and below, it is necessary to run "git update-index --refresh" first. - describe_out = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # abbrev-ref available with git >= 1.7 - branch_name = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root).strip() - if branch_name == 'HEAD': - branches = run_command(GITS, ["branch", "--contains"], - cwd=root).split('\n') - branches = [branch[2:] for branch in branches if branch[4:5] != '('] - if 'master' in branches: - branch_name = 'master' - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - branch_name = branch_name.replace(' ', '.').replace('(', '').replace(')', '') - - pieces['branch'] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out or 1) # total number of commits - - return pieces - - -# Default matches v1.2.x, maint/1.2.x, 1.2.x, 1.x etc. -default_maint_branch_regexp = ".*([0-9]+\.)+x$" - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def add_one_to_version(version_string, number_index_to_increment=-1): - """ - Add one to a version string at the given numeric indices. - - >>> add_one_to_version('v1.2.3') - 'v1.2.4' - - """ - # Break up the tag by number groups (preserving multi-digit - # numbers as multidigit) - parts = re.split("([0-9]+)", version_string) - - digit_parts = [(i, part) for i, part in enumerate(parts) - if part.isdigit()] - - # Deal with negative indexing. - increment_at_index = ((number_index_to_increment + len(digit_parts)) - % len(digit_parts)) - for n_seen, (i, part) in enumerate(digit_parts): - if n_seen == increment_at_index: - parts[i] = str(int(part) + 1) - elif n_seen > increment_at_index: - parts[i] = '0' - return ''.join(parts) - - -def render_pep440_branch_based(pieces): - # [TAG+1 of minor number][.devDISTANCE][+gHEX]. The git short is - # included for dirty. - - # exceptions: - # 1: no tags. 0.0.0.devDISTANCE[+gHEX] - - master = pieces.get('branch') == 'master' - maint = re.match(default_maint_branch_regexp, - pieces.get('branch') or '') - - # If we are on a tag, just pep440-pre it. - if pieces["closest-tag"] and not (pieces["distance"] or - pieces["dirty"]): - rendered = pieces["closest-tag"] - else: - # Put a default closest-tag in. - if not pieces["closest-tag"]: - pieces["closest-tag"] = '0.0.0' - - if pieces["distance"] or pieces["dirty"]: - if maint: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post%d" % pieces["distance"] - else: - rendered = add_one_to_version(pieces["closest-tag"]) - if pieces["distance"]: - rendered += ".dev%d" % pieces["distance"] - # Put the branch name in if it isn't master nor a - # maintenance branch. - - plus = '+' - if not (master or maint): - rendered += "%s%s" % (plus, - pieces.get('branch') or - 'unknown_branch') - plus = '_' - - if pieces["dirty"]: - rendered += "%sg%s" % (plus, pieces["short"]) - else: - rendered = pieces["closest-tag"] - return rendered - - -STYLES = {'default': render_pep440, - 'pep440': render_pep440, - 'pep440-pre': render_pep440_pre, - 'pep440-post': render_pep440_post, - 'pep440-old': render_pep440_old, - 'git-describe': render_git_describe, - 'git-describe-long': render_git_describe_long, - 'pep440-old': render_pep440_old, - 'pep440-branch-based': render_pep440_branch_based, - } - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"]} - - if not style: - style = 'default' - - renderer = STYLES.get(style) - - if not renderer: - raise ValueError("unknown style '%s'" % style) - - rendered = renderer(pieces) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree"} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version"} diff --git a/nc_time_axis/tests/__init__.py b/nc_time_axis/tests/__init__.py index e204338..e69de29 100644 --- a/nc_time_axis/tests/__init__.py +++ b/nc_time_axis/tests/__init__.py @@ -1,2 +0,0 @@ -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa diff --git a/nc_time_axis/tests/integration/__init__.py b/nc_time_axis/tests/integration/__init__.py index 7cd1464..6ad1bad 100644 --- a/nc_time_axis/tests/integration/__init__.py +++ b/nc_time_axis/tests/integration/__init__.py @@ -1,4 +1 @@ """Integration tests for the :mod:`nc-time-axis` package.""" - -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa diff --git a/nc_time_axis/tests/integration/test_plot.py b/nc_time_axis/tests/integration/test_plot.py index ba1d5b7..d111846 100644 --- a/nc_time_axis/tests/integration/test_plot.py +++ b/nc_time_axis/tests/integration/test_plot.py @@ -1,43 +1,46 @@ """Integration test for plotting data with non-gregorian calendar.""" -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa - import unittest import matplotlib -matplotlib.use('agg') -import matplotlib.pyplot as plt # nopep8 -import cftime # nopep8 -import numpy as np # nopep8 -import nc_time_axis # nopep8 +matplotlib.use("agg") +import cftime +import matplotlib.pyplot as plt +import numpy as np + +import nc_time_axis class Test(unittest.TestCase): def setUp(self): # Make sure we have no unclosed plots from previous tests before # generating this one. - plt.close('all') + plt.close("all") def tearDown(self): # If a plotting test bombs out it can leave the current figure # in an odd state, so we make sure it's been disposed of. - plt.close('all') + plt.close("all") def test_360_day_calendar_CalendarDateTime(self): - datetimes = [cftime.datetime(1986, month, 30) - for month in range(1, 6)] - cal_datetimes = [nc_time_axis.CalendarDateTime(dt, '360_day') - for dt in datetimes] - line1, = plt.plot(cal_datetimes) + calendar = "360_day" + datetimes = [ + cftime.datetime(1986, month, 30, calendar=calendar) + for month in range(1, 6) + ] + cal_datetimes = [ + nc_time_axis.CalendarDateTime(dt, calendar) for dt in datetimes + ] + (line1,) = plt.plot(cal_datetimes) result_ydata = line1.get_ydata() np.testing.assert_array_equal(result_ydata, cal_datetimes) def test_360_day_calendar_raw_dates(self): - datetimes = [cftime.Datetime360Day(1986, month, 30) - for month in range(1, 6)] - line1, = plt.plot(datetimes) + datetimes = [ + cftime.Datetime360Day(1986, month, 30) for month in range(1, 6) + ] + (line1,) = plt.plot(datetimes) result_ydata = line1.get_ydata() np.testing.assert_array_equal(result_ydata, datetimes) diff --git a/nc_time_axis/tests/test_pep8.py b/nc_time_axis/tests/test_pep8.py deleted file mode 100644 index c89bc77..0000000 --- a/nc_time_axis/tests/test_pep8.py +++ /dev/null @@ -1,42 +0,0 @@ -""" -Perform a PEP8 conformance test of the nc-time-axis code base. - -""" -import os -import unittest - -import pep8 - -import nc_time_axis - - -class TestCodeFormat(unittest.TestCase): - def test_pep8_conformance(self): - # Tests the nc-time-axis code base against the "pep8" tool. - # - # Users can add their own excluded files (should files exist in the - # local directory which is not in the repository) by adding a - # ".pep8_test_exclude.txt" file in the same directory as this test. - # The file should be a line separated list of filenames/directories - # as can be passed to the "pep8" tool's exclude list. - - pep8style = pep8.StyleGuide(quiet=False) - pep8style.options.exclude.extend(['*/_version.py']) - - # Allow users to add their own exclude list. - extra_exclude_file = os.path.join(os.path.dirname(__file__), - '.pep8_test_exclude.txt') - if os.path.exists(extra_exclude_file): - with open(extra_exclude_file, 'r') as fhandle: - extra_exclude = [line.strip() - for line in fhandle if line.strip()] - pep8style.options.exclude.extend(extra_exclude) - - root = os.path.abspath(nc_time_axis.__file__) - result = pep8style.check_files([os.path.dirname(root)]) - self.assertEqual(result.total_errors, 0, "Found code syntax " - "errors (and warnings).") - - -if __name__ == '__main__': - unittest.main() diff --git a/nc_time_axis/tests/unit/__init__.py b/nc_time_axis/tests/unit/__init__.py index 23e9bf6..21513df 100644 --- a/nc_time_axis/tests/unit/__init__.py +++ b/nc_time_axis/tests/unit/__init__.py @@ -1,4 +1 @@ """Unit tests for the :mod:`nc-time-axis` package.""" - -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa diff --git a/nc_time_axis/tests/unit/test_CalendarDateTime.py b/nc_time_axis/tests/unit/test_CalendarDateTime.py index 8017501..4d3ddaa 100644 --- a/nc_time_axis/tests/unit/test_CalendarDateTime.py +++ b/nc_time_axis/tests/unit/test_CalendarDateTime.py @@ -1,8 +1,5 @@ """Unit tests for the `nc-time-axis.CalendarDateTime` class.""" -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa - import unittest import cftime @@ -12,46 +9,52 @@ class Test___eq__(unittest.TestCase): def setUp(self): - self.cdt = CalendarDateTime(cftime.datetime(1967, 7, 22, 3, 6), - '360_day') + self.cdt = CalendarDateTime( + cftime.datetime(1967, 7, 22, 3, 6), "360_day" + ) def test_equal(self): self.assertTrue(self.cdt == self.cdt) def test_diff_cal(self): - other_cdt = CalendarDateTime(cftime.datetime(1967, 7, 22, 3, 6), - '365_day') + other_cdt = CalendarDateTime( + cftime.datetime(1967, 7, 22, 3, 6), "365_day" + ) self.assertFalse(self.cdt == other_cdt) def test_diff_datetime(self): - other_cdt = CalendarDateTime(cftime.datetime(1992, 11, 23, 3, 6), - '360_day') + other_cdt = CalendarDateTime( + cftime.datetime(1992, 11, 23, 3, 6), "360_day" + ) self.assertFalse(self.cdt == other_cdt) def test_diff_type(self): - self.assertFalse(self.cdt == 'not a CalendarDateTime') + self.assertFalse(self.cdt == "not a CalendarDateTime") class Test__ne__(unittest.TestCase): def setUp(self): - self.cdt = CalendarDateTime(cftime.datetime(1967, 7, 22, 3, 6), - '360_day') + self.cdt = CalendarDateTime( + cftime.datetime(1967, 7, 22, 3, 6), "360_day" + ) def test_equal(self): self.assertFalse(self.cdt != self.cdt) def test_diff_cal(self): - other_cdt = CalendarDateTime(cftime.datetime(1967, 7, 22, 3, 6), - '365_day') + other_cdt = CalendarDateTime( + cftime.datetime(1967, 7, 22, 3, 6), "365_day" + ) self.assertTrue(self.cdt != other_cdt) def test_diff_datetime(self): - other_cdt = CalendarDateTime(cftime.datetime(1992, 11, 23, 3, 6), - '360_day') + other_cdt = CalendarDateTime( + cftime.datetime(1992, 11, 23, 3, 6), "360_day" + ) self.assertTrue(self.cdt != other_cdt) def test_diff_type(self): - self.assertTrue(self.cdt != 'not a CalendarDateTime') + self.assertTrue(self.cdt != "not a CalendarDateTime") if __name__ == "__main__": diff --git a/nc_time_axis/tests/unit/test_NetCDFTimeConverter.py b/nc_time_axis/tests/unit/test_NetCDFTimeConverter.py index 5d5edaf..5610aa3 100644 --- a/nc_time_axis/tests/unit/test_NetCDFTimeConverter.py +++ b/nc_time_axis/tests/unit/test_NetCDFTimeConverter.py @@ -1,86 +1,92 @@ """Unit tests for the `nc-time-axis.NetCDFTimeConverter` class.""" -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa -from six import assertRaisesRegex - import unittest import cftime import numpy as np -from nc_time_axis import NetCDFTimeConverter, CalendarDateTime +from nc_time_axis import CalendarDateTime, NetCDFTimeConverter class Test_axisinfo(unittest.TestCase): def test_axis_default_limits(self): - cal = '360_day' - unit = (cal, 'days since 2000-02-25 00:00:00', CalendarDateTime) + cal = "360_day" + unit = (cal, "days since 2000-02-25 00:00:00", CalendarDateTime) result = NetCDFTimeConverter().axisinfo(unit, None) - expected_dt = [cftime.datetime(2000, 1, 1), - cftime.datetime(2010, 1, 1)] + expected_dt = [ + cftime.datetime(2000, 1, 1), + cftime.datetime(2010, 1, 1), + ] np.testing.assert_array_equal( result.default_limits, - [CalendarDateTime(edt, cal) for edt in expected_dt]) + [CalendarDateTime(edt, cal) for edt in expected_dt], + ) class Test_default_units(unittest.TestCase): def test_360_day_calendar_point_CalendarDateTime(self): - calendar = '360_day' - unit = 'days since 2000-01-01' + calendar = "360_day" + unit = "days since 2000-01-01" val = CalendarDateTime(cftime.datetime(2014, 8, 12), calendar) result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, CalendarDateTime)) def test_360_day_calendar_list_CalendarDateTime(self): - calendar = '360_day' - unit = 'days since 2000-01-01' + calendar = "360_day" + unit = "days since 2000-01-01" val = [CalendarDateTime(cftime.datetime(2014, 8, 12), calendar)] result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, CalendarDateTime)) def test_360_day_calendar_nd_CalendarDateTime(self): # Test the case where the input is an nd-array. - calendar = '360_day' - unit = 'days since 2000-01-01' - val = np.array([[CalendarDateTime(cftime.datetime(2014, 8, 12), - calendar)], - [CalendarDateTime(cftime.datetime(2014, 8, 13), - calendar)]]) + calendar = "360_day" + unit = "days since 2000-01-01" + val = np.array( + [ + [CalendarDateTime(cftime.datetime(2014, 8, 12), calendar)], + [CalendarDateTime(cftime.datetime(2014, 8, 13), calendar)], + ] + ) result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, CalendarDateTime)) def test_360_day_calendar_point_raw_date(self): - calendar = '360_day' - unit = 'days since 2000-01-01' + calendar = "360_day" + unit = "days since 2000-01-01" val = cftime.Datetime360Day(2014, 8, 12) result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, cftime.Datetime360Day)) def test_360_day_calendar_list_raw_date(self): - calendar = '360_day' - unit = 'days since 2000-01-01' + calendar = "360_day" + unit = "days since 2000-01-01" val = [cftime.Datetime360Day(2014, 8, 12)] result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, cftime.Datetime360Day)) def test_360_day_calendar_nd_raw_date(self): # Test the case where the input is an nd-array. - calendar = '360_day' - unit = 'days since 2000-01-01' - val = np.array([[cftime.Datetime360Day(2014, 8, 12)], - [cftime.Datetime360Day(2014, 8, 13)]]) + calendar = "360_day" + unit = "days since 2000-01-01" + val = np.array( + [ + [cftime.Datetime360Day(2014, 8, 12)], + [cftime.Datetime360Day(2014, 8, 13)], + ] + ) result = NetCDFTimeConverter().default_units(val, None) self.assertEqual(result, (calendar, unit, cftime.Datetime360Day)) def test_nonequal_calendars(self): # Test that different supplied calendars causes an error. - calendar_1 = '360_day' - calendar_2 = '365_day' - unit = 'days since 2000-01-01' - val = [CalendarDateTime(cftime.datetime(2014, 8, 12), calendar_1), - CalendarDateTime(cftime.datetime(2014, 8, 13), calendar_2)] - with assertRaisesRegex(self, ValueError, 'not all equal'): + calendar_1 = "360_day" + calendar_2 = "365_day" + val = [ + CalendarDateTime(cftime.datetime(2014, 8, 12), calendar_1), + CalendarDateTime(cftime.datetime(2014, 8, 13), calendar_2), + ] + with self.assertRaisesRegex(ValueError, "not all equal"): NetCDFTimeConverter().default_units(val, None) @@ -108,39 +114,45 @@ def test_numeric_iterable(self): np.testing.assert_array_equal(result, val) def test_cftime_CalendarDateTime(self): - val = CalendarDateTime(cftime.datetime(2014, 8, 12), '365_day') + val = CalendarDateTime(cftime.datetime(2014, 8, 12), "365_day") result = NetCDFTimeConverter().convert(val, None, None) - np.testing.assert_array_equal(result, 5333.) + np.testing.assert_array_equal(result, 5333.0) def test_cftime_raw_date(self): val = cftime.DatetimeNoLeap(2014, 8, 12) result = NetCDFTimeConverter().convert(val, None, None) - np.testing.assert_array_equal(result, 5333.) + np.testing.assert_array_equal(result, 5333.0) def test_cftime_np_array_CalendarDateTime(self): - val = np.array([CalendarDateTime(cftime.datetime(2012, 6, 4), - '360_day')], dtype=np.object) + val = np.array( + [CalendarDateTime(cftime.datetime(2012, 6, 4), "360_day")], + dtype=object, + ) result = NetCDFTimeConverter().convert(val, None, None) - self.assertEqual(result, np.array([4473.])) + self.assertEqual(result, np.array([4473.0])) def test_cftime_np_array_raw_date(self): - val = np.array([cftime.Datetime360Day(2012, 6, 4)], dtype=np.object) + val = np.array([cftime.Datetime360Day(2012, 6, 4)], dtype=object) result = NetCDFTimeConverter().convert(val, None, None) - self.assertEqual(result, np.array([4473.])) + self.assertEqual(result, np.array([4473.0])) def test_non_cftime_datetime(self): - val = CalendarDateTime(4, '360_day') - msg = 'The datetime attribute of the CalendarDateTime object must ' \ - 'be of type `cftime.datetime`.' - with assertRaisesRegex(self, ValueError, msg): - result = NetCDFTimeConverter().convert(val, None, None) + val = CalendarDateTime(4, "360_day") + msg = ( + "The datetime attribute of the CalendarDateTime object must " + "be of type `cftime.datetime`." + ) + with self.assertRaisesRegex(ValueError, msg): + _ = NetCDFTimeConverter().convert(val, None, None) def test_non_CalendarDateTime(self): - val = 'test' - msg = 'The values must be numbers or instances of ' \ - '"nc_time_axis.CalendarDateTime".' - with assertRaisesRegex(self, ValueError, msg): - result = NetCDFTimeConverter().convert(val, None, None) + val = "test" + msg = ( + "The values must be numbers or instances of " + '"nc_time_axis.CalendarDateTime".' + ) + with self.assertRaisesRegex(ValueError, msg): + _ = NetCDFTimeConverter().convert(val, None, None) if __name__ == "__main__": diff --git a/nc_time_axis/tests/unit/test_NetCDFTimeDateFormatter.py b/nc_time_axis/tests/unit/test_NetCDFTimeDateFormatter.py index d1c0235..5a15334 100644 --- a/nc_time_axis/tests/unit/test_NetCDFTimeDateFormatter.py +++ b/nc_time_axis/tests/unit/test_NetCDFTimeDateFormatter.py @@ -1,11 +1,7 @@ """Unit tests for the `nc-time-axis.NetCDFTimeDateFormatter` class.""" -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa - import unittest - -import mock +import unittest.mock as mock from nc_time_axis import NetCDFTimeDateFormatter @@ -13,17 +9,18 @@ class Test_pick_format(unittest.TestCase): def check(self, ndays): locator = mock.MagicMock() - formatter = NetCDFTimeDateFormatter(locator, '360_day', - 'days since 2000-01-01 00:00') + formatter = NetCDFTimeDateFormatter( + locator, "360_day", "days since 2000-01-01 00:00" + ) return formatter.pick_format(ndays) def test(self): - self.assertEqual(self.check(0.1), '%H:%M:%S') - self.assertEqual(self.check(0.6), '%H:%M') - self.assertEqual(self.check(5), '%Y-%m-%d %H:%M') - self.assertEqual(self.check(40), '%Y-%m-%d') - self.assertEqual(self.check(300), '%Y-%m') - self.assertEqual(self.check(1000), '%Y') + self.assertEqual(self.check(0.1), "%H:%M:%S") + self.assertEqual(self.check(0.6), "%H:%M") + self.assertEqual(self.check(5), "%Y-%m-%d %H:%M") + self.assertEqual(self.check(40), "%Y-%m-%d") + self.assertEqual(self.check(300), "%Y-%m") + self.assertEqual(self.check(1000), "%Y") if __name__ == "__main__": diff --git a/nc_time_axis/tests/unit/test_NetCDFTimeDateLocator.py b/nc_time_axis/tests/unit/test_NetCDFTimeDateLocator.py index ed48f43..11310a6 100644 --- a/nc_time_axis/tests/unit/test_NetCDFTimeDateLocator.py +++ b/nc_time_axis/tests/unit/test_NetCDFTimeDateLocator.py @@ -1,154 +1,170 @@ """Unit tests for the `nc-time-axis.NetCDFTimeDateLocator` class.""" -from __future__ import (absolute_import, division, print_function) -from six.moves import (filter, input, map, range, zip) # noqa import unittest -import matplotlib.style -import matplotlib.dates as mdates import cftime +import matplotlib.dates as mdates +import matplotlib.style import numpy as np from nc_time_axis import NetCDFTimeDateLocator - -matplotlib.style.use('classic') +matplotlib.style.use("classic") class Test_compute_resolution(unittest.TestCase): def setUp(self): - self.date_unit = 'days since 2004-01-01 00:00' - self.calendar = '365_day' + self.date_unit = "days since 2004-01-01 00:00" + self.calendar = "365_day" def check(self, max_n_ticks, num1, num2): - locator = NetCDFTimeDateLocator(max_n_ticks=max_n_ticks, - calendar=self.calendar, - date_unit=self.date_unit) - utime = cftime.utime(self.date_unit, self.calendar) - return locator.compute_resolution(num1, num2, utime.num2date(num1), - utime.num2date(num2)) + locator = NetCDFTimeDateLocator( + max_n_ticks=max_n_ticks, + calendar=self.calendar, + date_unit=self.date_unit, + ) + return locator.compute_resolution( + num1, + num2, + cftime.num2date(num1, self.date_unit, calendar=self.calendar), + cftime.num2date(num2, self.date_unit, calendar=self.calendar), + ) def test_one_minute(self): - self.assertEqual(self.check(20, 0, 0.0003), - ('SECONDLY', mdates.SEC_PER_DAY)) - self.assertEqual(self.check(10, 0.0003, 0), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual( + self.check(20, 0, 0.0003), ("SECONDLY", mdates.SEC_PER_DAY) + ) + self.assertEqual( + self.check(10, 0.0003, 0), ("SECONDLY", mdates.SEC_PER_DAY) + ) def test_one_hour(self): - self.assertEqual(self.check(1, 0, 0.02), ('MINUTELY', 0)) - self.assertEqual(self.check(0.02*86400, 0, 0.02), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual(self.check(1, 0, 0.02), ("MINUTELY", 0)) + self.assertEqual( + self.check(0.02 * 86400, 0, 0.02), ("SECONDLY", mdates.SEC_PER_DAY) + ) def test_one_day(self): - self.assertEqual(self.check(1, 0, 1), ('HOURLY', 0)) - self.assertEqual(self.check(24, 0, 1), ('MINUTELY', 0)) - self.assertEqual(self.check(86400, 0, 1), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual(self.check(1, 0, 1), ("HOURLY", 0)) + self.assertEqual(self.check(24, 0, 1), ("MINUTELY", 0)) + self.assertEqual( + self.check(86400, 0, 1), ("SECONDLY", mdates.SEC_PER_DAY) + ) def test_30_days(self): - self.assertEqual(self.check(1, 0, 30), ('DAILY', 30)) - self.assertEqual(self.check(30, 0, 30), ('HOURLY', 1)) - self.assertEqual(self.check(30*24, 0, 30), - ('MINUTELY', 0)) - self.assertEqual(self.check(30*86400, 0, 30), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual(self.check(1, 0, 30), ("DAILY", 30)) + self.assertEqual(self.check(30, 0, 30), ("HOURLY", 1)) + self.assertEqual(self.check(30 * 24, 0, 30), ("MINUTELY", 0)) + self.assertEqual( + self.check(30 * 86400, 0, 30), ("SECONDLY", mdates.SEC_PER_DAY) + ) def test_365_days(self): - self.assertEqual(self.check(1, 0, 365), ('MONTHLY', 12)) - self.assertEqual(self.check(13, 0, 365), ('DAILY', 365)) - self.assertEqual(self.check(365, 0, 365), ('HOURLY', 15)) - self.assertEqual(self.check(365*24, 0, 365), - ('MINUTELY', 0)) - self.assertEqual(self.check(365*86400, 0, 365), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual(self.check(1, 0, 365), ("MONTHLY", 12)) + self.assertEqual(self.check(13, 0, 365), ("DAILY", 365)) + self.assertEqual(self.check(365, 0, 365), ("HOURLY", 15)) + self.assertEqual(self.check(365 * 24, 0, 365), ("MINUTELY", 0)) + self.assertEqual( + self.check(365 * 86400, 0, 365), ("SECONDLY", mdates.SEC_PER_DAY) + ) def test_10_years(self): - self.assertEqual(self.check(1, 0, 10*365), - ('YEARLY', 10)) - self.assertEqual(self.check(10, 0, 10*365), - ('MONTHLY', 121)) - self.assertEqual(self.check(122, 0, 10*365), - ('DAILY', 10*365)) - self.assertEqual(self.check(10*365, 0, 10*365), - ('HOURLY', 152)) - self.assertEqual(self.check(10*365*24, 0, 10*365), - ('MINUTELY', 2)) - self.assertEqual(self.check(10*365*86400, 0, 10*365), - ('SECONDLY', mdates.SEC_PER_DAY)) + self.assertEqual(self.check(1, 0, 10 * 365), ("YEARLY", 10)) + self.assertEqual(self.check(10, 0, 10 * 365), ("MONTHLY", 121)) + self.assertEqual(self.check(122, 0, 10 * 365), ("DAILY", 10 * 365)) + self.assertEqual(self.check(10 * 365, 0, 10 * 365), ("HOURLY", 152)) + self.assertEqual( + self.check(10 * 365 * 24, 0, 10 * 365), ("MINUTELY", 2) + ) + self.assertEqual( + self.check(10 * 365 * 86400, 0, 10 * 365), + ("SECONDLY", mdates.SEC_PER_DAY), + ) class Test_tick_values(unittest.TestCase): def setUp(self): - self.date_unit = 'days since 2004-01-01 00:00' - self.calendar = '365_day' + self.date_unit = "days since 2004-01-01 00:00" + self.calendar = "365_day" def check(self, max_n_ticks, num1, num2): - locator = NetCDFTimeDateLocator(max_n_ticks=max_n_ticks, - calendar=self.calendar, - date_unit=self.date_unit) + locator = NetCDFTimeDateLocator( + max_n_ticks=max_n_ticks, + calendar=self.calendar, + date_unit=self.date_unit, + ) return locator.tick_values(num1, num2) def test_secondly(self): np.testing.assert_array_almost_equal( self.check(4, 0, 0.0004), - [0., 0.000116, 0.000231, 0.000347, 0.000463]) + [0.0, 0.000116, 0.000231, 0.000347, 0.000463], + ) def test_minutely(self): np.testing.assert_array_almost_equal( - self.check(4, 1, 1.07), [1., 1.027778, 1.055556, 1.083333]) + self.check(4, 1, 1.07), [1.0, 1.027778, 1.055556, 1.083333] + ) def test_hourly(self): np.testing.assert_array_almost_equal( - self.check(4, 2, 3), [2., 2.333333, 2.666667, 3.]) + self.check(4, 2, 3), [2.0, 2.333333, 2.666667, 3.0] + ) def test_daily(self): np.testing.assert_array_equal( - self.check(5, 0, 30), [0., 7., 14., 21., 28., 35.]) + self.check(5, 0, 30), [0.0, 7.0, 14.0, 21.0, 28.0, 35.0] + ) def test_monthly(self): np.testing.assert_array_equal( - self.check(4, 0, 365), [31., 120., 212., 304., 396.]) + self.check(4, 0, 365), [31.0, 120.0, 212.0, 304.0, 396.0] + ) def test_yearly(self): np.testing.assert_array_equal( - self.check(5, 0, 5*365), [31., 485., 942., 1399., 1856.]) + self.check(5, 0, 5 * 365), [31.0, 485.0, 942.0, 1399.0, 1856.0] + ) class Test_tick_values_yr0(unittest.TestCase): def setUp(self): - self.date_unit = 'days since 0001-01-01 00:00' + self.date_unit = "days since 0001-01-01 00:00" self.all_calendars = [ - 'standard', - 'gregorian', - 'proleptic_gregorian', - 'noleap', - '365_day', - '360_day', - 'julian', - 'all_leap', - '366_day', + "standard", + "gregorian", + "proleptic_gregorian", + "noleap", + "365_day", + "360_day", + "julian", + "all_leap", + "366_day", ] self.yr0_remove_calendars = [ - 'proleptic_gregorian', - 'gregorian', - 'julian', - 'standard', + "proleptic_gregorian", + "gregorian", + "julian", + "standard", ] def check(self, max_n_ticks, num1, num2, calendar): locator = NetCDFTimeDateLocator( - max_n_ticks=max_n_ticks, calendar=calendar, - date_unit=self.date_unit + max_n_ticks=max_n_ticks, + calendar=calendar, + date_unit=self.date_unit, ) return locator.tick_values(num1, num2) def test_yearly_yr0_remove(self): for calendar in self.all_calendars: # convert values to dates, check that none of them has year 0 - num2date = cftime.utime(self.date_unit, calendar).num2date ticks = self.check(5, 0, 100 * 365, calendar) - year_ticks = [num2date(t).year for t in ticks] + year_ticks = [ + cftime.num2date(t, self.date_unit, calendar=calendar).year + for t in ticks + ] if calendar in self.yr0_remove_calendars: self.assertNotIn(0, year_ticks) else: diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..4ab8bd6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +[build-system] +# Defined by PEP 518 +requires = [ + "setuptools>=42", + "setuptools_scm[toml]>=6.0", + "wheel", +] +# Defined by PEP 517 +build-backend = "setuptools.build_meta" + +[tool.black] +line-length = 79 +target-version = ['py37', 'py38', 'py39'] +include = '\.pyi?$' +exclude = ''' + +( + /( + \.eggs # exclude a few common directories in the + | \.git # root of the project + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | buck-out + | build + | dist + )/ +) +''' + +[tool.isort] +known_first_party = "nc_time_axis" +line_length = 79 +profile = "black" +skip_gitignore = "True" +verbose = "False" + +[tool.pytest.ini_options] +addopts = "-ra -v --doctest-modules" +doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS NUMBER" +minversion = "6.0" +testpaths = "nc_time_axis" + +[tool.setuptools_scm] +write_to = "nc_time_axis/_version.py" diff --git a/requirements/ncta.yml b/requirements/ncta.yml new file mode 120000 index 0000000..26a7748 --- /dev/null +++ b/requirements/ncta.yml @@ -0,0 +1 @@ +py39.yml \ No newline at end of file diff --git a/requirements/py37.yml b/requirements/py37.yml new file mode 100644 index 0000000..40e3a9d --- /dev/null +++ b/requirements/py37.yml @@ -0,0 +1,25 @@ +name: ncta-dev + +channels: + - conda-forge + +dependencies: + - python 3.7 + +# setup dependencies + - setuptools + - setuptools-scm + +# core dependencies + - cftime + - matplotlib + - numpy + +# test dependencies + - codecov + - pytest>=6.0 + - pytest-cov + +# dev dependencies + - pip + - pre-commit diff --git a/requirements/py38.yml b/requirements/py38.yml new file mode 100644 index 0000000..4f97610 --- /dev/null +++ b/requirements/py38.yml @@ -0,0 +1,25 @@ +name: ncta-dev + +channels: + - conda-forge + +dependencies: + - python 3.8 + +# setup dependencies + - setuptools + - setuptools-scm + +# core dependencies + - cftime + - matplotlib + - numpy + +# test dependencies + - codecov + - pytest>=6.0 + - pytest-cov + +# dev dependencies + - pip + - pre-commit diff --git a/requirements/py39.yml b/requirements/py39.yml new file mode 100644 index 0000000..e141ecb --- /dev/null +++ b/requirements/py39.yml @@ -0,0 +1,25 @@ +name: ncta-dev + +channels: + - conda-forge + +dependencies: + - python 3.9 + +# setup dependencies + - setuptools + - setuptools-scm + +# core dependencies + - cftime + - matplotlib + - numpy + +# test dependencies + - codecov + - pytest>=6.0 + - pytest-cov + +# dev dependencies + - pip + - pre-commit diff --git a/setup.cfg b/setup.cfg index d6bb560..8a0fe29 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,52 @@ -[versioneer] -VCS = git -style = pep440-branch-based -versionfile_source = nc_time_axis/_version.py -versionfile_build = nc_time_axis/_version.py -tag_prefix = v -parentdir_prefix = nc-time-axis- +[metadata] +author = SciTools Developers +classifiers = + Development Status :: 5 - Production/Stable + Intended Audience :: Science/Research + License :: OSI Approved :: BSD License + Operating System :: MacOS + Operating System :: Microsoft :: Windows + Operating System :: POSIX :: Linux + Operating System :: Unix + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Topic :: Scientific/Engineering +description = Provides support for a cftime axis in matplotlib +download_url = https://github.com/SciTools/nc-time-axis +keywords = + axis + cftime + matplotlib +license = BSD 3-Clause +license_file = LICENSE +long_description = file: README.md +long_description_content_type = text/markdown +name = nc-time-axis +project_urls = + Code = https://github.com/SciTools/nc-time-axis + Discussions = https://github.com/SciTools/nc-time-axis/discussions + Issues = https://github.com/SciTools/nc-time-axis/issues +url = https://github.com/SciTools/nc-time-axis +version = attr: nc_time_axis.__version__ + +[options] +include_package_data = True +install_requires = + cftime + matplotlib + numpy +packages = find: +python_requires = + >=3.7 +zip_safe = False + +[options.extras_require] +test = + codecov + pytest >=6.0 + pytest-cov +all = + pre-commit + %(test)s diff --git a/setup.py b/setup.py index 3ac3be7..1175ace 100644 --- a/setup.py +++ b/setup.py @@ -1,32 +1,5 @@ -import os -import os.path from setuptools import setup -import versioneer +# see https://setuptools.readthedocs.io/en/latest/setuptools.html#setup-cfg-only-projects - -here = os.path.abspath(os.path.dirname(__file__)) -packages = [] -for d, _, _ in os.walk(os.path.join(here, 'nc_time_axis')): - if os.path.exists(os.path.join(d, '__init__.py')): - packages.append(d[len(here)+1:].replace(os.path.sep, '.')) - -setup_args = dict( - name='nc-time-axis', - version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), - description='cftime support for matplotlib axis', - license='BSD3', - author='Laura Dreyer, Philip Elson', - url='https://github.com/scitools/nc-time-axis', - packages=packages, - install_requires = ['cftime', - 'matplotlib', - 'numpy', - 'six'], - tests_require = ['mock', 'pep8'], - test_suite='nc_time_axis.tests' -) - -if __name__ == '__main__': - setup(**setup_args) +setup() diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index b128924..0000000 --- a/versioneer.py +++ /dev/null @@ -1,1974 +0,0 @@ - -# Version: 0.15+dev - -"""The Versioneer - like a rocketeer, but for versions. - -The Versioneer -============== - -* like a rocketeer, but for versions! -* https://github.com/warner/python-versioneer -* Brian Warner -* License: Public Domain -* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, and pypy -* [![Latest Version] -(https://pypip.in/version/versioneer/badge.svg?style=flat) -](https://pypi.python.org/pypi/versioneer/) -* [![Build Status] -(https://travis-ci.org/warner/python-versioneer.png?branch=master) -](https://travis-ci.org/warner/python-versioneer) - -This is a tool for managing a recorded version number in distutils-based -python projects. The goal is to remove the tedious and error-prone "update -the embedded version string" step from your release process. Making a new -release should be as easy as recording a new tag in your version-control -system, and maybe making new tarballs. - - -## Quick Install - -* `pip install versioneer` to somewhere to your $PATH -* add a `[versioneer]` section to your setup.cfg (see below) -* run `versioneer install` in your source tree, commit the results - -## Version Identifiers - -Source trees come from a variety of places: - -* a version-control system checkout (mostly used by developers) -* a nightly tarball, produced by build automation -* a snapshot tarball, produced by a web-based VCS browser, like github's - "tarball from tag" feature -* a release tarball, produced by "setup.py sdist", distributed through PyPI - -Within each source tree, the version identifier (either a string or a number, -this tool is format-agnostic) can come from a variety of places: - -* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows - about recent "tags" and an absolute revision-id -* the name of the directory into which the tarball was unpacked -* an expanded VCS keyword ($Id$, etc) -* a `_version.py` created by some earlier build step - -For released software, the version identifier is closely related to a VCS -tag. Some projects use tag names that include more than just the version -string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool -needs to strip the tag prefix to extract the version identifier. For -unreleased software (between tags), the version identifier should provide -enough information to help developers recreate the same tree, while also -giving them an idea of roughly how old the tree is (after version 1.2, before -version 1.3). Many VCS systems can report a description that captures this, -for example `git describe --tags --dirty --always` reports things like -"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the -0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has -uncommitted changes. - -The version identifier is used for multiple purposes: - -* to allow the module to self-identify its version: `myproject.__version__` -* to choose a name and prefix for a 'setup.py sdist' tarball - -## Theory of Operation - -Versioneer works by adding a special `_version.py` file into your source -tree, where your `__init__.py` can import it. This `_version.py` knows how to -dynamically ask the VCS tool for version information at import time. - -`_version.py` also contains `$Revision$` markers, and the installation -process marks `_version.py` to have this marker rewritten with a tag name -during the `git archive` command. As a result, generated tarballs will -contain enough information to get the proper version. - -To allow `setup.py` to compute a version too, a `versioneer.py` is added to -the top level of your source tree, next to `setup.py` and the `setup.cfg` -that configures it. This overrides several distutils/setuptools commands to -compute the version when invoked, and changes `setup.py build` and `setup.py -sdist` to replace `_version.py` with a small static file that contains just -the generated version data. - -## Installation - -First, decide on values for the following configuration variables: - -* `VCS`: the version control system you use. Currently accepts "git". - -* `style`: the style of version string to be produced. See "Styles" below for - details. Defaults to "pep440", which looks like - `TAG[+DISTANCE.gSHORTHASH[.dirty]]`. - -* `versionfile_source`: - - A project-relative pathname into which the generated version strings should - be written. This is usually a `_version.py` next to your project's main - `__init__.py` file, so it can be imported at runtime. If your project uses - `src/myproject/__init__.py`, this should be `src/myproject/_version.py`. - This file should be checked in to your VCS as usual: the copy created below - by `setup.py setup_versioneer` will include code that parses expanded VCS - keywords in generated tarballs. The 'build' and 'sdist' commands will - replace it with a copy that has just the calculated version string. - - This must be set even if your project does not have any modules (and will - therefore never import `_version.py`), since "setup.py sdist" -based trees - still need somewhere to record the pre-calculated version strings. Anywhere - in the source tree should do. If there is a `__init__.py` next to your - `_version.py`, the `setup.py setup_versioneer` command (described below) - will append some `__version__`-setting assignments, if they aren't already - present. - -* `versionfile_build`: - - Like `versionfile_source`, but relative to the build directory instead of - the source directory. These will differ when your setup.py uses - 'package_dir='. If you have `package_dir={'myproject': 'src/myproject'}`, - then you will probably have `versionfile_build='myproject/_version.py'` and - `versionfile_source='src/myproject/_version.py'`. - - If this is set to None, then `setup.py build` will not attempt to rewrite - any `_version.py` in the built tree. If your project does not have any - libraries (e.g. if it only builds a script), then you should use - `versionfile_build = None` and override `distutils.command.build_scripts` - to explicitly insert a copy of `versioneer.get_version()` into your - generated script. - -* `tag_prefix`: - - a string, like 'PROJECTNAME-', which appears at the start of all VCS tags. - If your tags look like 'myproject-1.2.0', then you should use - tag_prefix='myproject-'. If you use unprefixed tags like '1.2.0', this - should be an empty string, using either `tag_prefix=` or `tag_prefix=''`. - -* `parentdir_prefix`: - - a optional string, frequently the same as tag_prefix, which appears at the - start of all unpacked tarball filenames. If your tarball unpacks into - 'myproject-1.2.0', this should be 'myproject-'. To disable this feature, - just omit the field from your `setup.cfg`. - -This tool provides one script, named `versioneer`. That script has one mode, -"install", which writes a copy of `versioneer.py` into the current directory -and runs `versioneer.py setup` to finish the installation. - -To versioneer-enable your project: - -* 1: Modify your `setup.cfg`, adding a section named `[versioneer]` and - populating it with the configuration values you decided earlier (note that - the option names are not case-sensitive): - - ```` - [versioneer] - VCS = git - style = pep440 - versionfile_source = src/myproject/_version.py - versionfile_build = myproject/_version.py - tag_prefix = - parentdir_prefix = myproject- - ```` - -* 2: Run `versioneer install`. This will do the following: - - * copy `versioneer.py` into the top of your source tree - * create `_version.py` in the right place (`versionfile_source`) - * modify your `__init__.py` (if one exists next to `_version.py`) to define - `__version__` (by calling a function from `_version.py`) - * modify your `MANIFEST.in` to include both `versioneer.py` and the - generated `_version.py` in sdist tarballs - - `versioneer install` will complain about any problems it finds with your - `setup.py` or `setup.cfg`. Run it multiple times until you have fixed all - the problems. - -* 3: add a `import versioneer` to your setup.py, and add the following - arguments to the setup() call: - - version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), - -* 4: commit these changes to your VCS. To make sure you won't forget, - `versioneer install` will mark everything it touched for addition using - `git add`. Don't forget to add `setup.py` and `setup.cfg` too. - -## Post-Installation Usage - -Once established, all uses of your tree from a VCS checkout should get the -current version string. All generated tarballs should include an embedded -version string (so users who unpack them will not need a VCS tool installed). - -If you distribute your project through PyPI, then the release process should -boil down to two steps: - -* 1: git tag 1.0 -* 2: python setup.py register sdist upload - -If you distribute it through github (i.e. users use github to generate -tarballs with `git archive`), the process is: - -* 1: git tag 1.0 -* 2: git push; git push --tags - -Versioneer will report "0+untagged.NUMCOMMITS.gHASH" until your tree has at -least one tag in its history. - -## Version-String Flavors - -Code which uses Versioneer can learn about its version string at runtime by -importing `_version` from your main `__init__.py` file and running the -`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can -import the top-level `versioneer.py` and run `get_versions()`. - -Both functions return a dictionary with different flavors of version -information: - -* `['version']`: A condensed version string, rendered using the selected - style. This is the most commonly used value for the project's version - string. The default "pep440" style yields strings like `0.11`, - `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section - below for alternative styles. - -* `['full-revisionid']`: detailed revision identifier. For Git, this is the - full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". - -* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that - this is only accurate if run in a VCS checkout, otherwise it is likely to - be False or None - -* `['error']`: if the version string could not be computed, this will be set - to a string describing the problem, otherwise it will be None. It may be - useful to throw an exception in setup.py if this is set, to avoid e.g. - creating tarballs with a version string of "unknown". - -Some variants are more useful than others. Including `full-revisionid` in a -bug report should allow developers to reconstruct the exact code being tested -(or indicate the presence of local changes that should be shared with the -developers). `version` is suitable for display in an "about" box or a CLI -`--version` output: it can be easily compared against release notes and lists -of bugs fixed in various releases. - -The installer adds the following text to your `__init__.py` to place a basic -version in `YOURPROJECT.__version__`: - - from ._version import get_versions - __version__ = get_versions()['version'] - del get_versions - -## Styles - -The setup.cfg `style=` configuration controls how the VCS information is -rendered into a version string. - -The default style, "pep440", produces a PEP440-compliant string, equal to the -un-prefixed tag name for actual releases, and containing an additional "local -version" section with more detail for in-between builds. For Git, this is -TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags ---dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the -tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and -that this commit is two revisions ("+2") beyond the "0.11" tag. For released -software (exactly equal to a known tag), the identifier will only contain the -stripped tag, e.g. "0.11". - -Other styles are available. See details.md in the Versioneer source tree for -descriptions. - -## Debugging - -Versioneer tries to avoid fatal errors: if something goes wrong, it will tend -to return a version of "0+unknown". To investigate the problem, run `setup.py -version`, which will run the version-lookup code in a verbose mode, and will -display the full contents of `get_versions()` (including the `error` string, -which may help identify what went wrong). - -## Updating Versioneer - -To upgrade your project to a new release of Versioneer, do the following: - -* install the new Versioneer (`pip install -U versioneer` or equivalent) -* edit `setup.cfg`, if necessary, to include any new configuration settings - indicated by the release notes -* re-run `versioneer install` in your source tree, to replace - `SRC/_version.py` -* commit any changed files - -### Upgrading to 0.15 - -Starting with this version, Versioneer is configured with a `[versioneer]` -section in your `setup.cfg` file. Earlier versions required the `setup.py` to -set attributes on the `versioneer` module immediately after import. The new -version will refuse to run (raising an exception during import) until you -have provided the necessary `setup.cfg` section. - -In addition, the Versioneer package provides an executable named -`versioneer`, and the installation process is driven by running `versioneer -install`. In 0.14 and earlier, the executable was named -`versioneer-installer` and was run without an argument. - -### Upgrading to 0.14 - -0.14 changes the format of the version string. 0.13 and earlier used -hyphen-separated strings like "0.11-2-g1076c97-dirty". 0.14 and beyond use a -plus-separated "local version" section strings, with dot-separated -components, like "0.11+2.g1076c97". PEP440-strict tools did not like the old -format, but should be ok with the new one. - -### Upgrading from 0.11 to 0.12 - -Nothing special. - -### Upgrading from 0.10 to 0.11 - -You must add a `versioneer.VCS = "git"` to your `setup.py` before re-running -`setup.py setup_versioneer`. This will enable the use of additional -version-control systems (SVN, etc) in the future. - -## Future Directions - -This tool is designed to make it easily extended to other version-control -systems: all VCS-specific components are in separate directories like -src/git/ . The top-level `versioneer.py` script is assembled from these -components by running make-versioneer.py . In the future, make-versioneer.py -will take a VCS name as an argument, and will construct a version of -`versioneer.py` that is specific to the given VCS. It might also take the -configuration arguments that are currently provided manually during -installation by editing setup.py . Alternatively, it might go the other -direction and include code from all supported VCS systems, reducing the -number of intermediate scripts. - - -## License - -To make Versioneer easier to embed, all its code is dedicated to the public -domain. The `_version.py` that it creates is also in the public domain. -Specifically, both are released under the Creative Commons "Public Domain -Dedication" license (CC0-1.0), as described in -https://creativecommons.org/publicdomain/zero/1.0/ . - -""" - -from __future__ import print_function -try: - import configparser -except ImportError: - import ConfigParser as configparser -import errno -import json -import os -import re -import subprocess -import sys - - -class VersioneerConfig: - - """Container for Versioneer configuration parameters.""" - - -def get_root(): - """Get the project root directory. - - We require that all commands are run from the project root, i.e. the - directory that contains setup.py, setup.cfg, and versioneer.py . - """ - root = os.path.realpath(os.path.abspath(os.getcwd())) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - # allow 'python path/to/setup.py COMMAND' - root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - err = ("Versioneer was unable to run the project root directory. " - "Versioneer requires setup.py to be executed from " - "its immediate directory (like 'python setup.py COMMAND'), " - "or in a way that lets it use sys.argv[0] to find the root " - "(like 'python path/to/setup.py COMMAND').") - raise VersioneerBadRootError(err) - try: - # Certain runtime workflows (setup.py install/develop in a setuptools - # tree) execute all dependencies in a single python process, so - # "versioneer" may be imported multiple times, and python's shared - # module-import table will cache the first one. So we can't use - # os.path.dirname(__file__), as that will find whichever - # versioneer.py was first imported, even in later projects. - me = os.path.realpath(os.path.abspath(__file__)) - if os.path.splitext(me)[0] != os.path.splitext(versioneer_py)[0]: - print("Warning: build in %s is using versioneer.py from %s" - % (os.path.dirname(me), versioneer_py)) - except NameError: - pass - return root - - -def get_config_from_root(root): - """Read the project setup.cfg file to determine Versioneer config.""" - # This might raise EnvironmentError (if setup.cfg is missing), or - # configparser.NoSectionError (if it lacks a [versioneer] section), or - # configparser.NoOptionError (if it lacks "VCS="). See the docstring at - # the top of versioneer.py for instructions on writing your setup.cfg . - setup_cfg = os.path.join(root, "setup.cfg") - parser = configparser.SafeConfigParser() - with open(setup_cfg, "r") as f: - parser.readfp(f) - VCS = parser.get("versioneer", "VCS") # mandatory - - def get(parser, name): - if parser.has_option("versioneer", name): - return parser.get("versioneer", name) - return None - cfg = VersioneerConfig() - cfg.VCS = VCS - cfg.style = get(parser, "style") or "" - cfg.versionfile_source = get(parser, "versionfile_source") - cfg.versionfile_build = get(parser, "versionfile_build") - cfg.tag_prefix = get(parser, "tag_prefix") - if cfg.tag_prefix in ("''", '""'): - cfg.tag_prefix = "" - cfg.parentdir_prefix = get(parser, "parentdir_prefix") - cfg.verbose = get(parser, "verbose") - return cfg - - -class NotThisMethod(Exception): - - """Exception raised if a method is not valid for the current scenario.""" - -# these dictionaries contain VCS-specific tools -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - return None - return stdout -LONG_VERSION_PY['git'] = r''' -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.15+dev (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" - git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" - keywords = {"refnames": git_refnames, "full": git_full} - return keywords - - -class VersioneerConfig: - - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "%(STYLE)s" - cfg.tag_prefix = "%(TAG_PREFIX)s" - cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" - cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %%s" %% dispcmd) - print(e) - return None - else: - if verbose: - print("unable to find command, tried %%s" %% (commands,)) - return None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %%s (error)" %% dispcmd) - return None - return stdout - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes - both the project name and a version string. - """ - dirname = os.path.basename(root) - if not dirname.startswith(parentdir_prefix): - if verbose: - print("guessing rootdir is '%%s', but '%%s' doesn't start with " - "prefix '%%s'" %% (root, dirname, parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None} - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = [r.strip() for r in refnames.strip("()").split(",")] - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %%d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%%s', no digits" %% ",".join(set(refs) - tags)) - if verbose: - print("likely tags: %%s" %% ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %%s" %% r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, "branch": None - } - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", - "branch": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - if not os.path.exists(os.path.join(root, ".git")): - if verbose: - print("no .git in %%s" %% root) - raise NotThisMethod("no .git directory") - - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM). Note, for git v1.7 - # and below, it is necessary to run "git update-index --refresh" first. - describe_out = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%%s*" %% tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # abbrev-ref available with git >= 1.7 - branch_name = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root).strip() - if branch_name == 'HEAD': - branches = run_command(GITS, ["branch", "--contains"], - cwd=root).split('\n') - branches = [branch[2:] for branch in branches if branch[4:5] != '('] - if 'master' in branches: - branch_name = 'master' - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - branch_name = branch_name.replace(' ', '.').replace('(', '').replace(')', '') - - pieces['branch'] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%%s'" - %% describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%%s' doesn't start with prefix '%%s'" - print(fmt %% (full_tag, tag_prefix)) - pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" - %% (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - return pieces - - -# Default matches v1.2.x, maint/1.2.x, 1.2.x, 1.x etc. -default_maint_branch_regexp = ".*([0-9]+\.)+x$" - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%%d" %% pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%%d" %% pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%%s" %% pieces["short"] - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%%s" %% pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def add_one_to_version(version_string, number_index_to_increment=-1): - """ - Add one to a version string at the given numeric indices. - - >>> add_one_to_version('v1.2.3') - 'v1.2.4' - - """ - # Break up the tag by number groups (preserving multi-digit - # numbers as multidigit) - parts = re.split("([0-9]+)", version_string) - - digit_parts = [(i, part) for i, part in enumerate(parts) - if part.isdigit()] - - # Deal with negative indexing. - increment_at_index = ((number_index_to_increment + len(digit_parts)) - %% len(digit_parts)) - for n_seen, (i, part) in enumerate(digit_parts): - if n_seen == increment_at_index: - parts[i] = str(int(part) + 1) - elif n_seen > increment_at_index: - parts[i] = '0' - return ''.join(parts) - - -def render_pep440_branch_based(pieces): - # [TAG+1 of minor number][.devDISTANCE][+gHEX]. The git short is - # included for dirty. - - # exceptions: - # 1: no tags. 0.0.0.devDISTANCE[+gHEX] - - master = pieces.get('branch') == 'master' - maint = re.match(default_maint_branch_regexp, - pieces.get('branch') or '') - - # If we are on a tag, just pep440-pre it. - if pieces["closest-tag"] and not (pieces["distance"] or - pieces["dirty"]): - rendered = pieces["closest-tag"] - else: - # Put a default closest-tag in. - if not pieces["closest-tag"]: - pieces["closest-tag"] = '0.0.0' - - if pieces["distance"] or pieces["dirty"]: - if maint: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post%%d" %% pieces["distance"] - else: - rendered = add_one_to_version(pieces["closest-tag"]) - if pieces["distance"]: - rendered += ".dev%%d" %% pieces["distance"] - # Put the branch name in if it isn't master nor a - # maintenance branch. - - plus = '+' - if not (master or maint): - rendered += "%%s%%s" %% (plus, - pieces.get('branch') or - 'unknown_branch') - plus = '_' - - if pieces["dirty"]: - rendered += "%%sg%%s" %% (plus, pieces["short"]) - else: - rendered = pieces["closest-tag"] - return rendered - - -STYLES = {'default': render_pep440, - 'pep440': render_pep440, - 'pep440-pre': render_pep440_pre, - 'pep440-post': render_pep440_post, - 'pep440-old': render_pep440_old, - 'git-describe': render_git_describe, - 'git-describe-long': render_git_describe_long, - 'pep440-old': render_pep440_old, - 'pep440-branch-based': render_pep440_branch_based, - } - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"]} - - if not style: - style = 'default' - - renderer = STYLES.get(style) - - if not renderer: - raise ValueError("unknown style '%%s'" %% style) - - rendered = renderer(pieces) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree"} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version"} -''' - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = [r.strip() for r in refnames.strip("()").split(",")] - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(set(refs) - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, "branch": None - } - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", - "branch": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - if not os.path.exists(os.path.join(root, ".git")): - if verbose: - print("no .git in %s" % root) - raise NotThisMethod("no .git directory") - - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM). Note, for git v1.7 - # and below, it is necessary to run "git update-index --refresh" first. - describe_out = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # abbrev-ref available with git >= 1.7 - branch_name = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root).strip() - if branch_name == 'HEAD': - branches = run_command(GITS, ["branch", "--contains"], - cwd=root).split('\n') - branches = [branch[2:] for branch in branches if branch[4:5] != '('] - if 'master' in branches: - branch_name = 'master' - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - branch_name = branch_name.replace(' ', '.').replace('(', '').replace(')', '') - - pieces['branch'] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int('3') # total number of commits - - return pieces - - -def do_vcs_install(manifest_in, versionfile_source, ipy): - """Git-specific installation logic for Versioneer. - - For Git, this means creating/changing .gitattributes to mark _version.py - for export-time keyword substitution. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - files = [manifest_in, versionfile_source] - if ipy: - files.append(ipy) - try: - me = __file__ - if me.endswith(".pyc") or me.endswith(".pyo"): - me = os.path.splitext(me)[0] + ".py" - versioneer_file = os.path.relpath(me) - except NameError: - versioneer_file = "versioneer.py" - files.append(versioneer_file) - present = False - try: - f = open(".gitattributes", "r") - for line in f.readlines(): - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - f.close() - except EnvironmentError: - pass - if not present: - f = open(".gitattributes", "a+") - f.write("%s export-subst\n" % versionfile_source) - f.close() - files.append(".gitattributes") - run_command(GITS, ["add", "--"] + files) - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes - both the project name and a version string. - """ - dirname = os.path.basename(root) - if not dirname.startswith(parentdir_prefix): - if verbose: - print("guessing rootdir is '%s', but '%s' doesn't start with " - "prefix '%s'" % (root, dirname, parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None} - -SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.15+dev) from -# revision-control system data, or from the parent directory name of an -# unpacked source archive. Distribution tarballs contain a pre-generated copy -# of this file. - -import json -import sys - -version_json = ''' -%s -''' # END VERSION_JSON - - -def get_versions(): - return json.loads(version_json) -""" - - -def versions_from_file(filename): - """Try to determine the version from _version.py if present.""" - try: - with open(filename) as f: - contents = f.read() - except EnvironmentError: - raise NotThisMethod("unable to read _version.py") - mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", - contents, re.M | re.S) - if not mo: - raise NotThisMethod("no version_json in _version.py") - return json.loads(mo.group(1)) - - -def write_to_version_file(filename, versions): - """Write the given version number to the given _version.py file.""" - os.unlink(filename) - contents = json.dumps(versions, sort_keys=True, - indent=1, separators=(",", ": ")) - with open(filename, "w") as f: - f.write(SHORT_VERSION_PY % contents) - - print("set %s to '%s'" % (filename, versions["version"])) - -# Default matches v1.2.x, maint/1.2.x, 1.2.x, 1.x etc. -default_maint_branch_regexp = ".*([0-9]+\.)+x$" - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def add_one_to_version(version_string, number_index_to_increment=-1): - """ - Add one to a version string at the given numeric indices. - - >>> add_one_to_version('v1.2.3') - 'v1.2.4' - - """ - # Break up the tag by number groups (preserving multi-digit - # numbers as multidigit) - parts = re.split("([0-9]+)", version_string) - - digit_parts = [(i, part) for i, part in enumerate(parts) - if part.isdigit()] - - # Deal with negative indexing. - increment_at_index = ((number_index_to_increment + len(digit_parts)) - % len(digit_parts)) - for n_seen, (i, part) in enumerate(digit_parts): - if n_seen == increment_at_index: - parts[i] = str(int(part) + 1) - elif n_seen > increment_at_index: - parts[i] = '0' - return ''.join(parts) - - -def render_pep440_branch_based(pieces): - # [TAG+1 of minor number][.devDISTANCE][+gHEX]. The git short is - # included for dirty. - - # exceptions: - # 1: no tags. 0.0.0.devDISTANCE[+gHEX] - - master = pieces.get('branch') == 'master' - maint = re.match(default_maint_branch_regexp, - pieces.get('branch') or '') - - # If we are on a tag, just pep440-pre it. - if pieces["closest-tag"] and not (pieces["distance"] or - pieces["dirty"]): - rendered = pieces["closest-tag"] - else: - # Put a default closest-tag in. - if not pieces["closest-tag"]: - pieces["closest-tag"] = '0.0.0' - - if pieces["distance"] or pieces["dirty"]: - if maint: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post%d" % pieces["distance"] - else: - rendered = add_one_to_version(pieces["closest-tag"]) - if pieces["distance"]: - rendered += ".dev%d" % pieces["distance"] - # Put the branch name in if it isn't master nor a - # maintenance branch. - - plus = '+' - if not (master or maint): - rendered += "%s%s" % (plus, - pieces.get('branch') or - 'unknown_branch') - plus = '_' - - if pieces["dirty"]: - rendered += "%sg%s" % (plus, pieces["short"]) - else: - rendered = pieces["closest-tag"] - return rendered - - -STYLES = {'default': render_pep440, - 'pep440': render_pep440, - 'pep440-pre': render_pep440_pre, - 'pep440-post': render_pep440_post, - 'pep440-old': render_pep440_old, - 'git-describe': render_git_describe, - 'git-describe-long': render_git_describe_long, - 'pep440-old': render_pep440_old, - 'pep440-branch-based': render_pep440_branch_based, - } - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"]} - - if not style: - style = 'default' - - renderer = STYLES.get(style) - - if not renderer: - raise ValueError("unknown style '%s'" % style) - - rendered = renderer(pieces) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None} - - -class VersioneerBadRootError(Exception): - - """The project root directory is unknown or missing key files.""" - - -def get_versions(verbose=False): - """Get the project version from whatever source is available. - - Returns dict with two keys: 'version' and 'full'. - """ - if "versioneer" in sys.modules: - # see the discussion in cmdclass.py:get_cmdclass() - del sys.modules["versioneer"] - - root = get_root() - cfg = get_config_from_root(root) - - assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" - handlers = HANDLERS.get(cfg.VCS) - assert handlers, "unrecognized VCS '%s'" % cfg.VCS - verbose = verbose or cfg.verbose - assert cfg.versionfile_source is not None, \ - "please set versioneer.versionfile_source" - assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" - - versionfile_abs = os.path.join(root, cfg.versionfile_source) - - # extract version from first of: _version.py, VCS command (e.g. 'git - # describe'), parentdir. This is meant to work for developers using a - # source checkout, for users of a tarball created by 'setup.py sdist', - # and for users of a tarball/zipball created by 'git archive' or github's - # download-from-tag feature or the equivalent in other VCSes. - - get_keywords_f = handlers.get("get_keywords") - from_keywords_f = handlers.get("keywords") - if get_keywords_f and from_keywords_f: - try: - keywords = get_keywords_f(versionfile_abs) - ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) - if verbose: - print("got version from expanded keyword %s" % ver) - return ver - except NotThisMethod: - pass - - try: - ver = versions_from_file(versionfile_abs) - if verbose: - print("got version from file %s %s" % (versionfile_abs, ver)) - return ver - except NotThisMethod: - pass - - from_vcs_f = handlers.get("pieces_from_vcs") - if from_vcs_f: - try: - pieces = from_vcs_f(cfg.tag_prefix, root, verbose) - ver = render(pieces, cfg.style) - if verbose: - print("got version from VCS %s" % ver) - return ver - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - if verbose: - print("got version from parentdir %s" % ver) - return ver - except NotThisMethod: - pass - - if verbose: - print("unable to compute version") - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, "error": "unable to compute version"} - - -def get_version(): - """Get the short version string for this project.""" - return get_versions()["version"] - - -def get_cmdclass(): - """Get the custom setuptools/distutils subclasses used by Versioneer.""" - if "versioneer" in sys.modules: - del sys.modules["versioneer"] - # this fixes the "python setup.py develop" case (also 'install' and - # 'easy_install .'), in which subdependencies of the main project are - # built (using setup.py bdist_egg) in the same python process. Assume - # a main project A and a dependency B, which use different versions - # of Versioneer. A's setup.py imports A's Versioneer, leaving it in - # sys.modules by the time B's setup.py is executed, causing B to run - # with the wrong versioneer. Setuptools wraps the sub-dep builds in a - # sandbox that restores sys.modules to it's pre-build state, so the - # parent is protected against the child's "import versioneer". By - # removing ourselves from sys.modules here, before the child build - # happens, we protect the child from the parent's versioneer too. - # Also see https://github.com/warner/python-versioneer/issues/52 - - cmds = {} - - # we add "version" to both distutils and setuptools - from distutils.core import Command - - class cmd_version(Command): - description = "report generated version string" - user_options = [] - boolean_options = [] - - def initialize_options(self): - pass - - def finalize_options(self): - pass - - def run(self): - vers = get_versions(verbose=True) - print("Version: %s" % vers["version"]) - print(" full-revisionid: %s" % vers.get("full-revisionid")) - print(" dirty: %s" % vers.get("dirty")) - if vers["error"]: - print(" error: %s" % vers["error"]) - cmds["version"] = cmd_version - - # we override "build_py" in both distutils and setuptools - # - # most invocation pathways end up running build_py: - # distutils/build -> build_py - # distutils/install -> distutils/build ->.. - # setuptools/bdist_wheel -> distutils/install ->.. - # setuptools/bdist_egg -> distutils/install_lib -> build_py - # setuptools/install -> bdist_egg ->.. - # setuptools/develop -> ? - - # we override different "build_py" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.build_py import build_py as _build_py - else: - from distutils.command.build_py import build_py as _build_py - - class cmd_build_py(_build_py): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - _build_py.run(self) - # now locate _version.py in the new build/ directory and replace - # it with an updated value - if cfg.versionfile_build: - target_versionfile = os.path.join(self.build_lib, - cfg.versionfile_build) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - cmds["build_py"] = cmd_build_py - - if "cx_Freeze" in sys.modules: # cx_freeze enabled? - from cx_Freeze.dist import build_exe as _build_exe - - class cmd_build_exe(_build_exe): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - target_versionfile = cfg.versionfile_source - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - - _build_exe.run(self) - os.unlink(target_versionfile) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % - {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - cmds["build_exe"] = cmd_build_exe - del cmds["build_py"] - - # we override different "sdist" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.sdist import sdist as _sdist - else: - from distutils.command.sdist import sdist as _sdist - - class cmd_sdist(_sdist): - def run(self): - versions = get_versions() - self._versioneer_generated_versions = versions - # unless we update this, the command will keep using the old - # version - self.distribution.metadata.version = versions["version"] - return _sdist.run(self) - - def make_release_tree(self, base_dir, files): - root = get_root() - cfg = get_config_from_root(root) - _sdist.make_release_tree(self, base_dir, files) - # now locate _version.py in the new base_dir directory - # (remembering that it may be a hardlink) and replace it with an - # updated value - target_versionfile = os.path.join(base_dir, cfg.versionfile_source) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, - self._versioneer_generated_versions) - cmds["sdist"] = cmd_sdist - - return cmds - - -CONFIG_ERROR = """ -setup.cfg is missing the necessary Versioneer configuration. You need -a section like: - - [versioneer] - VCS = git - style = pep440 - versionfile_source = src/myproject/_version.py - versionfile_build = myproject/_version.py - tag_prefix = - parentdir_prefix = myproject- - -You will also need to edit your setup.py to use the results: - - import versioneer - setup(version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), ...) - -Please read the docstring in ./versioneer.py for configuration instructions, -edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. -""" - -SAMPLE_CONFIG = """ -# See the docstring in versioneer.py for instructions. Note that you must -# re-run 'versioneer.py setup' after changing this section, and commit the -# resulting files. - -[versioneer] -#VCS = git -#style = pep440 -#versionfile_source = -#versionfile_build = -#tag_prefix = -#parentdir_prefix = - -""" - -INIT_PY_SNIPPET = """ -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions -""" - - -def do_setup(): - """Main VCS-independent setup function for installing Versioneer.""" - root = get_root() - try: - cfg = get_config_from_root(root) - except (EnvironmentError, configparser.NoSectionError, - configparser.NoOptionError) as e: - if isinstance(e, (EnvironmentError, configparser.NoSectionError)): - print("Adding sample versioneer config to setup.cfg", - file=sys.stderr) - with open(os.path.join(root, "setup.cfg"), "a") as f: - f.write(SAMPLE_CONFIG) - print(CONFIG_ERROR, file=sys.stderr) - return 1 - - print(" creating %s" % cfg.versionfile_source) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - - ipy = os.path.join(os.path.dirname(cfg.versionfile_source), - "__init__.py") - if os.path.exists(ipy): - try: - with open(ipy, "r") as f: - old = f.read() - except EnvironmentError: - old = "" - if INIT_PY_SNIPPET not in old: - print(" appending to %s" % ipy) - with open(ipy, "a") as f: - f.write(INIT_PY_SNIPPET) - else: - print(" %s unmodified" % ipy) - else: - print(" %s doesn't exist, ok" % ipy) - ipy = None - - # Make sure both the top-level "versioneer.py" and versionfile_source - # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so - # they'll be copied into source distributions. Pip won't be able to - # install the package without this. - manifest_in = os.path.join(root, "MANIFEST.in") - simple_includes = set() - try: - with open(manifest_in, "r") as f: - for line in f: - if line.startswith("include "): - for include in line.split()[1:]: - simple_includes.add(include) - except EnvironmentError: - pass - # That doesn't cover everything MANIFEST.in can do - # (http://docs.python.org/2/distutils/sourcedist.html#commands), so - # it might give some false negatives. Appending redundant 'include' - # lines is safe, though. - if "versioneer.py" not in simple_includes: - print(" appending 'versioneer.py' to MANIFEST.in") - with open(manifest_in, "a") as f: - f.write("include versioneer.py\n") - else: - print(" 'versioneer.py' already in MANIFEST.in") - if cfg.versionfile_source not in simple_includes: - print(" appending versionfile_source ('%s') to MANIFEST.in" % - cfg.versionfile_source) - with open(manifest_in, "a") as f: - f.write("include %s\n" % cfg.versionfile_source) - else: - print(" versionfile_source already in MANIFEST.in") - - # Make VCS-specific changes. For git, this means creating/changing - # .gitattributes to mark _version.py for export-time keyword - # substitution. - do_vcs_install(manifest_in, cfg.versionfile_source, ipy) - return 0 - - -def scan_setup_py(): - """Validate the contents of setup.py against Versioneer's expectations.""" - found = set() - setters = False - errors = 0 - with open("setup.py", "r") as f: - for line in f.readlines(): - if "import versioneer" in line: - found.add("import") - if "versioneer.get_cmdclass()" in line: - found.add("cmdclass") - if "versioneer.get_version()" in line: - found.add("get_version") - if "versioneer.VCS" in line: - setters = True - if "versioneer.versionfile_source" in line: - setters = True - if len(found) != 3: - print("") - print("Your setup.py appears to be missing some important items") - print("(but I might be wrong). Please make sure it has something") - print("roughly like the following:") - print("") - print(" import versioneer") - print(" setup( version=versioneer.get_version(),") - print(" cmdclass=versioneer.get_cmdclass(), ...)") - print("") - errors += 1 - if setters: - print("You should remove lines like 'versioneer.VCS = ' and") - print("'versioneer.versionfile_source = ' . This configuration") - print("now lives in setup.cfg, and should be removed from setup.py") - print("") - errors += 1 - return errors - -if __name__ == "__main__": - cmd = sys.argv[1] - if cmd == "setup": - errors = do_setup() - errors += scan_setup_py() - if errors: - sys.exit(1)