diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1bd47d98e..67ea66253 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ to ensure that the PR does what it intends. diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..d43e599b6 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,7 @@ +version: 2 + +python: + install: + - method: pip + path: . + extra_requirements: [docs, tests, tutorial] diff --git a/.travis.yml b/.travis.yml index f011c8ef1..3eeaff067 100644 --- a/.travis.yml +++ b/.travis.yml @@ -61,9 +61,7 @@ script: # Run tests. These include the equivalent of Travis R tests via test_r.py. - pytest ixmp -m 'rixmp or not performance' --verbose --cov-report=xml # Test that documentation can be built - - cd doc - - pip install -r requirements.txt - - make html + - make --directory=doc html after_success: - codecov diff --git a/MANIFEST.in b/MANIFEST.in index 3140a2d24..51eba78bc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include versioneer.py -include ixmp/_version.py -include ixmp/model/dantzig.gms +exclude .* +prune .github +prune ci diff --git a/README.md b/README.md index 83051a7c0..3cfd99100 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![PyPI version](https://img.shields.io/pypi/v/ixmp.svg)](https://pypi.python.org/pypi/ixmp/) [![Anaconda version](https://img.shields.io/conda/vn/conda-forge/ixmp)](https://anaconda.org/conda-forge/ixmp) [![Documentation build](https://readthedocs.com/projects/iiasa-energy-program-ixmp/badge/?version=master)](https://message.iiasa.ac.at/projects/ixmp/en/master/) -[![Build status](https://travis-ci.org/iiasa/ixmp.svg?branch=master)](https://travis-ci.org/iiasa/ixmp) +[![Build status](https://travis-ci.com/iiasa/ixmp.svg?branch=master)](https://travis-ci.com/iiasa/ixmp) [![Test coverage](https://codecov.io/gh/iiasa/ixmp/branch/master/graph/badge.svg)](https://codecov.io/gh/iiasa/ixmp) ## Overview diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index 6d786200e..55f20da51 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -10,32 +10,32 @@ Migration notes All changes ----------- -- `#327 `_: Bump JPype dependency to 0.7.5. -- `#298 `_: Improve memory management in :class:`.JDBCBackend`. -- `#316 `_: Raise user-friendly exceptions from :meth:`.Reporter.get` in Jupyter notebooks and other read–evaluate–print loops (REPLs). -- `#315 `_: Ensure :meth:`.Model.initialize` is always called for new *and* cloned objects. -- `#320 `_: Add CLI command `ixmp show-versions` to print ixmp and dependency versions for debugging. -- `#314 `_: Bulk saving for metadata and exposing documentation API -- `#312 `_: Add :meth:`~.computations.apply_units`, :meth:`~computations.select` reporting calculations; expand :meth:`.Reporter.add`. -- `#310 `_: :meth:`.Reporter.add_product` accepts a :class:`.Key` with a tag; :func:`~.computations.aggregate` preserves :class:`.Quantity` attributes. -- `#304 `_: Add CLI command ``ixmp solve`` to run model solver. -- `#303 `_: Add `dims` and `units` arguments to :meth:`Reporter.add_file`; remove :meth:`Reporter.read_config` (redundant with :meth:`Reporter.configure`). -- `#295 `_: Add option to include `subannual` column in dataframe returned by :meth:`.TimeSeries.timeseries`. -- `#286 `_, - `#297 `_, - `#309 `_: Add :meth:`.Scenario.to_excel` and :meth:`.read_excel`; this functionality is transferred to ixmp from :mod:`message_ix` and enhanced for dealing with maximum row limits in Excel. -- `#270 `_: Include all tests in the ixmp package. -- `#212 `_: Add :meth:`Model.initialize` API to help populate new Scenarios according to a model scheme. -- `#267 `_: Apply units to reported quantities. -- `#254 `_: Remove deprecated items: +- :pull:`327`: Bump JPype dependency to 0.7.5. +- :pull:`298`: Improve memory management in :class:`.JDBCBackend`. +- :pull:`316`: Raise user-friendly exceptions from :meth:`.Reporter.get` in Jupyter notebooks and other read–evaluate–print loops (REPLs). +- :pull:`315`: Ensure :meth:`.Model.initialize` is always called for new *and* cloned objects. +- :pull:`320`: Add CLI command `ixmp show-versions` to print ixmp and dependency versions for debugging. +- :pull:`314`: Bulk saving for metadata and exposing documentation API +- :pull:`312`: Add :meth:`~.computations.apply_units`, :meth:`~computations.select` reporting calculations; expand :meth:`.Reporter.add`. +- :pull:`310`: :meth:`.Reporter.add_product` accepts a :class:`.Key` with a tag; :func:`~.computations.aggregate` preserves :class:`.Quantity` attributes. +- :pull:`304`: Add CLI command ``ixmp solve`` to run model solver. +- :pull:`303`: Add `dims` and `units` arguments to :meth:`Reporter.add_file`; remove :meth:`Reporter.read_config` (redundant with :meth:`Reporter.configure`). +- :pull:`295`: Add option to include `subannual` column in dataframe returned by :meth:`.TimeSeries.timeseries`. +- :pull:`286`, + :pull:`297`, + :pull:`309`: Add :meth:`.Scenario.to_excel` and :meth:`.read_excel`; this functionality is transferred to ixmp from :mod:`message_ix` and enhanced for dealing with maximum row limits in Excel. +- :pull:`270`: Include all tests in the ixmp package. +- :pull:`212`: Add :meth:`Model.initialize` API to help populate new Scenarios according to a model scheme. +- :pull:`267`: Apply units to reported quantities. +- :pull:`254`: Remove deprecated items: - ~/.local/ixmp as a configuration location. - positional and ``dbtype=`` arguments to :class:`.Platform`/:class:`.JDBCBackend`. - ``first_model_year=``, ``keep_sol=``, and ``scen=`` arguments to :meth:`~.Scenario.clone`. - ``rixmp.legacy``, an earlier version of :ref:`the R interface ` that did not use reticulate. -- `#261 `_: Increase minimum pandas version to 1.0; adjust for `API changes and deprecations `_. -- `#243 `_: Add :meth:`.export_timeseries_data` to write data for multiple scenarios to CSV. -- `#264 `_: Implement methods to get and create new subannual timeslices. +- :pull:`261`: Increase minimum pandas version to 1.0; adjust for `API changes and deprecations `_. +- :pull:`243`: Add :meth:`.export_timeseries_data` to write data for multiple scenarios to CSV. +- :pull:`264`: Implement methods to get and create new subannual timeslices. v2.0.0 (2020-01-14) =================== @@ -75,25 +75,25 @@ DEFAULT_LOCAL_DB_PATH All changes ----------- -- `#240 `_: Add ``ixmp list`` command-line tool. -- `#225 `_: Ensure filters are always converted to string. -- `#189 `_: Identify and load Scenarios using URLs. -- `#182 `_, - `#200 `_, - `#213 `_, - `#217 `_, - `#230 `_, - `#245 `_, - `#246 `_: Add new Backend, Model APIs and CachingBackend, JDBCBackend, GAMSModel classes. -- `#188 `_, - `#195 `_: Enhance reporting. -- `#177 `_: Add ability to pass `gams_args` through :meth:`.solve`. -- `#175 `_, - `#239 `_: Drop support for Python 2.7. -- `#174 `_: Set `convertStrings=True` for JPype >= 0.7; see the `JPype changelog `_. -- `#173 `_: Make AppVeyor CI more robust; support pandas 0.25.0. -- `#165 `_: Add support for handling geodata. -- `#232 `_: Fix exposing whole config file to log output. +- :pull:`240`: Add ``ixmp list`` command-line tool. +- :pull:`225`: Ensure filters are always converted to string. +- :pull:`189`: Identify and load Scenarios using URLs. +- :pull:`182`, + :pull:`200`, + :pull:`213`, + :pull:`217`, + :pull:`230`, + :pull:`245`, + :pull:`246`: Add new Backend, Model APIs and CachingBackend, JDBCBackend, GAMSModel classes. +- :pull:`188`, + :pull:`195`: Enhance reporting. +- :pull:`177`: Add ability to pass `gams_args` through :meth:`.solve`. +- :pull:`175`, + :pull:`239`: Drop support for Python 2.7. +- :pull:`174`: Set `convertStrings=True` for JPype >= 0.7; see the `JPype changelog `_. +- :pull:`173`: Make AppVeyor CI more robust; support pandas 0.25.0. +- :pull:`165`: Add support for handling geodata. +- :pull:`232`: Fix exposing whole config file to log output. v0.2.0 (2019-06-25) =================== @@ -109,34 +109,34 @@ Release 0.2.0 coincides with MESSAGEix release 1.2.0. All changes ----------- -- `#135 `_: Test ``rixmp`` (former ``retixmp``) using the R ``testthat`` package. -- `#142 `_: Cloning across platforms, better support of IAMC_style timeseries data, preparations for MESSAGEix release 1.2 in Java core. -- `#115 `_: Support iterating with user-supplied callbacks. -- `#130 `_: Recognize ``IXMP_DATA`` environment variable for configuration and local databases. -- `#129 `_, - `#132 `_: Fully implement :meth:`~.Scenario.clone` across platforms (databases). -- `#128 `_, - `#137 `_: New module :mod:`ixmp.testing` for reuse of testing utilities. -- `#125 `_: Add functions to view and add regions for IAMC-style timeseries data. -- `#123 `_: Return absolute path from ``find_dbprops()``. -- `#118 `_: Switch to RTD Sphinx theme. -- `#116 `_: Bugfix and extend functionality for working with IAMC-style timeseries data. -- `#111 `_: Add functions to check if a Scenario has an item (set, par, var, equ). -- `#110 `_: Generalize the internal functions to format index dimensions for mapping sets and parameters. -- `#108 `_: Improve documentation. -- `#105 `_: Replace `deprecated `_ pandas ``.ix`` indexer with ``.iloc``. -- `#103 `_: Specify dependencies in setup.py. +- :pull:`135`: Test ``rixmp`` (former ``retixmp``) using the R ``testthat`` package. +- :pull:`142`: Cloning across platforms, better support of IAMC_style timeseries data, preparations for MESSAGEix release 1.2 in Java core. +- :pull:`115`: Support iterating with user-supplied callbacks. +- :pull:`130`: Recognize ``IXMP_DATA`` environment variable for configuration and local databases. +- :pull:`129`, + :pull:`132`: Fully implement :meth:`~.Scenario.clone` across platforms (databases). +- :pull:`128`, + :pull:`137`: New module :mod:`ixmp.testing` for reuse of testing utilities. +- :pull:`125`: Add functions to view and add regions for IAMC-style timeseries data. +- :pull:`123`: Return absolute path from ``find_dbprops()``. +- :pull:`118`: Switch to RTD Sphinx theme. +- :pull:`116`: Bugfix and extend functionality for working with IAMC-style timeseries data. +- :pull:`111`: Add functions to check if a Scenario has an item (set, par, var, equ). +- :pull:`110`: Generalize the internal functions to format index dimensions for mapping sets and parameters. +- :pull:`108`: Improve documentation. +- :pull:`105`: Replace `deprecated `_ pandas ``.ix`` indexer with ``.iloc``. +- :pull:`103`: Specify dependencies in setup.py. v0.1.3 (2018-11-21) =================== -- `#88 `_: Connecting to multiple databases, updating MESSAGE-scheme scenario specifications to version 1.1. -- `#80 `_: Can now set logging level which is harmonized between Java and Python. -- `#79 `_: Adding a deprecated-warning for `ixmp.Scenario` with `scheme=='MESSAGE'`. -- `#76 `_: Changing the API from ``mp.Scenario(...)`` to ``ixmp.Scenario(mp, ...)``. -- `#73 `_: Adding a function :meth:`~.Scenario.has_solution`, rename kwargs to `..._solution`. -- `#69 `_: Bring retixmp available to other users. -- `#64 `_: Support writing multiple sheets to Excel in utils.pd_write. -- `#61 `_: Now able to connect to multiple databases (Platforms). -- `#58 `_: Add MacOSX support in CI. -- `#52 `_: Add ability to load all scenario data into memory for fast subsequent computation. +- :pull:`88`: Connecting to multiple databases, updating MESSAGE-scheme scenario specifications to version 1.1. +- :pull:`80`: Can now set logging level which is harmonized between Java and Python. +- :pull:`79`: Adding a deprecated-warning for `ixmp.Scenario` with `scheme=='MESSAGE'`. +- :pull:`76`: Changing the API from ``mp.Scenario(...)`` to ``ixmp.Scenario(mp, ...)``. +- :pull:`73`: Adding a function :meth:`~.Scenario.has_solution`, rename kwargs to `..._solution`. +- :pull:`69`: Bring retixmp available to other users. +- :pull:`64`: Support writing multiple sheets to Excel in utils.pd_write. +- :pull:`61`: Now able to connect to multiple databases (Platforms). +- :pull:`58`: Add MacOSX support in CI. +- :pull:`52`: Add ability to load all scenario data into memory for fast subsequent computation. diff --git a/ci/Dockerfile b/ci/Dockerfile index 03eb312b8..d8102472d 100644 --- a/ci/Dockerfile +++ b/ci/Dockerfile @@ -4,7 +4,7 @@ FROM openjdk:11-slim-buster ARG VIRTUAL_ENV=/opt/python3 RUN apt-get update &&\ - apt-get install -y --no-install-recommends curl gcc graphviz python3 \ + apt-get install -y --no-install-recommends curl gcc git graphviz python3 \ python3-dev python3-distlib python3-pip python3-setuptools python3-zmq \ unzip &&\ pip3 install virtualenv &&\ diff --git a/doc/README.rst b/doc/README.rst index f246adb17..95c176d81 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -8,7 +8,7 @@ The documentation of the ix modeling platform is generated from .rst files in Dependencies ------------ -1. Sphinx_ v1.8 or higher +1. Sphinx_ v3.0 or higher 2. `sphinx_rtd_theme` 3. `sphinxcontrib.bibtex` 4. `numpydoc` diff --git a/doc/requirements.txt b/doc/requirements.txt deleted file mode 100644 index 8a2335483..000000000 --- a/doc/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -sphinx -sphinx_rtd_theme -sphinxcontrib-bibtex -numpydoc -nbformat -pytest -jupyter diff --git a/doc/source/api-python.rst b/doc/source/api-python.rst deleted file mode 100644 index 34fea6623..000000000 --- a/doc/source/api-python.rst +++ /dev/null @@ -1,232 +0,0 @@ -.. currentmodule:: ixmp - -Python (:mod:`ixmp` package) -============================ - -The |ixmp| application programming interface (API) is organized around three classes: - -.. autosummary:: - - Platform - TimeSeries - Scenario - -Platform --------- - -.. autoclass:: Platform - :members: - - Platforms have the following methods: - - .. autosummary:: - add_region - add_region_synonym - add_unit - check_access - regions - scenario_list - set_log_level - units - - The methods - :meth:`~.base.Backend.open_db`, - :meth:`~.base.Backend.close_db`, - :meth:`~.base.Backend.get_doc`, and - :meth:`~.base.Backend.set_doc` may also be called via Platform. - - -TimeSeries ----------- - -.. autoclass:: TimeSeries - :members: - - A TimeSeries is uniquely identified on its :class:`Platform` by three - values: - - 1. `model`: the name of a model used to perform calculations between input - and output data. - - - In TimeSeries storing non-model data, arbitrary strings can be used. - - In a :class:`Scenario`, the `model` is a reference to a GAMS program - registered to the :class:`Platform` that can be solved with - :meth:`Scenario.solve`. See :attr:`ixmp.model.MODELS`. - - 2. `scenario`: the name of a specific, coherent description of the real- - world system being modeled. Any `model` may be used to represent multiple - alternate, or 'counter-factual', `scenarios`. - 3. `version`: an integer identifying a specific iteration of a - (`model`, `scenario`). A new `version` is created by: - - - Instantiating a new TimeSeries with the same `model` and `scenario` as - an existing TimeSeries. - - Calling :meth:`Scenario.clone`. - - Optionally, one `version` may be set as a **default version**. See - :meth:`set_as_default`. - - TimeSeries objects have the following methods: - - .. autosummary:: - add_geodata - add_timeseries - check_out - commit - discard_changes - get_geodata - is_default - last_update - preload_timeseries - read_file - remove_geodata - remove_timeseries - run_id - set_as_default - timeseries - - -Scenario --------- - -.. autoclass:: Scenario - :show-inheritance: - :members: - - A Scenario is a :class:`TimeSeries` associated with a particular model that - can be run on the current :class:`Platform` by calling :meth:`solve`. The - Scenario also stores the output, or 'solution' of a model run; this - includes the 'level' and 'marginal' values of GAMS equations and variables. - - Data in a Scenario are closely related to different types in the GAMS data - model: - - - A **set** is a named collection of labels. See :meth:`init_set`, - :meth:`add_set`, and :meth:`set`. There are two types of sets: - - 1. Sets that are lists of labels. - 2. Sets that are 'indexed' by one or more other set(s). For this type of - set, each member is an ordered tuple of the labels in the index sets. - - - A **scalar** is a named, single, numerical value. See - :meth:`init_scalar`, :meth:`change_scalar`, and :meth:`scalar`. - - - **Parameters**, **variables**, and **equations** are multi-dimensional - arrays of values that are indexed by one or more sets (i.e. with - dimension 1 or greater). The Scenario methods for handling these types - are very similar; they mainly differ in how they are used within GAMS - models registered with ixmp: - - - **Parameters** are generic data that can be defined before a model run. - They may be altered by the model solution. See :meth:`init_par`, - :meth:`remove_par`, :meth:`par_list`, :meth:`add_par`, and :meth:`par`. - - **Variables** are calculated during or after a model run by GAMS code, - so they cannot be modified by a Scenario. See :meth:`init_var`, - :meth:`var_list`, and :meth:`var`. - - **Equations** describe fundamental relationships between other types - (parameters, variables, and scalars) in a model. They are defined in - GAMS code, so cannot be modified by a Scenario. See :meth:`init_equ`, - :meth:`equ_list`, and :meth:`equ`. - - .. autosummary:: - add_par - add_set - change_scalar - clone - equ - equ_list - get_meta - has_equ - has_par - has_set - has_solution - has_var - idx_names - idx_sets - init_equ - init_par - init_scalar - init_set - init_var - load_scenario_data - par - par_list - read_excel - remove_par - remove_set - remove_solution - scalar - set - set_list - set_meta - solve - to_excel - var - var_list - - -.. currentmodule:: ixmp.backend.io - -.. automodule:: ixmp.backend.io - :members: EXCEL_MAX_ROWS - - -.. _configuration: - -Configuration -------------- - -When imported, :mod:`ixmp` reads configuration from the first file named -``config.json`` found in one of the following directories: - -1. The directory given by the environment variable ``IXMP_DATA``, if - defined, -2. ``${XDG_DATA_HOME}/ixmp``, if the environment variable is defined, or -3. ``$HOME/.local/share/ixmp``. - -.. tip:: - For most users, #2 or #3 is a sensible default; platform information for many local and remote databases can be stored in ``config.json`` and retrieved by name. - - Advanced users wishing to use a project-specific ``config.json`` can set ``IXMP_DATA`` to the directory containing this file. - -To manipulate the configuration file, use the ``platform`` command in the ixmp command-line interface:: - - # Add a platform named 'p1' backed by a local HSQL database - $ ixmp platform add p1 jdbc hsqldb /path/to/database/files - - # Add a platform named 'p2' backed by a remote Oracle database - $ ixmp platform add p2 jdbc oracle \ - database.server.example.com:PORT:SCHEMA username password - - # Make 'p2' the default Platform - $ ixmp platform add default p2 - -…or, use the methods of :obj:`ixmp.config`. - -.. currentmodule:: ixmp - -.. data:: ixmp.config - - An instance of :class:`~.Config`. - -.. autoclass:: ixmp._config.Config - :members: - - -Utilities ---------- - -.. currentmodule:: ixmp.utils - -.. automodule:: ixmp.utils - :members: format_scenario_list, maybe_check_out, maybe_commit, parse_url, update_par - - -Testing utilities ------------------ - -.. currentmodule:: ixmp.testing - -.. automodule:: ixmp.testing - :members: - :exclude-members: pytest_report_header, pytest_sessionstart diff --git a/doc/source/api-r.rst b/doc/source/api-r.rst new file mode 100644 index 000000000..7df4708f8 --- /dev/null +++ b/doc/source/api-r.rst @@ -0,0 +1,33 @@ +.. _rixmp: + +R (``rixmp`` package) +********************* + +An R interface to the `ixmp` is provided by the ``rixmp`` package. +``rixmp`` uses the `reticulate `_ R-to-Python adapter to provide access to all features of the :mod:`ixmp` *Python* package:: + + # Load the rixmp package + library(rixmp) + ixmp <- import('ixmp') + + # An 'ixmp' object is added to the global namespace. + # It can be used in the same way as the Python ixmp package. + mp <- ixmp$Platform(dbtype = 'HSQLDB') + scen <- ixmp$Scenario(mp, 'model name', 'scenario name', version = 'new') + + # etc. + +One additional method, :meth:`adapt_to_ret` is provided. +Access its documentation with:: + + ?rixmp::adapt_to_ret + +This function is useful when adding :class:`data.frames` objects to a Scenario:: + + scen$init_set("i") + i.set = c("seattle", "san-diego") + scen$add_set("i", i.set) + # load dataframes + scen$init_par("a", c("i")) + a.df = data.frame(i = i.set, value = c(350, 600) , unit = 'cases') + scen$add_par("a", adapt_to_ret(a.df)) diff --git a/doc/source/api.rst b/doc/source/api.rst index b90bfc423..34fea6623 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -1,49 +1,232 @@ -API reference -============= +.. currentmodule:: ixmp -The `ixmp` has application programming interfaces (API) for efficient scientific workflows and data processing. +Python (:mod:`ixmp` package) +============================ -On separate pages: +The |ixmp| application programming interface (API) is organized around three classes: -.. toctree:: - :maxdepth: 2 +.. autosummary:: - api-python - api-backend - file-io - api-model - reporting + Platform + TimeSeries + Scenario -.. _rixmp: +Platform +-------- -R (``rixmp`` package) ---------------------- +.. autoclass:: Platform + :members: -An R interface to the `ixmp` is provided by the ``rixmp`` package. -``rixmp`` uses the `reticulate `_ R-to-Python adapter to provide access to all features of the :mod:`ixmp` *Python* package:: + Platforms have the following methods: - # Load the rixmp package - library(rixmp) - ixmp <- import('ixmp') + .. autosummary:: + add_region + add_region_synonym + add_unit + check_access + regions + scenario_list + set_log_level + units - # An 'ixmp' object is added to the global namespace. - # It can be used in the same way as the Python ixmp package. - mp <- ixmp$Platform(dbtype = 'HSQLDB') - scen <- ixmp$Scenario(mp, 'model name', 'scenario name', version = 'new') + The methods + :meth:`~.base.Backend.open_db`, + :meth:`~.base.Backend.close_db`, + :meth:`~.base.Backend.get_doc`, and + :meth:`~.base.Backend.set_doc` may also be called via Platform. - # etc. -One additional method, :meth:`adapt_to_ret` is provided. -Access its documentation with:: +TimeSeries +---------- - ?rixmp::adapt_to_ret +.. autoclass:: TimeSeries + :members: -This function is useful when adding :class:`data.frames` objects to a Scenario:: + A TimeSeries is uniquely identified on its :class:`Platform` by three + values: - scen$init_set("i") - i.set = c("seattle", "san-diego") - scen$add_set("i", i.set) - # load dataframes - scen$init_par("a", c("i")) - a.df = data.frame(i = i.set, value = c(350, 600) , unit = 'cases') - scen$add_par("a", adapt_to_ret(a.df)) + 1. `model`: the name of a model used to perform calculations between input + and output data. + + - In TimeSeries storing non-model data, arbitrary strings can be used. + - In a :class:`Scenario`, the `model` is a reference to a GAMS program + registered to the :class:`Platform` that can be solved with + :meth:`Scenario.solve`. See :attr:`ixmp.model.MODELS`. + + 2. `scenario`: the name of a specific, coherent description of the real- + world system being modeled. Any `model` may be used to represent multiple + alternate, or 'counter-factual', `scenarios`. + 3. `version`: an integer identifying a specific iteration of a + (`model`, `scenario`). A new `version` is created by: + + - Instantiating a new TimeSeries with the same `model` and `scenario` as + an existing TimeSeries. + - Calling :meth:`Scenario.clone`. + + Optionally, one `version` may be set as a **default version**. See + :meth:`set_as_default`. + + TimeSeries objects have the following methods: + + .. autosummary:: + add_geodata + add_timeseries + check_out + commit + discard_changes + get_geodata + is_default + last_update + preload_timeseries + read_file + remove_geodata + remove_timeseries + run_id + set_as_default + timeseries + + +Scenario +-------- + +.. autoclass:: Scenario + :show-inheritance: + :members: + + A Scenario is a :class:`TimeSeries` associated with a particular model that + can be run on the current :class:`Platform` by calling :meth:`solve`. The + Scenario also stores the output, or 'solution' of a model run; this + includes the 'level' and 'marginal' values of GAMS equations and variables. + + Data in a Scenario are closely related to different types in the GAMS data + model: + + - A **set** is a named collection of labels. See :meth:`init_set`, + :meth:`add_set`, and :meth:`set`. There are two types of sets: + + 1. Sets that are lists of labels. + 2. Sets that are 'indexed' by one or more other set(s). For this type of + set, each member is an ordered tuple of the labels in the index sets. + + - A **scalar** is a named, single, numerical value. See + :meth:`init_scalar`, :meth:`change_scalar`, and :meth:`scalar`. + + - **Parameters**, **variables**, and **equations** are multi-dimensional + arrays of values that are indexed by one or more sets (i.e. with + dimension 1 or greater). The Scenario methods for handling these types + are very similar; they mainly differ in how they are used within GAMS + models registered with ixmp: + + - **Parameters** are generic data that can be defined before a model run. + They may be altered by the model solution. See :meth:`init_par`, + :meth:`remove_par`, :meth:`par_list`, :meth:`add_par`, and :meth:`par`. + - **Variables** are calculated during or after a model run by GAMS code, + so they cannot be modified by a Scenario. See :meth:`init_var`, + :meth:`var_list`, and :meth:`var`. + - **Equations** describe fundamental relationships between other types + (parameters, variables, and scalars) in a model. They are defined in + GAMS code, so cannot be modified by a Scenario. See :meth:`init_equ`, + :meth:`equ_list`, and :meth:`equ`. + + .. autosummary:: + add_par + add_set + change_scalar + clone + equ + equ_list + get_meta + has_equ + has_par + has_set + has_solution + has_var + idx_names + idx_sets + init_equ + init_par + init_scalar + init_set + init_var + load_scenario_data + par + par_list + read_excel + remove_par + remove_set + remove_solution + scalar + set + set_list + set_meta + solve + to_excel + var + var_list + + +.. currentmodule:: ixmp.backend.io + +.. automodule:: ixmp.backend.io + :members: EXCEL_MAX_ROWS + + +.. _configuration: + +Configuration +------------- + +When imported, :mod:`ixmp` reads configuration from the first file named +``config.json`` found in one of the following directories: + +1. The directory given by the environment variable ``IXMP_DATA``, if + defined, +2. ``${XDG_DATA_HOME}/ixmp``, if the environment variable is defined, or +3. ``$HOME/.local/share/ixmp``. + +.. tip:: + For most users, #2 or #3 is a sensible default; platform information for many local and remote databases can be stored in ``config.json`` and retrieved by name. + + Advanced users wishing to use a project-specific ``config.json`` can set ``IXMP_DATA`` to the directory containing this file. + +To manipulate the configuration file, use the ``platform`` command in the ixmp command-line interface:: + + # Add a platform named 'p1' backed by a local HSQL database + $ ixmp platform add p1 jdbc hsqldb /path/to/database/files + + # Add a platform named 'p2' backed by a remote Oracle database + $ ixmp platform add p2 jdbc oracle \ + database.server.example.com:PORT:SCHEMA username password + + # Make 'p2' the default Platform + $ ixmp platform add default p2 + +…or, use the methods of :obj:`ixmp.config`. + +.. currentmodule:: ixmp + +.. data:: ixmp.config + + An instance of :class:`~.Config`. + +.. autoclass:: ixmp._config.Config + :members: + + +Utilities +--------- + +.. currentmodule:: ixmp.utils + +.. automodule:: ixmp.utils + :members: format_scenario_list, maybe_check_out, maybe_commit, parse_url, update_par + + +Testing utilities +----------------- + +.. currentmodule:: ixmp.testing + +.. automodule:: ixmp.testing + :members: + :exclude-members: pytest_report_header, pytest_sessionstart diff --git a/doc/source/conf.py b/doc/source/conf.py index 7f7846539..7cc6ec267 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,43 +1,43 @@ -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# message documentation build configuration file, created by -# sphinx-quickstart on Mon Feb 8 16:15:24 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. # -# All configuration values have a default; values that are commented out -# serve to show the default. +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) -import sys -import os # Import so that autodoc can find code import ixmp import ixmp.testing -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ------------------------------------------------ +# -- Project information ----------------------------------------------------- + +project = 'ix modeling platform' +copyright = '2020, IIASA Energy Program' +author = 'ixmp Developers' + -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -sys.path.append(os.path.abspath('exts')) extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.coverage', 'sphinx.ext.doctest', + 'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.napoleon', @@ -48,279 +48,64 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'ix modeling platform' -copyright = u'2020, IIASA Energy Program' -author = u'ixmp Developers' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = ixmp.__version__ -# The full version, including alpha/beta/rc tags. -release = ixmp.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True +# A string of reStructuredText that will be included at the beginning of every +# source file that is read. +version = ixmp.__version__ +rst_prolog = r""" +.. |MESSAGEix| replace:: MESSAGE\ :emphasis:`ix` -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False +.. |ixmp| replace:: :emphasis:`ix modeling platform` -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +.. |version| replace:: {} -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +.. role:: strike -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +.. role:: underline -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +""".format(version) -# -- Options for HTML output ---------------------------------------------- +# -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'sphinx_rtd_theme' -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {"minimal_width": '1200px'} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# A list of CSS files. +html_css_files = ["custom.css"] # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = '_static/logo_white.png' -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -def setup(app): - app.add_stylesheet('custom.css') - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# -- Options for sphinx.ext.extlinks ------------------------------------------ -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'MESSAGEix_doc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - #'preamble': '', - - # Latex figure (float) alignment - #'figure_align': 'htbp', +extlinks = { + 'pull': ("https://github.com/iiasa/ixmp/pull/%s", 'PR #'), } -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'message.tex', u'message Documentation', - u'IIASA Energy Program', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'message', u'ixmp Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False +# -- Options for sphinx.ext.intersphinx --------------------------------------- -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'message', u'ixmp Documentation', - author, 'message', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), 'dask': ('https://docs.dask.org/en/stable/', None), 'jpype': ('https://jpype.readthedocs.io/en/latest', None), 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None), 'pint': ('https://pint.readthedocs.io/en/stable/', None), + 'python': ('https://docs.python.org/3/', None), 'xarray': ('https://xarray.pydata.org/en/stable/', None), } +# -- Options for sphinx.tex.todo ---------------------------------------------- -# prolog for all rst files -rst_prolog = """ -.. |MESSAGEix| replace:: MESSAGE\ :emphasis:`ix` - -.. |ixmp| replace:: :emphasis:`ix modeling platform` - -.. |version| replace:: {} - -.. role:: strike - -.. role:: underline - -""".format(version) +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/doc/source/index.rst b/doc/source/index.rst index 03cbd88a9..006f0006e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,39 +30,78 @@ For the scientific reference, see Huppmann et al. (2019) modeling platform, database backend, implementation of the |MESSAGEix| mathematical model formulation -Platform documentation ----------------------- + +Getting started +--------------- .. toctree:: + :caption: Getting started + :hidden: :maxdepth: 2 install tutorials - Scientific programming API reference - whatsnew - bibliography +- :doc:`install` +- :doc:`tutorials` -License and user guidelines ---------------------------- -The |ixmp| is licensed under an `APACHE 2.0 open-source license`_. +Scientific programming API +-------------------------- -.. _`APACHE 2.0 open-source license`: http://www.apache.org/licenses/LICENSE-2.0 -.. _`LICENSE`: https://github.com/iiasa/ixmp/blob/master/LICENSE +.. toctree:: + :caption: Scientific programming API + :hidden: + :maxdepth: 2 + + api + api-r + api-backend + file-io + api-model + reporting + +The `ixmp` has application programming interfaces (API) for efficient scientific workflows and data processing. + +- :doc:`api` +- :doc:`api-r` +- :doc:`api-backend` +- :doc:`file-io` +- :doc:`api-model` +- :doc:`reporting` -Please see the :doc:`notice` for using the platform in scientific research. -Contributions to the platform itself are also welcome. + +Help & reference +---------------- The community mailing list for questions and discussions on new features is hosted using Google Groups. -Please join at `groups.google.com/d/forum/message_ix`_ -and use to send an email to the |MESSAGEix| user community. +Please join at `groups.google.com/d/forum/message_ix`_ and use to send an email to the |MESSAGEix| user community. + +.. _`groups.google.com/d/forum/message_ix` : https://groups.google.com/d/forum/message_ix .. toctree:: - :maxdepth: 1 + :caption: Help & reference + :hidden: + :maxdepth: 2 + whatsnew + bibliography notice contributing contributor_license -.. _`groups.google.com/d/forum/message_ix` : https://groups.google.com/d/forum/message_ix +- :doc:`whatsnew` +- :doc:`bibliography` + + +License & user guidelines +------------------------- + +The |ixmp| is licensed under an `APACHE 2.0 open-source license`_. + +.. _`APACHE 2.0 open-source license`: http://www.apache.org/licenses/LICENSE-2.0 +.. _`LICENSE`: https://github.com/iiasa/ixmp/blob/master/LICENSE + + +Please see the :doc:`notice` for using the platform in scientific research. +:doc:`Contributions ` to the platform itself are also welcome; new contributors are asked to sign a :doc:`contributor_license`. diff --git a/doc/source/reporting.rst b/doc/source/reporting.rst index e0326a19c..aadc92247 100644 --- a/doc/source/reporting.rst +++ b/doc/source/reporting.rst @@ -3,11 +3,6 @@ Reporting ========= -.. warning:: - - :mod:`ixmp.reporting` is **experimental** in ixmp 2.0. - The API and functionality may change without advance notice or a deprecation period in subsequent releases. - Top-level methods and classes: .. autosummary:: diff --git a/ixmp/__init__.py b/ixmp/__init__.py index 68d0a32cf..b56206934 100644 --- a/ixmp/__init__.py +++ b/ixmp/__init__.py @@ -1,7 +1,8 @@ import logging +from pkg_resources import get_distribution, DistributionNotFound + from ._config import config -from ._version import get_versions from .backend import BACKENDS, ItemType from .backend.jdbc import JDBCBackend from .core import IAMC_IDX, Platform, Scenario, TimeSeries @@ -23,8 +24,11 @@ 'show_versions', ] -__version__ = get_versions()['version'] -del get_versions +try: + __version__ = get_distribution(__name__).version +except DistributionNotFound: + # Package is not installed + __version__ = "999" # Register Backends provided by ixmp BACKENDS['jdbc'] = JDBCBackend diff --git a/ixmp/_config.py b/ixmp/_config.py index 4f0194bf1..93b10908a 100644 --- a/ixmp/_config.py +++ b/ixmp/_config.py @@ -65,10 +65,9 @@ def _locate(filename=None): tried.append(str(directory)) if filename: - raise FileNotFoundError('Could not find {} in {!r}' - .format(filename, tried)) + raise FileNotFoundError(f'Could not find {filename} in {repr(tried)}') else: - raise FileNotFoundError('Could not find any of {!r}'.format(tried)) + raise FileNotFoundError(f'Could not find any of {repr(tried)}') class Config: @@ -137,8 +136,8 @@ def register(self, name, type, default=None): to supply the default, value, e.g. ``str()``. """ if name in KEYS: - raise KeyError('configuration key {!r} already defined' - .format(name)) + raise KeyError(f'configuration key {repr(name)} already defined') + # Register the key for future clear() KEYS[name] = (type, default) @@ -157,8 +156,10 @@ def set(self, name, value): # Attempt to cast to the correct type value = type_(value) except Exception: - raise TypeError('expected {} for {!r}; got {} {!r}' - .format(type_, name, type(value), value)) + raise TypeError( + f'expected {type_} for {repr(name)}; got {type(value)} ' + f'{repr(value)}' + ) self.values[name] = value @@ -235,7 +236,9 @@ def add_platform(self, name, *args, **kwargs): info = args[0] if info not in self.values['platform']: - raise ValueError("cannot set unknown {!r} as default platform") + raise ValueError( + f'Cannot set unknown {repr(info)} as default platform' + ) else: cls = args.pop(0) info = {'class': cls} @@ -261,8 +264,10 @@ def add_platform(self, name, *args, **kwargs): raise ValueError(cls) if name in self.values['platform']: - log.warning('Overwriting existing config: {!r}' - .format(self.values['platform'][name])) + log.warning( + 'Overwriting existing config: ' + + repr(self.values['platform'][name]) + ) self.values['platform'][name] = info @@ -292,10 +297,11 @@ def get_platform_info(self, name): try: return name, copy(self.values['platform'][name]) except KeyError: - message = 'platform name {!r} not among {!r}\nfrom {}' \ - .format(name, sorted(self.values['platform'].keys()), - self.path) - raise ValueError(message) + raise ValueError( + f'platform name {repr(name)} not among ' + + repr(sorted(self.values['platform'].keys())) + + f'\nfrom {self.path}' + ) def remove_platform(self, name): """Remove the configuration for platform *name*.""" diff --git a/ixmp/_version.py b/ixmp/_version.py deleted file mode 100644 index f5206fab9..000000000 --- a/ixmp/_version.py +++ /dev/null @@ -1,520 +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.18 (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$" - git_date = "$Format:%ci$" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - 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-pre" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "ixmp-" - cfg.versionfile_source = "ixmp/_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, - env=None): - """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, env=env, - 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, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, 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) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -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. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@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) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = 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") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - 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 = set([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(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, - "date": date} - # 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", "date": 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. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # 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) - describe_out, rc = 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, rc = 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 - - # 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, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -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 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"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -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", - "date": None} - - 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", "date": None} diff --git a/ixmp/backend/io.py b/ixmp/backend/io.py index a0a968a2a..87b4c0aac 100644 --- a/ixmp/backend/io.py +++ b/ixmp/backend/io.py @@ -142,9 +142,10 @@ def maybe_init_item(scenario, ix_type, name, new_idx, path): # Check for ambiguous index names ambiguous_idx = sorted(set(new_idx or []) - set(scenario.set_list())) if len(ambiguous_idx): - msg = (f'Cannot read {ix_type} {name!r}: index set(s) cannot be ' - f'inferred for name(s) {ambiguous_idx}') - log.warning(msg) + log.warning( + f'Cannot read {ix_type} {repr(name)}: index set(s) cannot be ' + f'inferred for name(s) {ambiguous_idx}' + ) raise ValueError from None # Initialize @@ -157,9 +158,10 @@ def maybe_init_item(scenario, ix_type, name, new_idx, path): new_idx = None if existing_names != new_idx: - msg = (f'Existing {ix_type} {name!r} has index names(s) ' - f' {existing_names} != {new_idx} in {path.name}') - log.warning(msg) + log.warning( + f'Existing {ix_type} {repr(name)} has index names(s) ' + f' {existing_names} != {new_idx} in {path.name}' + ) raise ValueError from None @@ -247,7 +249,7 @@ def parse_item_sheets(name): try: s.add_set(name, data) except KeyError: - raise ValueError(f'no set {name!r}; try init_items=True') + raise ValueError(f'no set {repr(name)}; try init_items=True') if commit_steps: s.commit(f'Loaded sets from {path}') @@ -260,7 +262,7 @@ def parse_item_sheets(name): # Add equ/par/var data for name, ix_type in name_type[name_type != 'set'].items(): if ix_type in ('equ', 'var'): - log.info(f'Cannot read {ix_type} {name!r}') + log.info(f'Cannot read {ix_type} {repr(name)}') continue # Only parameters beyond this point @@ -301,5 +303,5 @@ def parse_item_sheets(name): if commit_steps: # Commit after every parameter - s.commit(f'Loaded {ix_type} {name!r} from {path}') + s.commit(f'Loaded {ix_type} {repr(name)} from {path}') s.check_out() diff --git a/ixmp/backend/jdbc.py b/ixmp/backend/jdbc.py index 5f0b7e602..054527623 100644 --- a/ixmp/backend/jdbc.py +++ b/ixmp/backend/jdbc.py @@ -79,7 +79,9 @@ def _create_properties(driver=None, path=None, url=None, user=None, try: properties.setProperty('jdbc.driver', DRIVER_CLASS[driver]) except KeyError: - raise ValueError(f'unrecognized/unsupported JDBC driver {driver!r}') + raise ValueError( + f'unrecognized/unsupported JDBC driver {repr(driver)}' + ) if driver == 'oracle': if url is None or path is not None: @@ -241,7 +243,7 @@ def __init__(self, jvmargs=None, **kwargs): if jclass.endswith('HikariPool.PoolInitializationException'): redacted = copy(kwargs) redacted.update({'user': '(HIDDEN)', 'password': '(HIDDEN)'}) - msg = f'unable to connect to database:\n{redacted!r}' + msg = f'unable to connect to database:\n{repr(redacted)}' elif jclass.endswith('FlywayException'): msg = f'when initializing database:' _raise_jexception(e, f'{msg}\n(Java: {jclass})') @@ -522,7 +524,7 @@ def get(self, ts): if match: param = match.group(1).lower() if param in ('model', 'scenario'): - raise ValueError(f'{param}={getattr(ts, param)!r}') + raise ValueError(f'{param}={repr(getattr(ts, param))}') # Failed _raise_jexception(e) @@ -701,8 +703,10 @@ def init_item(self, s, type, name, idx_sets, idx_names): if idx_names: if len(idx_names) != len(idx_sets): - raise ValueError(f'index names {idx_names!r} must have same' - f'length as index sets {idx_sets!r}') + raise ValueError( + f'index names {repr(idx_names)} must have same length as ' + f'index sets {repr(idx_sets)}' + ) idx_names = to_jlist(idx_names) else: idx_names = idx_sets @@ -716,7 +720,7 @@ def init_item(self, s, type, name, idx_sets, idx_names): func(name, idx_sets, idx_names) except jpype.JException as e: if 'already exists' in e.args[0]: - raise ValueError(f'{name!r} already exists') + raise ValueError(f'{repr(name)} already exists') else: _raise_jexception(e) diff --git a/ixmp/cli.py b/ixmp/cli.py index bcdb952e2..293df0690 100644 --- a/ixmp/cli.py +++ b/ixmp/cli.py @@ -20,7 +20,7 @@ def convert(self, value, param, ctx): try: return int(value) except ValueError: - self.fail(f"{value!r} must be an integer or 'new'") + self.fail(f"{repr(value)} must be an integer or 'new'") @click.group() @@ -230,7 +230,7 @@ def platform(action, name, values): if action == 'remove': assert len(values) == 0 ixmp.config.remove_platform(name) - print('Removed platform config for {!r}'.format(name)) + print(f'Removed platform config for {repr(name)}') elif action == 'add': ixmp.config.add_platform(name, *values) diff --git a/ixmp/core.py b/ixmp/core.py index c5f15d82a..5b7b8e1d2 100644 --- a/ixmp/core.py +++ b/ixmp/core.py @@ -88,8 +88,10 @@ def __init__(self, name=None, backend=None, **backend_args): backend_class = kwargs.pop('class') backend_class = BACKENDS[backend_class] except KeyError: - raise ValueError('backend class {!r} not among {}' - .format(backend_class, sorted(BACKENDS.keys()))) + raise ValueError( + f'backend class {repr(backend_class)} not among ' + + str(sorted(BACKENDS.keys())) + ) # Instantiate the backend self._backend = backend_class(**kwargs) @@ -267,9 +269,13 @@ def _existing_node(self, name): continue log.warning( - f'region {name!r} is already defined on the Platform' - + (f' as a synonym for {r.mapped_to!r}' if r.mapped_to else '') - + (f' under parent {r.parent!r}' if r.parent else '')) + f'region {repr(name)} is already defined on the Platform' + + ( + f' as a synonym for {repr(r.mapped_to)}' if r.mapped_to + else '' + ) + + (f' under parent {repr(r.parent)}' if r.parent else '') + ) return True return False @@ -424,10 +430,12 @@ def __init__(self, mp, model, scenario, version=None, annotation=None, if not isinstance(mp, Platform): raise TypeError('mp is not a valid `ixmp.Platform` instance') elif version and not (version == 'new' or isinstance(version, int)): - raise ValueError(f'version={version!r}') + raise ValueError(f'version={repr(version)}') elif version == 'new' and annotation is None: - log.warning(f'Missing annotation for new {self.__class__.__name__}' - f' {model}/{scenario}') + log.warning( + f'Missing annotation for new {self.__class__.__name__}' + f' {model}/{scenario}' + ) annotation = '' # scheme= keyword argument only passed from Scenario.__init__; @@ -864,8 +872,10 @@ def from_url(cls, url, errors='warn'): scenario = cls(platform, **scenario_info) except Exception as e: if errors == 'warn': - log.warning('{}: {}\nwhen loading Scenario from url: {!r}' - .format(e.__class__.__name__, e.args[0], url)) + log.warning( + f'{e.__class__.__name__}: {e.args[0]}\n' + f'when loading Scenario from url: {repr(url)}' + ) return None, platform else: raise @@ -1028,8 +1038,9 @@ def add_set(self, name, key, comment=None): if len(idx_names) == 0: # Basic set. Keys must be strings. if isinstance(key, (dict, pd.DataFrame)): - raise ValueError('dict, DataFrame keys invalid for ' - f'basic set {name!r}') + raise ValueError( + 'dict, DataFrame keys invalid for basic set {repr(name)}' + ) # Ensure keys is a list of str keys = as_str_list(key) @@ -1087,12 +1098,14 @@ def add_set(self, name, key, comment=None): for e, c in to_add: # Check for sentinel values if e is False: - raise ValueError(f'Comment {c!r} without matching key') + raise ValueError(f'Comment {repr(c)} without matching key') elif c is False: - raise ValueError(f'Key {e!r} without matching comment') + raise ValueError(f'Key {repr(e)} without matching comment') elif len(idx_names) and len(idx_names) != len(e): - raise ValueError(f'{len(e)}-D key {e!r} invalid for ' - f'{len(idx_names)}-D set {name}{idx_names!r}') + raise ValueError( + f'{len(e)}-D key {repr(e)} invalid for ' + f'{len(idx_names)}-D set {name}{repr(idx_names)}' + ) # Send to backend elements = ((kc[0], None, None, kc[1]) for kc in to_add) @@ -1526,7 +1539,7 @@ def solve(self, model=None, callback=None, cb_kwargs={}, **model_options): # Validate *callback* argument if callback is not None and not callable(callback): - raise ValueError('callback={!r} is not callable'.format(callback)) + raise ValueError(f'callback={repr(callback)} is not callable') elif callback is None: # Make the callback a no-op def callback(scenario, **kwargs): @@ -1689,7 +1702,7 @@ def to_iamc_layout(df): required_cols = ['region', 'variable', 'unit'] missing = list(set(required_cols) - set(df.columns)) if len(missing): - raise ValueError(f'missing required columns {missing!r}') + raise ValueError(f'missing required columns {repr(missing)}') # Add a column 'subannual' with the default value if 'subannual' not in df.columns: diff --git a/ixmp/model/base.py b/ixmp/model/base.py index a73d573fc..74e3c52a8 100644 --- a/ixmp/model/base.py +++ b/ixmp/model/base.py @@ -43,8 +43,9 @@ def initialize(cls, scenario): -------- initialize_items """ - log.debug('No initialization for {!r}-scheme Scenario' - .format(scenario.scheme)) + log.debug( + f'No initialization for {repr(scenario.scheme)}-scheme Scenario' + ) @classmethod def initialize_items(cls, scenario, items): @@ -70,8 +71,8 @@ def initialize_items(cls, scenario, items): Raises ------ ValueError - if `scenario` has a solution, i.e. :meth:`.has_solution` is - :obj:`True`. + if `scenario` has a solution, i.e. :meth:`~.Scenario.has_solution` + is :obj:`True`. See also -------- diff --git a/ixmp/reporting/__init__.py b/ixmp/reporting/__init__.py index d9815b366..8e0341765 100644 --- a/ixmp/reporting/__init__.py +++ b/ixmp/reporting/__init__.py @@ -65,7 +65,7 @@ class KeyExistsError(KeyError): def __str__(self): - return f'key {self.args[0]!r} already exists' + return f'key {repr(self.args[0])} already exists' class MissingKeyError(KeyError): diff --git a/ixmp/reporting/computations.py b/ixmp/reporting/computations.py index aa41b0840..4f95b7f5a 100644 --- a/ixmp/reporting/computations.py +++ b/ixmp/reporting/computations.py @@ -138,8 +138,10 @@ def data_for_quantity(ix_type, name, column, scenario, config): # TODO construct an empty Quantity with the correct dimensions *even if* no # values are returned. if len(data) == 0: - log.warning(f'0 values for {ix_type} {name!r} using filters:' - f'\n {filters!r}\n Subsequent computations may fail.') + log.warning( + f'0 values for {ix_type} {repr(name)} using filters:\n' + f' {repr(filters)}\n Subsequent computations may fail.' + ) # Convert categorical dtype to str data = data.astype({col: str for col in idx_names}) diff --git a/ixmp/reporting/utils.py b/ixmp/reporting/utils.py index 580fec739..295db9c19 100644 --- a/ixmp/reporting/utils.py +++ b/ixmp/reporting/utils.py @@ -85,7 +85,7 @@ def filter_concat_args(args): """ for arg in args: if isinstance(arg, (str, Key)): - log.warn('concat() argument {arg!r} missing; will be omitted') + log.warn('concat() argument {repr(arg)} missing; will be omitted') continue yield arg diff --git a/ixmp/testing.py b/ixmp/testing.py index 278f1ea0a..4ccc8485d 100644 --- a/ixmp/testing.py +++ b/ixmp/testing.py @@ -84,7 +84,7 @@ def pytest_sessionstart(session): def pytest_report_header(config, startdir): """Add the ixmp configuration to the pytest report header.""" - return 'ixmp config: {!r}'.format(ixmp_config.values) + return f'ixmp config: {repr(ixmp_config.values)}' @pytest.fixture(scope='session') @@ -217,7 +217,7 @@ def create_test_platform(tmp_path, data_path, name, **properties): any_files = True if not any_files: - raise ValueError(f'no files for test platform {name!r}') + raise ValueError(f'no files for test platform {repr(name)}') # Create properties file props_file = (tmp_path / name).with_suffix('.properties') diff --git a/ixmp/tests/core/test_platform.py b/ixmp/tests/core/test_platform.py index ddb3207f7..86a87b2bd 100644 --- a/ixmp/tests/core/test_platform.py +++ b/ixmp/tests/core/test_platform.py @@ -1,5 +1,4 @@ """Test all functionality of ixmp.Platform.""" -import logging from sys import getrefcount from weakref import getweakrefcount diff --git a/ixmp/tests/core/test_scenario.py b/ixmp/tests/core/test_scenario.py index ee0e7eb73..4b9cfa76a 100644 --- a/ixmp/tests/core/test_scenario.py +++ b/ixmp/tests/core/test_scenario.py @@ -32,6 +32,7 @@ def test_dict(): 'test_bool_false': False, } + class TestScenario: # Initialize Scenario def test_init(self, test_mp, scen_empty): @@ -77,8 +78,10 @@ def test_from_url(self, mp, caplog): scen, mp = ixmp.Scenario.from_url(url + '#10000', errors='raise') # Giving an invalid scenario with errors='warn' raises an exception - msg = ("ValueError: scenario='Hitchhikerfoo'\nwhen loading Scenario " - f"from url: {(url + 'foo')!r}") + msg = ( + "ValueError: scenario='Hitchhikerfoo'\n" + f"when loading Scenario from url: {repr(url + 'foo')}" + ) with assert_logs(caplog, msg): scen, mp = ixmp.Scenario.from_url(url + 'foo') assert scen is None and isinstance(mp, ixmp.Platform) diff --git a/ixmp/tests/core/test_timeseries.py b/ixmp/tests/core/test_timeseries.py index 6d6109197..8522cd7e4 100644 --- a/ixmp/tests/core/test_timeseries.py +++ b/ixmp/tests/core/test_timeseries.py @@ -76,6 +76,7 @@ COLS_WITH_SUBANNUAL = COLS_FOR_YEARLY_DATA.copy() COLS_WITH_SUBANNUAL.insert(4, 'subannual') + # Utility methods def expected(df, ts): """Modify *df* with the 'model' and 'scenario' name from *ts.""" diff --git a/ixmp/tests/reporting/test_reporting.py b/ixmp/tests/reporting/test_reporting.py index 7ae3e9d73..5aa04d1f2 100644 --- a/ixmp/tests/reporting/test_reporting.py +++ b/ixmp/tests/reporting/test_reporting.py @@ -90,9 +90,12 @@ def gen(other): def msg(*keys): """Return a regex for str(MissingKeyError(*keys)).""" - return 'required keys {!r} not defined'.format(tuple(keys)) \ - .replace('(', '\\(') \ - .replace(')', '\\)') + return ( + f'required keys {repr(tuple(keys))} not defined' + .replace('(', '\\(') + .replace(')', '\\)') + ) + # One missing key with pytest.raises(MissingKeyError, match=msg('b')): r.add_product('ab', 'a', 'b') @@ -783,10 +786,7 @@ def assert_t_indices(labels): # Write a temporary file containing the desired labels config_file = tmp_path / 'config.yaml' - config_file.write_text('\n'.join([ - 'filters:', - ' t: {!r}'.format(t_bar), - ])) + config_file.write_text('\n'.join(['filters:', f' t: {repr(t_bar)}'])) rep.configure(config_file) assert_t_indices(t_bar) diff --git a/ixmp/utils.py b/ixmp/utils.py index 6d5018731..a597e2237 100644 --- a/ixmp/utils.py +++ b/ixmp/utils.py @@ -83,7 +83,7 @@ def maybe_check_out(timeseries, state=None): ------ ValueError If `timeseries` is a :class:`.Scenario` object and - :meth:`.has_solution` is :obj:`True`. + :meth:`~.Scenario.has_solution` is :obj:`True`. See Also -------- diff --git a/setup.cfg b/setup.cfg index 8569cc6da..15abeb7f7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,11 +1,47 @@ -[versioneer] -VCS = git -# This must be 'pep440-pre', 'git-describe', or another style without '+', due # to issues on Windows loading Java objects with '+' characters in the path. -style = pep440-pre -versionfile_source = ixmp/_version.py -versionfile_build = ixmp/_version.py -tag_prefix = v -parentdir_prefix = ixmp- +[metadata] +name = ixmp +author = IIASA Energy Program +author_email = message_ix@iiasa.ac.at +license = Apache +description = ix modeling platform +long_description_content_type = text/markdown +long_description = file:README.md +url = https://github.com/iiasa/ixmp + +[options] +packages = ixmp +zip_safe = True +include_package_data = True +install_requires = + JPype1 >= 0.7.5 + click + dask [array] + graphviz + pandas >= 1.0 + pint + PyYAML + xarray + xlrd + xlsxwriter +setup_requires = + setuptools >= 41 + setuptools_scm + +[options.extras_require] +tests = + codecov + jupyter + memory_profiler + pretenders >= 1.4.4 + pytest >= 5 + pytest-cov + sparse +docs = numpydoc; sphinx >= 3.0; sphinx_rtd_theme; sphinxcontrib-bibtex +tutorial = jupyter + +[options.entry_points] +console_scripts = + ixmp = ixmp.cli:main [tool:pytest] # Disable faulthandler plugin on Windows to prevent spurious console noise; see diff --git a/setup.py b/setup.py index 034704e05..76755a445 100644 --- a/setup.py +++ b/setup.py @@ -1,54 +1,4 @@ #!/usr/bin/env python -import glob +from setuptools import setup -from setuptools import find_packages, setup -import versioneer - - -with open('README.md', 'r') as f: - LONG_DESCRIPTION = f.read() - -INSTALL_REQUIRES = [ - 'JPype1 >= 0.7.5', - 'click', - 'dask[array]', - 'graphviz', - 'pandas>=1.0', - 'pint', - 'PyYAML', - 'xarray', - 'xlsxwriter', - 'xlrd', -] - -EXTRAS_REQUIRE = { - 'tests': ['codecov', 'jupyter', 'memory_profiler', 'pretenders>=1.4.4', - 'pytest-cov', 'pytest>=5', 'sparse'], - 'docs': ['numpydoc', 'sphinx', 'sphinx_rtd_theme', 'sphinxcontrib-bibtex'], - 'tutorial': ['jupyter'], -} - -LIB_FILES = [x.split('ixmp/')[-1] for x in glob.glob('ixmp/lib/*')] -MODEL_FILES = ['model/dantzig.gms'] - -setup( - name='ixmp', - version=versioneer.get_version(), - description='ix modeling platform', - author='IIASA Energy Program', - author_email='message_ix@iiasa.ac.at', - long_description=LONG_DESCRIPTION, - long_description_content_type='text/markdown', - url='https://github.com/iiasa/ixmp', - cmdclass=versioneer.get_cmdclass(), - install_requires=INSTALL_REQUIRES, - extras_require=EXTRAS_REQUIRE, - packages=find_packages(), - package_dir={'ixmp': 'ixmp'}, - package_data={'ixmp': ['ixmp.jar'] + LIB_FILES + MODEL_FILES}, - entry_points={ - 'console_scripts': [ - 'ixmp=ixmp.cli:main', - ], - }, -) +setup(use_scm_version=True) diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index 64fea1c89..000000000 --- a/versioneer.py +++ /dev/null @@ -1,1822 +0,0 @@ - -# Version: 0.18 - -"""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, 3.5, 3.6, 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 - -See [INSTALL.md](./INSTALL.md) for detailed installation instructions. - -## 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". - -* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the - commit date in ISO 8601 format. This will be None if the date is not - available. - -* `['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](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). - -## Known Limitations - -Some situations are known to cause problems for Versioneer. This details the -most significant ones. More can be found on Github -[issues page](https://github.com/warner/python-versioneer/issues). - -### Subprojects - -Versioneer has limited support for source trees in which `setup.py` is not in -the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are -two common reasons why `setup.py` might not be in the root: - -* Source trees which contain multiple subprojects, such as - [Buildbot](https://github.com/buildbot/buildbot), which contains both - "master" and "slave" subprojects, each with their own `setup.py`, - `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI - distributions (and upload multiple independently-installable tarballs). -* Source trees whose main purpose is to contain a C library, but which also - provide bindings to Python (and perhaps other langauges) in subdirectories. - -Versioneer will look for `.git` in parent directories, and most operations -should get the right version string. However `pip` and `setuptools` have bugs -and implementation details which frequently cause `pip install .` from a -subproject directory to fail to find a correct version string (so it usually -defaults to `0+unknown`). - -`pip install --editable .` should work correctly. `setup.py install` might -work too. - -Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in -some later version. - -[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking -this issue. The discussion in -[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the -issue from the Versioneer side in more detail. -[pip PR#3176](https://github.com/pypa/pip/pull/3176) and -[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve -pip to let Versioneer work correctly. - -Versioneer-0.16 and earlier only looked for a `.git` directory next to the -`setup.cfg`, so subprojects were completely unsupported with those releases. - -### Editable installs with setuptools <= 18.5 - -`setup.py develop` and `pip install --editable .` allow you to install a -project into a virtualenv once, then continue editing the source code (and -test) without re-installing after every change. - -"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a -convenient way to specify executable scripts that should be installed along -with the python package. - -These both work as expected when using modern setuptools. When using -setuptools-18.5 or earlier, however, certain operations will cause -`pkg_resources.DistributionNotFound` errors when running the entrypoint -script, which must be resolved by re-installing the package. This happens -when the install happens with one version, then the egg_info data is -regenerated while a different version is checked out. Many setup.py commands -cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into -a different virtualenv), so this can be surprising. - -[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes -this one, but upgrading to a newer version of setuptools should probably -resolve it. - -### Unicode version strings - -While Versioneer works (and is continually tested) with both Python 2 and -Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. -Newer releases probably generate unicode version strings on py2. It's not -clear that this is wrong, but it may be surprising for applications when then -write these strings to a network connection or include them in bytes-oriented -APIs like cryptographic checksums. - -[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates -this question. - - -## 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. See [UPGRADING](./UPGRADING.md) for details. -* re-run `versioneer install` in your source tree, to replace - `SRC/_version.py` -* commit any changed files - -## 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__)) - me_dir = os.path.normcase(os.path.splitext(me)[0]) - vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) - if me_dir != vsr_dir: - 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, - env=None): - """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, env=env, - 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, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, 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) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -LONG_VERSION_PY['git'] = ''' -# 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.18 (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" - git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - 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, - env=None): - """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, env=env, - 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, None - else: - if verbose: - print("unable to find command, tried %%s" %% (commands,)) - return None, 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) - print("stdout was %%s" %% stdout) - return None, p.returncode - return stdout, p.returncode - - -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. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %%s but none started with prefix %%s" %% - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@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) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = 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") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - 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 = set([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(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, - "date": date} - # 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", "date": 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. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %%s not under git control" %% root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # 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) - describe_out, rc = 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, rc = 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 - - # 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, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -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 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"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%%s'" %% style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -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", - "date": None} - - 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", "date": 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) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = 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") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - 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 = set([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(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, - "date": date} - # 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", "date": 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. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # 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) - describe_out, rc = 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, rc = 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 - - # 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, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - 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-subst 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. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.18) 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 - -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: - mo = re.search(r"version_json = '''\r\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"])) - - -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 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"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -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", - "date": None} - - -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")) - print(" date: %s" % vers.get("date")) - 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 -> ? - # pip install: - # copies source tree to a tempdir before running egg_info/etc - # if .git isn't copied too, 'git describe' will fail - # then does setup.py bdist_wheel, or sometimes setup.py install - # setup.py egg_info -> ? - - # 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 - # nczeczulin reports that py2exe won't like the pep440-style string - # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. - # setup(console=[{ - # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION - # "product_version": versioneer.get_version(), - # ... - - 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"] - - if 'py2exe' in sys.modules: # py2exe enabled? - try: - from py2exe.distutils_buildexe import py2exe as _py2exe # py3 - except ImportError: - from py2exe.build_exe import py2exe as _py2exe # py2 - - class cmd_py2exe(_py2exe): - 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) - - _py2exe.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["py2exe"] = cmd_py2exe - - # 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-subst 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)