diff --git a/.coveragerc b/.coveragerc index b40b66b50..c70af4aef 100644 --- a/.coveragerc +++ b/.coveragerc @@ -3,9 +3,9 @@ source = typhos [report] omit = - #tests - */tests/* - *test* #versioning .*version.* *_version.py + #tests + *test* + typhos/tests/* diff --git a/.flake8 b/.flake8 new file mode 100644 index 000000000..beca790cb --- /dev/null +++ b/.flake8 @@ -0,0 +1,23 @@ +[flake8] +exclude = .git,__pycache__,build,dist,typhos/_version.py +max-line-length = 88 +select = C,E,F,W,B,B950 +extend-ignore = E203, E501, E226, W503, W504 + +# Explanation section: +# B950 +# This takes into account max-line-length but only triggers when the value +# has been exceeded by more than 10% (96 characters). +# E203: Whitespace before ':' +# This is recommended by black in relation to slice formatting. +# E501: Line too long (82 > 79 characters) +# Our line length limit is 88 (above 79 defined in E501). Ignore it. +# E226: Missing whitespace around arithmetic operator +# This is a stylistic choice which you'll find everywhere in pcdsdevices, for +# example. Formulas can be easier to read when operators and operands +# have no whitespace between them. +# +# W503: Line break occurred before a binary operator +# W504: Line break occurred after a binary operator +# flake8 wants us to choose one of the above two. Our choice +# is to make no decision. diff --git a/.git_archival.txt b/.git_archival.txt new file mode 100644 index 000000000..8fb235d70 --- /dev/null +++ b/.git_archival.txt @@ -0,0 +1,4 @@ +node: $Format:%H$ +node-date: $Format:%cI$ +describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$ +ref-names: $Format:%D$ diff --git a/.gitattributes b/.gitattributes index 8962cfba1..00a7b00c9 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -typhos/_version.py export-subst +.git_archival.txt export-subst diff --git a/.github/workflows/standard.yml b/.github/workflows/standard.yml new file mode 100644 index 000000000..8987e6ce5 --- /dev/null +++ b/.github/workflows/standard.yml @@ -0,0 +1,24 @@ +name: PCDS Standard Testing + +on: + push: + pull_request: + release: + types: + - created + +jobs: + standard: + uses: pcdshub/pcds-ci-helpers/.github/workflows/python-standard.yml@master + with: + # The workflow needs to know the package name. This can be determined + # automatically if the repository name is the same as the import name. + package-name: "typhos" + # Extras that will be installed for both conda/pip: + testing-extras: "happi" + # Extras to be installed only for conda-based testing: + conda-testing-extras: "pcdsdevices pyqt=5" + # Extras to be installed only for pip-based testing: + pip-testing-extras: "PyQt5<5.15" + # Set if using setuptools-scm for the conda-build workflow + use-setuptools-scm: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b4c020f4..15e7f8cef 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,14 +1,13 @@ # See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks exclude: | - (?x)^( - versioneer.py| - docs/source/conf.py| - typhos/_version.py| - )$ + (?x)^( + typhos/_version.py| + )$ + repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: no-commit-to-branch - id: trailing-whitespace @@ -23,12 +22,12 @@ repos: exclude: '^(conda-recipe/meta.yaml)$' - id: debug-statements -- repo: https://github.com/pycqa/flake8 - rev: 3.9.2 +- repo: https://github.com/pycqa/flake8.git + rev: 6.0.0 hooks: - id: flake8 - repo: https://github.com/timothycrosley/isort - rev: 5.10.1 + rev: 5.11.5 hooks: - id: isort diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index eb2241de6..000000000 --- a/.travis.yml +++ /dev/null @@ -1,23 +0,0 @@ -version: ~> 1.0 - -env: - global: - - secure: "ApdXLC/Yqh5LeiXBMgChaPDgpomEZMjYKUMfWjIiogqqoll1u8cdpyZ6mSUzLA4/F70yclc4SjIYxmGsc+VtpP2LCMvwLHF/vSm39WzxppAfjOZnzmYoxKAUfeL4FKtYf8Nq7sfp+BLTRnInc1TN9U9Kq0SIF/ro6p6xCh13cu7q9pZVJwdgp3EdqzL/+Hat8Z71dZDMyEc9eF+onzfOexqEZ4TqTR8+VfjKzyAmXm6IMPgn3+X963Zx9QSQqa3PQn3yvesLRvsj9pwbLVbgNkoSYVZeIPL7f1BhdMfy8esOuuipRNhEPIGCHo3+9bdiwN38o3LVogr68/zSShEbY5mN4JBMqgHq4o1LJ2LgAS1R913ys/M0JjZj3zhILXJtjaiCtIk6fPErAkqM/l9EOn7RohFaw0/AXAi1Uxus1P9WsN0rbd+LSiT577X7BC8YGyqLNves6Yp78/8fQyIWBTHwKtb+pa1BNcVMPUWPAoKIFJHlduLc9bUfSPjg1UFTocNiazVznj0OGwDfAeUdhvGc7Z63nWHmoPIUEE2oGzvfI2uQm4hrk+GWM3BILo0rKqb1LvRA89ouovohNL0esM5k7wQb3U3cxESiwC3jsJt3HGtlrp1IfdZjgJ1vCqxm/eZ7rplxewAp+KRBaNe20J3sksT3ZrpAGDGkL1Zy+Wo=" - - - DOCTR_VERSIONS_MENU="1" - - DOCS_REQUIREMENTS="dev-requirements.txt requirements.txt" - - PYTHON_LINT_OPTIONS="typhos" - - - CONDA_PACKAGE="typhos" - - CONDA_RECIPE_FOLDER="conda-recipe" - - CONDA_EXTRAS="pip pyqt=5 happi pcdsdevices" - - CONDA_REQUIREMENTS="dev-requirements.txt" - - - BENCHMARK_PYTHON="3.8" - - BENCHMARK_COMMAND="--benchmark-only" - - - PIP_EXTRAS="PyQt5<5.15 happi ./" - -import: - - pcdshub/pcds-ci-helpers:travis/shared_configs/standard-python-conda.yml - - pcdshub/pcds-ci-helpers:travis/shared_configs/python-benchmark.yml diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 000000000..a99ffb485 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,13 @@ +======= +Credits +======= + +Maintainer +---------- + +* SLAC National Accelerator Laboratory <> + +Contributors +------------ + +Interested? See: `CONTRIBUTING.rst `_ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..6b79424a4 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,103 @@ +============ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every little bit +helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/pcdshub/typhos/issues. + +If you are reporting a bug, please include: + +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" +is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "feature" +is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +typhos could always use more documentation, whether +as part of the official typhos docs, in docstrings, +or even on the web in blog posts, articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at https://github.com/pcdshub/typhos/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. +* Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +Get Started! +------------ + +Ready to contribute? Here's how to set up `typhos` for local development. + +1. Fork the `typhos` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/typhos.git + +3. Install your local copy into a new conda environment. Assuming you have conda installed, this is how you set up your fork for local development:: + + $ conda create -n typhos python=3.9 pip + $ cd typhos/ + $ pip install -e . + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. Install and enable ``pre-commit`` for this repository:: + + $ pip install pre-commit + $ pre-commit install + +6. Add new tests for any additional functionality or bugs you may have discovered. And, of course, be sure that all previous tests still pass by running:: + + $ pytest -v + +7. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +8. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put your + new functionality into a function with a docstring, and add the feature to + the list in README.rst. +3. The pull request should work for Python 3.9 and up. Check the GitHub Actions status + and make sure that the tests pass for all supported Python versions. diff --git a/LICENSE.md b/LICENSE.md index ec090cedb..e14da2c19 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2016, The Board of Trustees of the Leland Stanford Junior +Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/conda-recipe/build.sh b/conda-recipe/build.sh deleted file mode 100644 index 3764c7326..000000000 --- a/conda-recipe/build.sh +++ /dev/null @@ -1,2 +0,0 @@ -# Install the package -$PYTHON setup.py install --single-version-externally-managed --record=record.txt diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml index 2a2f2ca5a..aadaba30c 100644 --- a/conda-recipe/meta.yaml +++ b/conda-recipe/meta.yaml @@ -1,60 +1,88 @@ -{% set data = load_setup_py_data() %} +{% set package_name = "typhos" %} +{% set import_name = "typhos" %} +{% set version = load_file_regex(load_file=os.path.join(import_name, "_version.py"), regex_pattern=".*version = '(\S+)'").group(1) %} package: - name : typhos - version : {{ data.get('version') }} + name: {{ package_name }} + version: {{ version }} source: - path: .. + path: .. build: + number: 0 noarch: python - entry_points: - - typhos = typhos.cli:main + script: {{ PYTHON }} -m pip install . -vv + + requirements: + build: + - python >=3.9 + - pip + - setuptools_scm host: - - python >=3.7 - - pip + - python >=3.9 + - pip run: - - python >=3.7 - - coloredlogs - - entrypoints - - numpy - - numpydoc - - ophyd >=1.5.0 - - pcdsutils - - pydm >=1.16.1 - - pyqt >=5,<5.15 - - pyqtgraph - - qdarkstyle - - qtawesome - - qtconsole - - qtpy - - timechart >=1.2.4 + - python >=3.9 + - coloredlogs + - entrypoints + - numpy + - numpydoc + - ophyd >=1.5.0 + - pcdsdevices + - pcdsutils + - pydm >=1.16.1 + - pyqt + - pyqtgraph + - qdarkstyle + - qtawesome + - qtconsole + - qtpy + - timechart >=1.2.4 run_constrained: - - happi >=1.14.0 - - jupyter_client <7.3.2 + - happi >=1.14.0 + - jupyter_client <7.3.2 + + + +test: + commands: + - typhos --help + imports: + - typhos + - typhos.cli + requires: + - caproto + - doctr + - doctr-versions-menu + - flake8 + - ipython>=7.16 + - jinja2<3.1 + - line_profiler <4.0.0 + - pytest + - pytest-benchmark + - pytest-qt + - pytest-timeout + - simplejson + about: - home: https://github.com/pcdshub/typhos - doc_url: https://pcdshub.github.io/typhos dev_url: https://github.com/pcdshub/typhos - summary: 'Automatic-yet-customizable Graphical User Interface Generation for Ophyd Devices' + doc_url: https://pcdshub.github.io/typhos + home: https://github.com/pcdshub/typhos license: SLAC Open license_family: OTHER license_file: LICENSE.md + summary: Automatic-yet-customizable Graphical User Interface Generation for Ophyd + Devices + -test: - imports: - - typhos - - typhos.cli - commands: - - typhos --help extra: recipe-maintainers: - - klauer - - hhslepicka - - zllentz + - klauer + - tangkong + - zllentz diff --git a/dev-requirements.txt b/dev-requirements.txt index 2c76919d7..3aadbc0bb 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,6 +1,4 @@ caproto -doctr -doctr-versions-menu flake8 ipython>=7.16 jinja2<3.1 @@ -9,6 +7,4 @@ pytest pytest-benchmark pytest-qt pytest-timeout -sphinx<4.0.0 -sphinx_rtd_theme simplejson diff --git a/docs-requirements.txt b/docs-requirements.txt new file mode 100644 index 000000000..cdde92b83 --- /dev/null +++ b/docs-requirements.txt @@ -0,0 +1,5 @@ +docs-versions-menu +happi +sphinx +sphinx_rtd_theme +sphinxcontrib-jquery diff --git a/docs/source/conf.py b/docs/source/conf.py index 0ae5e0ae6..4da1b7e4a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,5 +1,4 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- # # Typhos documentation build configuration file, created by # sphinx-quickstart on Sat Nov 11 09:41:36 2017. @@ -23,8 +22,7 @@ import sphinx_rtd_theme # NOQA -module_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), - '../../') +module_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../") sys.path.insert(0, module_path) @@ -38,35 +36,36 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon', - 'sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'IPython.sphinxext.ipython_directive', - 'IPython.sphinxext.ipython_console_highlighting', - 'doctr_versions_menu', - 'sphinx.ext.githubpages', - ] + "sphinxcontrib.jquery", + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", + "sphinx.ext.napoleon", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "IPython.sphinxext.ipython_directive", + "IPython.sphinxext.ipython_console_highlighting", + "docs_versions_menu", + "sphinx.ext.githubpages", +] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] autosummary_generate = True # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'Typhos' -copyright = f'{datetime.now().year}, SLAC National Accelerator Laboratory' -author = 'SLAC National Accelerator Laboratory' +project = "Typhos" +copyright = f"{datetime.now().year}, SLAC National Accelerator Laboratory" +author = "SLAC National Accelerator Laboratory" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -75,9 +74,9 @@ # The short X.Y version. import typhos # NOQA -version = typhos.__version__ +version = str(typhos.__version__) # The full version, including alpha/beta/rc tags. -release = typhos.__version__ +release = str(typhos.__version__) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -92,7 +91,7 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -103,7 +102,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +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 @@ -114,7 +113,7 @@ # 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'] +html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -122,12 +121,12 @@ # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - 'donate.html', + "**": [ + "about.html", + "navigation.html", + "relations.html", # needs 'show_related': True theme option to display + "searchbox.html", + "donate.html", ] } @@ -135,7 +134,7 @@ # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. -htmlhelp_basename = 'Typhosdoc' +htmlhelp_basename = "Typhosdoc" # -- Options for LaTeX output --------------------------------------------- @@ -144,15 +143,12 @@ # 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', @@ -162,8 +158,13 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Typhos.tex', 'Typhos Documentation', - 'SLAC National Accelerator Laboratory', 'manual'), + ( + master_doc, + "Typhos.tex", + "Typhos Documentation", + "SLAC National Accelerator Laboratory", + "manual", + ), ] @@ -171,10 +172,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'typhos', 'Typhos Documentation', - [author], 1) -] +man_pages = [(master_doc, "typhos", "Typhos Documentation", [author], 1)] # -- Options for Texinfo output ------------------------------------------- @@ -183,16 +181,22 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Typhos', 'Typhos Documentation', - author, 'Typhos', 'Typhos Documentation', - 'Miscellaneous'), + ( + master_doc, + "Typhos", + "Typhos Documentation", + author, + "Typhos", + "Typhos Documentation", + "Miscellaneous", + ), ] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'pcdsdevices': ('https://pcdshub.github.io/pcdsdevices/', None), - 'pydm': ('https://slaclab.github.io/pydm-tutorial/', None), - 'pydm-api': ('https://slaclab.github.io/pydm/', None), - 'python': ('https://docs.python.org/', None), - } + "pcdsdevices": ("https://pcdshub.github.io/pcdsdevices/master/", None), + "pydm": ("https://slaclab.github.io/pydm-tutorial/", None), + "pydm-api": ("https://slaclab.github.io/pydm/", None), + "python": ("https://docs.python.org/", None), +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 000000000..dabdd1edd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,60 @@ +[build-system] +build-backend = "setuptools.build_meta" +requires = [ "setuptools>=45", "setuptools_scm[toml]>=6.2",] + +[project] +classifiers = [ "Development Status :: 5 - Production/Stable", "Natural Language :: English", "Programming Language :: Python :: 3",] +description = "Interface generation for ophyd devices" +dynamic = [ "version", "readme", "dependencies", "optional-dependencies", "optional-dependencies",] +keywords = [] +name = "typhos" +requires-python = ">=3.9" +[[project.authors]] +name = "SLAC National Accelerator Laboratory" + +[options] +zip_safe = false +include_package_data = true + +[project.license] +file = "LICENSE.md" + +[project.scripts] +typhos = "typhos.cli:main" + +[tool.setuptools_scm] +write_to = "typhos/_version.py" + +[project.entry-points."pydm.widget"] +TyphosAlarmCirclePlugin = "typhos.alarm:TyphosAlarmCircle" +TyphosAlarmEllipsePlugin = "typhos.alarm:TyphosAlarmEllipse" +TyphosAlarmPolygonPlugin = "typhos.alarm:TyphosAlarmPolygon" +TyphosAlarmRectanglePlugin = "typhos.alarm:TyphosAlarmRectangle" +TyphosAlarmTrianglePlugin = "typhos.alarm:TyphosAlarmTriangle" +TyphosCompositeSignalPanelPlugin = "typhos.panel:TyphosCompositeSignalPanel" +TyphosDeviceDisplayPlugin = "typhos.display:TyphosDeviceDisplay" +TyphosDisplaySwitcherPlugin = "typhos.display:TyphosDisplaySwitcher" +TyphosDisplayTitlePlugin = "typhos.display:TyphosDisplayTitle" +TyphosHelpFramePlugin = "typhos.display:TyphosHelpFrame" +TyphosMethodButtonPlugin = "typhos.func:TyphosMethodButton" +TyphosPositionerWidgetPlugin = "typhos.positioner:TyphosPositionerWidget" +TyphosRelatedSuiteButtonPlugin = "typhos.related_display:TyphosRelatedSuiteButton" +TyphosSignalPanelPlugin = "typhos.panel:TyphosSignalPanel" + +[project.entry-points."pydm.data_plugin"] +HappiPlugin = "typhos.plugins:HappiPlugin" +SignalPlugin = "typhos.plugins:SignalPlugin" + +[tool.setuptools.packages.find] +where = [ ".",] +include = [ "typhos*",] +namespaces = false + +[tool.setuptools.dynamic.readme] +file = "README.md" + +[tool.setuptools.dynamic.dependencies] +file = [ "requirements.txt",] + +[tool.setuptools.dynamic.optional-dependencies.test] +file = "dev-requirements.txt" diff --git a/requirements.txt b/requirements.txt index c52e3b835..6ba11dfa1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,6 +4,7 @@ numpy numpydoc ophyd pcdsutils +PyQt5 pydm>=1.16.1 pyqtgraph qdarkstyle diff --git a/run_tests.py b/run_tests.py deleted file mode 100644 index bcddb6c29..000000000 --- a/run_tests.py +++ /dev/null @@ -1,49 +0,0 @@ -#!/usr/bin/env python -import logging -import os -import sys -from logging.handlers import RotatingFileHandler -from pathlib import Path - -import pytest - -if __name__ == '__main__': - # Show output results from every test function - # Show the message output for skipped and expected failures - # Skip the benchmarking - args = ['-v', '-vrxs', '--benchmark-skip'] - - # Add extra arguments - if len(sys.argv) > 1: - args.extend(sys.argv[1:]) - - print('pytest arguments: {}'.format(args)) - - typhos_logger = logging.getLogger('typhos') - pydm_logger = logging.getLogger('pydm') - log_dir = Path(os.path.dirname(__file__)) / 'logs' - log_file = log_dir / 'run_tests_log.txt' - - if not log_dir.exists(): - log_dir.mkdir(parents=True) - if log_file.exists(): - do_rollover = True - else: - do_rollover = False - - handler = RotatingFileHandler(str(log_file), backupCount=5, - encoding=None, delay=0) - if do_rollover: - handler.doRollover() - formatter = logging.Formatter(fmt=('%(asctime)s.%(msecs)03d ' - '%(name)-30s ' - '%(levelname)-8s ' - '%(threadName)-10s ' - '%(message)s'), - datefmt='%H:%M:%S') - handler.setFormatter(formatter) - for log in (typhos_logger, pydm_logger): - log.setLevel(logging.DEBUG) - log.addHandler(handler) - - sys.exit(pytest.main(args)) diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 8fd74ecc5..000000000 --- a/setup.cfg +++ /dev/null @@ -1,6 +0,0 @@ -[versioneer] -VCS = git -style = pep440 -versionfile_source = typhos/_version.py -versionfile_build = typhos/_version.py -tag_prefix = v diff --git a/setup.py b/setup.py deleted file mode 100644 index c22c3cc62..000000000 --- a/setup.py +++ /dev/null @@ -1,49 +0,0 @@ -from setuptools import find_packages, setup - -import versioneer - -with open('requirements.txt') as f: - requirements = f.read().split() - -git_requirements = [r for r in requirements if r.startswith('git+')] -requirements = [r for r in requirements if not r.startswith('git+')] -if len(git_requirements) > 0: - print("User must install the following packages manually:\n" + - "\n".join(f' {r}' for r in git_requirements)) - -# Widgets for Qt Designer via the pydm entrypoint -designer_widgets = [ - "TyphosAlarmCirclePlugin=typhos.alarm:TyphosAlarmCircle", - "TyphosAlarmEllipsePlugin=typhos.alarm:TyphosAlarmEllipse", - "TyphosAlarmPolygonPlugin=typhos.alarm:TyphosAlarmPolygon", - "TyphosAlarmRectanglePlugin=typhos.alarm:TyphosAlarmRectangle", - "TyphosAlarmTrianglePlugin=typhos.alarm:TyphosAlarmTriangle", - "TyphosCompositeSignalPanelPlugin=typhos.panel:TyphosCompositeSignalPanel", - "TyphosDeviceDisplayPlugin=typhos.display:TyphosDeviceDisplay", - "TyphosDisplaySwitcherPlugin=typhos.display:TyphosDisplaySwitcher", - "TyphosDisplayTitlePlugin=typhos.display:TyphosDisplayTitle", - "TyphosHelpFramePlugin=typhos.display:TyphosHelpFrame", - "TyphosMethodButtonPlugin=typhos.func:TyphosMethodButton", - "TyphosPositionerWidgetPlugin=typhos.positioner:TyphosPositionerWidget", - "TyphosRelatedSuiteButtonPlugin=typhos.related_display:TyphosRelatedSuiteButton", # noqa - "TyphosSignalPanelPlugin=typhos.panel:TyphosSignalPanel", -] - -setup( - name="typhos", - version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), - author="SLAC National Accelerator Laboratory", - packages=find_packages(), - include_package_data=True, - install_requires=requirements, - description="Interface generation for ophyd devices", - entry_points={ - "console_scripts": ["typhos=typhos.cli:main"], - "pydm.widget": designer_widgets, - "pydm.data_plugin": [ - "HappiPlugin=typhos.plugins:HappiPlugin", - "SignalPlugin=typhos.plugins:SignalPlugin", - ], - }, -) diff --git a/typhos/__init__.py b/typhos/__init__.py index 1076fcdfc..cfaab6d41 100644 --- a/typhos/__init__.py +++ b/typhos/__init__.py @@ -1,4 +1,3 @@ -from . import _version from .display import TyphosDeviceDisplay from .func import TyphosMethodButton from .panel import TyphosCompositeSignalPanel, TyphosSignalPanel @@ -6,6 +5,7 @@ from .positioner import TyphosPositionerWidget from .suite import TyphosSuite from .utils import load_suite, patch_connect_slots, use_stylesheet +from .version import __version__ # noqa: F401 __all__ = [ 'use_stylesheet', @@ -27,5 +27,3 @@ patch_connect_slots() del patch_connect_slots - -__version__ = _version.get_versions()['version'] diff --git a/typhos/_version.py b/typhos/_version.py deleted file mode 100644 index e287a852a..000000000 --- a/typhos/_version.py +++ /dev/null @@ -1,658 +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.22 (https://github.com/python-versioneer/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys -from typing import Callable, Dict -import functools - - -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" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "None" - cfg.versionfile_source = "typhos/_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: Dict[str, str] = {} -HANDLERS: Dict[str, Dict[str, Callable]] = {} - - -def register_vcs_handler(vcs, method): # decorator - """Create decorator to mark a method as the handler of a 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) - process = None - - popen_kwargs = {} - if sys.platform == "win32": - # This hides the console window if pythonw.exe is used - startupinfo = subprocess.STARTUPINFO() - startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW - popen_kwargs["startupinfo"] = startupinfo - - for command in commands: - try: - dispcmd = str([command] + args) - # remember shell=False, so use git.cmd on windows, not just git - process = subprocess.Popen([command] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None), **popen_kwargs) - break - except OSError: - 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 = process.communicate()[0].strip().decode() - if process.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, process.returncode - return stdout, process.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 _ 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} - 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: - with open(versionfile_abs, "r") as fobj: - for line in fobj: - 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) - except OSError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if "refnames" not in keywords: - raise NotThisMethod("Short version file found") - date = keywords.get("date") - if date is not None: - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - - # 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 = {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 = {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 = {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):] - # Filter out refs that exactly match prefix or that don't start - # with a number once the prefix is stripped (mostly a concern - # when prefix is '') - if not re.match(r'\d', r): - continue - 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, runner=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"] - - # GIT_DIR can interfere with correct operation of Versioneer. - # It may be intended to be passed to the Versioneer-versioned project, - # but that should not change where we get our version from. - env = os.environ.copy() - env.pop("GIT_DIR", None) - runner = functools.partial(runner, env=env) - - _, rc = runner(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") - - MATCH_ARGS = ["--match", "%s*" % tag_prefix] if tag_prefix else [] - - # 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 = runner(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", *MATCH_ARGS], - 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 = runner(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 - - branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root) - # --abbrev-ref was added in git-1.6.3 - if rc != 0 or branch_name is None: - raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") - branch_name = branch_name.strip() - - if branch_name == "HEAD": - # If we aren't exactly on a branch, pick a branch which represents - # the current commit. If all else fails, we are on a branchless - # commit. - branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) - # --contains was added in git-1.5.4 - if rc != 0 or branches is None: - raise NotThisMethod("'git branch --contains' returned error") - branches = branches.split("\n") - - # Remove the first line if we're running detached - if "(" in branches[0]: - branches.pop(0) - - # Strip off the leading "* " from the list of branches. - branches = [branch[2:] for branch in branches] - if "master" in branches: - branch_name = "master" - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - pieces["branch"] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparsable. 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 = runner(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 = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - 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_branch(pieces): - """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . - - The ".dev0" means not master branch. Note that .dev0 sorts backwards - (a feature branch will appear "older" than the master branch). - - Exceptions: - 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0" - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def pep440_split_post(ver): - """Split pep440 version string at the post-release segment. - - Returns the release segments before the post-release and the - post-release version number (or -1 if no post-release segment is present). - """ - vc = str.split(ver, ".post") - return vc[0], int(vc[1] or 0) if len(vc) == 2 else None - - -def render_pep440_pre(pieces): - """TAG[.postN.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post0.devDISTANCE - """ - if pieces["closest-tag"]: - if pieces["distance"]: - # update the post release segment - tag_version, post_version = pep440_split_post(pieces["closest-tag"]) - rendered = tag_version - if post_version is not None: - rendered += ".post%d.dev%d" % (post_version+1, pieces["distance"]) - else: - rendered += ".post0.dev%d" % (pieces["distance"]) - else: - # no commits, use the tag as the version - rendered = pieces["closest-tag"] - else: - # exception #1 - rendered = "0.post0.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_post_branch(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . - - The ".dev0" means not master branch. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - 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" - 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-branch": - rendered = render_pep440_branch(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-post-branch": - rendered = render_pep440_post_branch(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 _ 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/typhos/alarm.py b/typhos/alarm.py index 7930496d2..8a7dc0d77 100644 --- a/typhos/alarm.py +++ b/typhos/alarm.py @@ -61,7 +61,7 @@ class AlarmLevel(enum.IntEnum): (lambda walk: walk.item.kind != Kind.omitted), KindLevel.OMITTED: (lambda walk: True), - } +} @dataclass @@ -181,7 +181,7 @@ def channel(self, value): channel = HappiChannel( address=self._channel, tx_slot=self._tx, - ) + ) else: channel = PyDMChannel( address=self._channel, @@ -189,14 +189,14 @@ def channel(self, value): addr=self._channel), severity_slot=partial(self.update_severity, addr=self._channel), - ) + ) self.signal_info[self._channel] = SignalInfo( address=self._channel, channel=channel, signal_name='', connected=False, severity=AlarmLevel.INVALID, - ) + ) self._channels = [channel] # Connect the channel to the HappiPlugin if hasattr(channel, 'connect'): @@ -247,7 +247,7 @@ def setup_alarm_config(self, device): sigs = get_all_signals_from_device( device, filter_by=KIND_FILTERS[self._kind_level] - ) + ) channel_addrs = [channel_from_signal(sig) for sig in sigs] for sig in sigs: if not isinstance(sig, EpicsSignalBase): @@ -257,7 +257,7 @@ def setup_alarm_config(self, device): address=addr, connection_slot=partial(self.update_connection, addr=addr), severity_slot=partial(self.update_severity, addr=addr), - ) + ) for addr in channel_addrs] for ch, sig in zip(channels, sigs): @@ -267,7 +267,7 @@ def setup_alarm_config(self, device): signal_name=sig.dotted_name, connected=False, severity=AlarmLevel.INVALID, - ) + ) self.signal_info[ch.address] = info self.device_info[device.name].append(info) ch.connect() @@ -277,12 +277,12 @@ def setup_alarm_config(self, device): logger.debug( f'Finished setup of alarm config for device {device.name} on ' f'alarm widget with channel {all_channels[0]}.' - ) + ) else: logger.warning( f'Tried to set up alarm config for device {device.name}, but ' 'did not configure any channels! Check your kindLevel!' - ) + ) def update_alarm_config(self): """ @@ -386,7 +386,7 @@ def show_alarm_tooltip(self, event): QtCore.QPoint(event.x() + 10, event.y())), tooltip, self, - ) + ) # Return True if we showed something return bool(tooltip_lines) @@ -443,7 +443,7 @@ def indicator_stylesheet(shape_cls, alarm): '{border: none; ' ' background: transparent;' ' qproperty-brush: rgba' - ) + ) if alarm == AlarmLevel.DISCONNECTED: return base + '(255,255,255,255);}' diff --git a/typhos/cli.py b/typhos/cli.py index ce1f79048..8149ed205 100644 --- a/typhos/cli.py +++ b/typhos/cli.py @@ -6,7 +6,7 @@ import re import signal import sys -from typing import List, Optional +from typing import Optional import coloredlogs import pcdsutils @@ -197,7 +197,7 @@ def typhos_cli_setup(args): typhos.use_stylesheet(dark=args.dark) if args.stylesheet: logger.info("Loading QSS file %r ...", args.stylesheet) - with open(args.stylesheet, 'r') as handle: + with open(args.stylesheet) as handle: qapp.setStyleSheet(handle.read()) @@ -216,7 +216,7 @@ def _create_happi_client(cfg): def create_suite( - device_names: List[str], + device_names: list[str], cfg: Optional[str] = None, fake_devices: bool = False, layout: str = 'horizontal', @@ -452,7 +452,7 @@ def create_devices(device_names, cfg=None, fake_devices=False): def typhos_run( - device_names: List[str], + device_names: list[str], cfg: Optional[str] = None, fake_devices: bool = False, layout: str = 'horizontal', diff --git a/typhos/display.py b/typhos/display.py index c99b26a57..6f6788a32 100644 --- a/typhos/display.py +++ b/typhos/display.py @@ -6,7 +6,7 @@ import os import pathlib import webbrowser -from typing import List, Optional, Union +from typing import Optional, Union import ophyd import pcdsutils @@ -274,8 +274,8 @@ def text_filter_updated(): line_edit = QtWidgets.QLineEdit() - filters = list(set(panel.nameFilter for panel in panels - if panel.nameFilter)) + filters = list({panel.nameFilter for panel in panels + if panel.nameFilter}) if len(filters) == 1: line_edit.setText(filters[0]) else: @@ -715,7 +715,7 @@ def show_help(self): logger.error( "Failed to import QWebEngineView; " "help view is unavailable." - ) + ) return if self.help_web_view: @@ -993,9 +993,9 @@ def __init__( *, scrollable: Optional[bool] = None, composite_heuristics: bool = True, - embedded_templates: Optional[List[str]] = None, - detailed_templates: Optional[List[str]] = None, - engineering_templates: Optional[List[str]] = None, + embedded_templates: Optional[list[str]] = None, + detailed_templates: Optional[list[str]] = None, + engineering_templates: Optional[list[str]] = None, display_type: Union[DisplayTypes, str, int] = 'detailed_screen', scroll_option: Union[ScrollOptions, str, int] = 'auto', nested: bool = False, diff --git a/typhos/examples/device_classes.py b/typhos/examples/device_classes.py index aaa358770..c6647ea55 100644 --- a/typhos/examples/device_classes.py +++ b/typhos/examples/device_classes.py @@ -88,7 +88,7 @@ def stop(self, success=False): else: self._status.set_exception( RuntimeError('Move Interrupted') - ) + ) @user_readback.sub_value def _update_position(self, value, **kwargs): @@ -146,7 +146,7 @@ def _start_motion_thread(self, value, **kwargs): if value == 'Unknown': self._status.set_exception( RuntimeError('Unknown not a valid target state') - ) + ) else: td = threading.Thread(target=self._motion_thread) td.start() diff --git a/typhos/examples/positioner.py b/typhos/examples/positioner.py index 0946def20..93cfbe573 100644 --- a/typhos/examples/positioner.py +++ b/typhos/examples/positioner.py @@ -12,7 +12,7 @@ def main(): devices = [ ExamplePositioner(name='example_motor'), ExampleComboPositioner(name='example_combo'), - ] + ] suite = TyphosSuite.from_devices(devices) use_stylesheet() launch_suite(suite) diff --git a/typhos/func.py b/typhos/func.py index 131915871..257d6d320 100644 --- a/typhos/func.py +++ b/typhos/func.py @@ -38,7 +38,7 @@ class ParamWidget(QWidget): This creates the QLabel for the parameter and defines the interface required for subclasses of the ParamWidget. """ - def __init__(self, parameter, default=inspect._empty, parent=None): + def __init__(self, parameter, default=inspect._empty, parent=None): super().__init__(parent=parent) # Store parameter information self.parameter = parameter @@ -225,7 +225,7 @@ def __init__(self, func, name=None, annotations=None, self.signature = inspect.signature(func) self.name = name or self.func.__name__ # Initialize parent - super().__init__('{} Parameters'.format(clean_attr(self.name)), + super().__init__(f'{clean_attr(self.name)} Parameters', parent=parent) # Ignore certain parameters, args and kwargs by default self.hide_params = ['self', 'args', 'kwargs'] diff --git a/typhos/jira.py b/typhos/jira.py index 584d8e9ad..940157994 100644 --- a/typhos/jira.py +++ b/typhos/jira.py @@ -6,7 +6,6 @@ import urllib import urllib.parse import urllib.request -from typing import Dict from pydm.exception import raise_to_operator from qtpy import QtWidgets @@ -99,7 +98,7 @@ def anything_provided(self) -> bool: for value in self.get_dictionary().values() ) - def get_dictionary(self, full=False) -> Dict[str, str]: + def get_dictionary(self, full=False) -> dict[str, str]: """Return all issue details as a dictionary.""" auto_generated = dict( environment=self.get_environment(), diff --git a/typhos/panel.py b/typhos/panel.py index 6bf37965d..1879114af 100644 --- a/typhos/panel.py +++ b/typhos/panel.py @@ -279,10 +279,10 @@ def add_signal(self, signal, name=None, *, tooltip=None): timeout_message='Connection timed out.' ) - loading_tooltip = ['Connecting to:'] + list(set( + loading_tooltip = ['Connecting to:'] + list({ getattr(signal, attr) for attr in ('setpoint_pvname', 'pvname') if hasattr(signal, attr) - )) + }) loading.setToolTip('\n'.join(loading_tooltip)) row = self.add_row(label, loading) diff --git a/typhos/plugins/core.py b/typhos/plugins/core.py index 8d2bfd247..6fb312fbd 100644 --- a/typhos/plugins/core.py +++ b/typhos/plugins/core.py @@ -86,11 +86,11 @@ def __init__(self, channel, address, protocol=None, parent=None): self.value_cid = self.signal.subscribe( self.send_new_value, event_type=self.signal.SUB_VALUE, - ) + ) self.meta_cid = self.signal.subscribe( self.send_new_meta, event_type=self.signal.SUB_META, - ) + ) # Add listener self.add_listener(channel) @@ -161,7 +161,7 @@ def send_new_meta( units=None, enum_strs=None, **kwargs - ): + ): """ Update the UI with new metadata from the Signal. diff --git a/typhos/positioner.py b/typhos/positioner.py index 7aab38212..83a5b2652 100644 --- a/typhos/positioner.py +++ b/typhos/positioner.py @@ -337,7 +337,7 @@ def _link_moving(self, signal, widget): self._moving_channel = PyDMChannel( address=chname, value_slot=self._set_moving, - ) + ) self._moving_channel.connect() return True @@ -366,7 +366,7 @@ def _define_setpoint_widget(self): self.ui.set_value.setSizePolicy( QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Fixed, - ) + ) self.ui.set_value.setMinimumContentsLength(20) self.ui.tweak_widget.setVisible(False) else: diff --git a/typhos/related_display.py b/typhos/related_display.py index 161953707..896718b25 100644 --- a/typhos/related_display.py +++ b/typhos/related_display.py @@ -26,7 +26,7 @@ def happi_check(): logger.warning( 'The happi module is not in your Python environment, ' 'happi TyphosRelatedSuiteButton features will not work.' - ) + ) return happi_loaded @@ -135,7 +135,7 @@ def get_happi_devices(self): raise ValueError( f'Did not find device with name {name} in happi. ' 'Please check your spelling and your database.' - ) from None + ) from None items.append(search_result.item) with no_device_lazy_load(): diff --git a/typhos/suite.py b/typhos/suite.py index cfe68a51e..06ff50071 100644 --- a/typhos/suite.py +++ b/typhos/suite.py @@ -7,7 +7,6 @@ import os import textwrap from functools import partial -from typing import Dict, List, Optional, Type, Union import ophyd import pcdsutils.qt @@ -89,11 +88,11 @@ class LazySubdisplay(QtWidgets.QWidget): The widget class to instantiate. """ - widget_cls: Type[QtWidgets.QWidget] - widget: Optional[QtWidgets.QWidget] - devices: List[ophyd.Device] + widget_cls: type[QtWidgets.QWidget] + widget: QtWidgets.QWidget | None + devices: list[ophyd.Device] - def __init__(self, widget_cls: Type[QtWidgets.QWidget]): + def __init__(self, widget_cls: type[QtWidgets.QWidget]): super().__init__() self.widget_cls = widget_cls self.widget = None @@ -245,10 +244,10 @@ class TyphosSuite(TyphosBase): def __init__( self, - parent: Optional[QtWidgets.QWidget] = None, + parent: QtWidgets.QWidget | None = None, *, pin: bool = False, - content_layout: Optional[QtWidgets.QLayout] = None, + content_layout: QtWidgets.QLayout | None = None, default_display_type: DisplayTypes = DisplayTypes.detailed_screen, scroll_option: ScrollOptions = ScrollOptions.auto, ): @@ -316,7 +315,7 @@ def add_subdisplay(self, name, display, category): self._add_to_sidebar(parameter, category) def add_lazy_subdisplay( - self, name: str, display_class: Type[QtWidgets.QWidget], category: str + self, name: str, display_class: type[QtWidgets.QWidget], category: str ): """ Add an arbitrary widget to the tree of available widgets and tools. @@ -354,11 +353,11 @@ def top_level_groups(self): {'name': QGroupParameterItem} """ root = self._tree.invisibleRootItem() - return dict((root.child(idx).param.name(), - root.child(idx).param) - for idx in range(root.childCount())) + return {root.child(idx).param.name(): + root.child(idx).param + for idx in range(root.childCount())} - def add_tool(self, name: str, tool: Type[QtWidgets.QWidget]): + def add_tool(self, name: str, tool: type[QtWidgets.QWidget]): """ Add a widget to the toolbar. @@ -592,10 +591,10 @@ def add_device(self, device, children=True, category='Devices'): def from_device( cls, device: Device, - parent: Optional[QtWidgets.QWidget] = None, - tools: Union[Dict[str, type], None, DEFAULT_TOOLS] = DEFAULT_TOOLS, + parent: QtWidgets.QWidget | None = None, + tools: dict[str, type] | None | DEFAULT_TOOLS = DEFAULT_TOOLS, pin: bool = False, - content_layout: Optional[QtWidgets.QLayout] = None, + content_layout: QtWidgets.QLayout | None = None, default_display_type: DisplayTypes = DisplayTypes.detailed_screen, scroll_option: ScrollOptions = ScrollOptions.auto, show_displays: bool = True, @@ -655,11 +654,11 @@ def from_device( @classmethod def from_devices( cls, - devices: List[Device], - parent: Optional[QtWidgets.QWidget] = None, - tools: Union[Dict[str, type], None, DEFAULT_TOOLS] = DEFAULT_TOOLS, + devices: list[Device], + parent: QtWidgets.QWidget | None = None, + tools: dict[str, type] | None | DEFAULT_TOOLS = DEFAULT_TOOLS, pin: bool = False, - content_layout: Optional[QtWidgets.QLayout] = None, + content_layout: QtWidgets.QLayout | None = None, default_display_type: DisplayTypes = DisplayTypes.detailed_screen, scroll_option: ScrollOptions = ScrollOptions.auto, show_displays: bool = True, @@ -714,7 +713,7 @@ def from_devices( content_layout=content_layout, default_display_type=default_display_type, scroll_option=scroll_option, - ) + ) if tools is not None: logger.info("Loading Tools ...") if tools is DEFAULT_TOOLS: diff --git a/typhos/tests/conftest.py b/typhos/tests/conftest.py index 421bb5b82..677235b8e 100644 --- a/typhos/tests/conftest.py +++ b/typhos/tests/conftest.py @@ -144,7 +144,7 @@ def __init__(self, *args, metadata=None, **kwargs): 'enum_strs': ('a', 'b', 'c'), 'precision': 2, 'units': 'urad', - } + } super().__init__(*args, metadata=metadata, **kwargs) def describe(self): @@ -219,7 +219,7 @@ def insert(self, width: float = 2.0, height: float = 2.0, """Fake insert function to display""" pass - def remove(self, height: float, fast_mode: bool = False): + def remove(self, height: float, fast_mode: bool = False): """Fake remove function to display""" pass diff --git a/typhos/tests/test_alarm.py b/typhos/tests/test_alarm.py index b7d93a507..117e3eca6 100644 --- a/typhos/tests/test_alarm.py +++ b/typhos/tests/test_alarm.py @@ -24,8 +24,8 @@ TyphosAlarmTriangle, TyphosAlarmEllipse, TyphosAlarmPolygon, - ), - ) + ), +) def alarm(qtbot, request): alarm_widget = request.param() alarm_widget.kindLevel = alarm_widget.KindLevel.HINTED @@ -66,13 +66,13 @@ def test_alarm_add_device_basic(alarm_add_device): ({'severity': AlarmSeverity.MINOR}, AlarmLevel.MINOR), ({'severity': AlarmSeverity.MAJOR}, AlarmLevel.MAJOR), ({'severity': AlarmSeverity.INVALID}, AlarmLevel.INVALID), - ] +] @pytest.mark.parametrize("metadata,response", alarm_cases) def test_one_alarm_add_device( alarm_add_device, device, qtbot, metadata, response - ): +): alarm = alarm_add_device with qtbot.wait_signal(alarm.alarm_changed, timeout=1000): @@ -111,7 +111,7 @@ def find_item(self, *args, name, **kwargs): name=name, device_class='typhos.tests.test_alarm.SimpleDevice', kwargs={'name': '{{name}}'}, - ) + ) @pytest.mark.parametrize("metadata,response", alarm_cases) diff --git a/typhos/tests/test_benchmark.py b/typhos/tests/test_benchmark.py index 355d5c73a..c540f14df 100644 --- a/typhos/tests/test_benchmark.py +++ b/typhos/tests/test_benchmark.py @@ -1,7 +1,6 @@ """ Run the benchmark test cases using pytest-benchmark """ -from typing import List import pytest from epics import PV @@ -14,7 +13,7 @@ from .conftest import save_image -def get_top_level_suites() -> List[TyphosSuite]: +def get_top_level_suites() -> list[TyphosSuite]: app = QtWidgets.QApplication.instance() assert app is not None return list( diff --git a/typhos/tests/test_cache.py b/typhos/tests/test_cache.py index 4e971ba12..96d8d080c 100644 --- a/typhos/tests/test_cache.py +++ b/typhos/tests/test_cache.py @@ -58,7 +58,7 @@ def type_cache(qtbot, describe_cache): @pytest.fixture(scope='function') def sig(): - name = 'test{}'.format(random.randint(0, 10000)) + name = f'test{random.randint(0, 10000)}' sig = ophyd.Signal(name=name) yield sig sig.destroy() diff --git a/typhos/tests/test_cli.py b/typhos/tests/test_cli.py index 06f735f7b..9afb90bcf 100644 --- a/typhos/tests/test_cli.py +++ b/typhos/tests/test_cli.py @@ -11,7 +11,7 @@ def test_cli_version(capsys): typhos_cli(['--version']) readout = capsys.readouterr() - assert typhos.__version__ in readout.out + assert str(typhos.__version__) in readout.out def test_cli_happi_cfg(qtbot, happi_cfg): diff --git a/typhos/tests/test_console.py b/typhos/tests/test_console.py index 10b4bb312..94011ba84 100644 --- a/typhos/tests/test_console.py +++ b/typhos/tests/test_console.py @@ -2,6 +2,7 @@ import ophyd import ophyd.sim +import pytest from typhos.tools import TyphosConsole @@ -17,6 +18,7 @@ def test_base_console(qtbot): tc.shutdown() +@pytest.mark.xfail(reason='inconsistent failures, see typhos #547') def test_add_happi_device(qapp, qtbot, happi_cfg, client): device = client['Syn:Motor'].get() @@ -35,6 +37,7 @@ def test_add_happi_device(qapp, qtbot, happi_cfg, client): time.sleep(0.5) +@pytest.mark.xfail(reason='inconsistent failures, see typhos #547') def test_add_importable_device(qapp, qtbot): device = ophyd.sim.SynAxis(name='device') tc = TyphosConsole.from_device(device) @@ -54,6 +57,7 @@ def test_add_importable_device(qapp, qtbot): tc.shutdown() +@pytest.mark.xfail(reason='inconsistent failures, see typhos #547') def test_add_fake_device(qapp, qtbot): EpicsMotor = ophyd.sim.make_fake_device(ophyd.EpicsMotor) device = EpicsMotor('sim:mtr1', name="sim_mtr1") diff --git a/typhos/tests/test_display.py b/typhos/tests/test_display.py index 771d08908..0d97472a7 100644 --- a/typhos/tests/test_display.py +++ b/typhos/tests/test_display.py @@ -38,10 +38,10 @@ def filter_by(sig): return False return sig.item.kind in kinds - return set( + return { sig.name for sig in utils.get_all_signals_from_device(device, filter_by=filter_by) - ) + } def check_hint_panel(device): device_signals = signals_from_device(device, ophyd.Kind.hinted) diff --git a/typhos/tests/test_panel.py b/typhos/tests/test_panel.py index a61bc5637..d4f7b2ef3 100644 --- a/typhos/tests/test_panel.py +++ b/typhos/tests/test_panel.py @@ -91,7 +91,7 @@ def test_panel_creation(qtbot, panel, panel_widget): wait_panel( qtbot, panel, - signal_names=set(sig.name for sig in signals.values()) + signal_names={sig.name for sig in signals.values()} ) def widget_at(row, col): diff --git a/typhos/tests/test_positioner.py b/typhos/tests/test_positioner.py index 105ddf841..a94f80b30 100644 --- a/typhos/tests/test_positioner.py +++ b/typhos/tests/test_positioner.py @@ -20,11 +20,8 @@ class SimMotor(SynAxis): high_limit_switch = Cpt(SignalRO, value=0) low_limit = Cpt(Signal, value=-10) high_limit = Cpt(Signal, value=10) - motor_is_moving = Cpt(RichSignal, - value=0, - metadata={ - 'enum_strs': ('not moving', 'moving') - }) + motor_is_moving = Cpt(RichSignal, value=0, + metadata={'enum_strs': ('not moving', 'moving')}) stop = Mock() clear_error = Mock() @@ -71,6 +68,7 @@ def test_positioner_widget_fixed_limits(qtbot, motor): @show_widget +@pytest.mark.skip() def test_positioner_widget_with_signal_limits(motor_widget): motor, widget = motor_widget # Check limit switches @@ -195,9 +193,9 @@ def get_alarm_text(): def update_alarm(level, connected=True): with qtbot.waitSignal( - widget.ui.alarm_circle.alarm_changed, - timeout=500, - ): + widget.ui.alarm_circle.alarm_changed, + timeout=500, + ): motor.motor_is_moving.update_metadata( { 'severity': level, diff --git a/typhos/tests/test_suite.py b/typhos/tests/test_suite.py index 03579efc9..6f573ae3b 100644 --- a/typhos/tests/test_suite.py +++ b/typhos/tests/test_suite.py @@ -159,7 +159,7 @@ def test_suite_save(suite, monkeypatch): suite.save() assert tfile.exists() devices = [device.name for device in suite.devices] - with open(str(tfile), 'r') as f: + with open(str(tfile)) as f: assert str(devices) in f.read() os.remove(str(tfile)) diff --git a/typhos/utils.py b/typhos/utils.py index 294129099..e5803aa6e 100644 --- a/typhos/utils.py +++ b/typhos/utils.py @@ -18,7 +18,6 @@ import threading import weakref from types import MethodType -from typing import List import entrypoints import ophyd @@ -248,10 +247,10 @@ def use_stylesheet(dark=False, widget=None): # Load the path to the file style_path = os.path.join(ui_dir, 'style.qss') if not os.path.exists(style_path): - raise EnvironmentError("Unable to find Typhos stylesheet in {}" - "".format(style_path)) + raise OSError("Unable to find Typhos stylesheet in {}" + "".format(style_path)) # Load the stylesheet from the file - with open(style_path, 'r') as handle: + with open(style_path) as handle: style = handle.read() if widget is None: widget = QtWidgets.QApplication.instance() @@ -475,7 +474,7 @@ def _call(self, *new_args): class TyphosBase(TyphosObject, QWidget): """Base widget for all Typhos widgets that interface with devices""" - _weak_partials_: List[WeakPartialMethodSlot] + _weak_partials_: list[WeakPartialMethodSlot] def __init__(self, *args, **kwargs): self._weak_partials_ = [] diff --git a/typhos/version.py b/typhos/version.py new file mode 100644 index 000000000..da8a5d526 --- /dev/null +++ b/typhos/version.py @@ -0,0 +1,59 @@ +from collections import UserString +from pathlib import Path +from typing import Optional + + +class VersionProxy(UserString): + """ + Version handling helper that pairs with setuptools-scm. + + This allows for pkg.__version__ to be dynamically retrieved on request by + way of setuptools-scm. + + This deferred evaluation of the version until it is checked saves time on + package import. + + This supports the following scenarios: + + 1. A git checkout (.git exists) + 2. A git archive / a tarball release from GitHub that includes version + information in .git_archival.txt. + 3. An existing _version.py generated by setuptools_scm + 4. A fallback in case none of the above match - resulting in a version of + 0.0.unknown + """ + def __init__(self): + self._version = None + + def _get_version(self) -> Optional[str]: + # Checking for directory is faster than failing out of get_version + repo_root = Path(__file__).resolve().parent.parent + if (repo_root / ".git").exists() or (repo_root / ".git_archival.txt").exists(): + try: + # Git checkout + from setuptools_scm import get_version + return get_version(root="..", relative_to=__file__) + except (ImportError, LookupError): + ... + + # Check this second because it can exist in a git repo if we've + # done a build at least once. + try: + from ._version import version # noqa: F401 + return version + except ImportError: + ... + + return None + + @property + def data(self) -> str: + # This is accessed by UserString to allow us to lazily fill in the + # information + if self._version is None: + self._version = self._get_version() or '0.0.unknown' + + return self._version + + +__version__ = version = VersionProxy() diff --git a/typhos/widgets.py b/typhos/widgets.py index e31d9bef7..2d2073cc1 100644 --- a/typhos/widgets.py +++ b/typhos/widgets.py @@ -209,7 +209,7 @@ def __init__(self, *args, display_format=None, **kwargs): self._channel = None self._setpoint_history_count = 5 self._setpoint_history = collections.deque( - [], self._setpoint_history_count) + [], self._setpoint_history_count) super().__init__(*args, **kwargs) self.showUnits = True diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index a142bf53e..000000000 --- a/versioneer.py +++ /dev/null @@ -1,2140 +0,0 @@ - -# Version: 0.22 - -"""The Versioneer - like a rocketeer, but for versions. - -The Versioneer -============== - -* like a rocketeer, but for versions! -* https://github.com/python-versioneer/python-versioneer -* Brian Warner -* License: Public Domain -* Compatible with: Python 3.6, 3.7, 3.8, 3.9, 3.10 and pypy3 -* [![Latest Version][pypi-image]][pypi-url] -* [![Build Status][travis-image]][travis-url] - -This is a tool for managing a recorded version number in distutils/setuptools-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 in your $PATH -* add a `[versioneer]` section to your setup.cfg (see [Install](INSTALL.md)) -* run `versioneer install` in your source tree, commit the results -* Verify version information with `python setup.py version` - -## 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/python-versioneer/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 languages) 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/python-versioneer/python-versioneer/issues/38) is tracking -this issue. The discussion in -[PR #61](https://github.com/python-versioneer/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/python-versioneer/python-versioneer/issues/83) describes -this one, but upgrading to a newer version of setuptools should probably -resolve it. - - -## 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. - -## Similar projects - -* [setuptools_scm](https://github.com/pypa/setuptools_scm/) - a non-vendored build-time - dependency -* [minver](https://github.com/jbweston/miniver) - a lightweight reimplementation of - versioneer -* [versioningit](https://github.com/jwodder/versioningit) - a PEP 518-based setuptools - plugin - -## 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/ . - -[pypi-image]: https://img.shields.io/pypi/v/versioneer.svg -[pypi-url]: https://pypi.python.org/pypi/versioneer/ -[travis-image]: -https://img.shields.io/travis/com/python-versioneer/python-versioneer.svg -[travis-url]: https://travis-ci.com/github/python-versioneer/python-versioneer - -""" -# pylint:disable=invalid-name,import-outside-toplevel,missing-function-docstring -# pylint:disable=missing-class-docstring,too-many-branches,too-many-statements -# pylint:disable=raise-missing-from,too-many-lines,too-many-locals,import-error -# pylint:disable=too-few-public-methods,redefined-outer-name,consider-using-with -# pylint:disable=attribute-defined-outside-init,too-many-arguments - -import configparser -import errno -import json -import os -import re -import subprocess -import sys -from typing import Callable, Dict -import functools - - -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. - my_path = os.path.realpath(os.path.abspath(__file__)) - me_dir = os.path.normcase(os.path.splitext(my_path)[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(my_path), 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 OSError (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.ConfigParser() - with open(setup_cfg, "r") as cfg_file: - parser.read_file(cfg_file) - VCS = parser.get("versioneer", "VCS") # mandatory - - # Dict-like interface for non-mandatory entries - section = parser["versioneer"] - - cfg = VersioneerConfig() - cfg.VCS = VCS - cfg.style = section.get("style", "") - cfg.versionfile_source = section.get("versionfile_source") - cfg.versionfile_build = section.get("versionfile_build") - cfg.tag_prefix = section.get("tag_prefix") - if cfg.tag_prefix in ("''", '""'): - cfg.tag_prefix = "" - cfg.parentdir_prefix = section.get("parentdir_prefix") - cfg.verbose = section.get("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: Dict[str, str] = {} -HANDLERS: Dict[str, Dict[str, Callable]] = {} - - -def register_vcs_handler(vcs, method): # decorator - """Create decorator to mark a method as the handler of a VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - HANDLERS.setdefault(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) - process = None - - popen_kwargs = {} - if sys.platform == "win32": - # This hides the console window if pythonw.exe is used - startupinfo = subprocess.STARTUPINFO() - startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW - popen_kwargs["startupinfo"] = startupinfo - - for command in commands: - try: - dispcmd = str([command] + args) - # remember shell=False, so use git.cmd on windows, not just git - process = subprocess.Popen([command] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None), **popen_kwargs) - break - except OSError: - 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 = process.communicate()[0].strip().decode() - if process.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, process.returncode - return stdout, process.returncode - - -LONG_VERSION_PY['git'] = r''' -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.22 (https://github.com/python-versioneer/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys -from typing import Callable, Dict -import functools - - -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: Dict[str, str] = {} -HANDLERS: Dict[str, Dict[str, Callable]] = {} - - -def register_vcs_handler(vcs, method): # decorator - """Create decorator to mark a method as the handler of a 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) - process = None - - popen_kwargs = {} - if sys.platform == "win32": - # This hides the console window if pythonw.exe is used - startupinfo = subprocess.STARTUPINFO() - startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW - popen_kwargs["startupinfo"] = startupinfo - - for command in commands: - try: - dispcmd = str([command] + args) - # remember shell=False, so use git.cmd on windows, not just git - process = subprocess.Popen([command] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None), **popen_kwargs) - break - except OSError: - 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 = process.communicate()[0].strip().decode() - if process.returncode != 0: - if verbose: - print("unable to run %%s (error)" %% dispcmd) - print("stdout was %%s" %% stdout) - return None, process.returncode - return stdout, process.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 _ 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} - 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: - with open(versionfile_abs, "r") as fobj: - for line in fobj: - 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) - except OSError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if "refnames" not in keywords: - raise NotThisMethod("Short version file found") - date = keywords.get("date") - if date is not None: - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - - # 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 = {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 = {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 = {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):] - # Filter out refs that exactly match prefix or that don't start - # with a number once the prefix is stripped (mostly a concern - # when prefix is '') - if not re.match(r'\d', r): - continue - 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, runner=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"] - - # GIT_DIR can interfere with correct operation of Versioneer. - # It may be intended to be passed to the Versioneer-versioned project, - # but that should not change where we get our version from. - env = os.environ.copy() - env.pop("GIT_DIR", None) - runner = functools.partial(runner, env=env) - - _, rc = runner(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") - - MATCH_ARGS = ["--match", "%%s*" %% tag_prefix] if tag_prefix else [] - - # 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 = runner(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", *MATCH_ARGS], - 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 = runner(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 - - branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root) - # --abbrev-ref was added in git-1.6.3 - if rc != 0 or branch_name is None: - raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") - branch_name = branch_name.strip() - - if branch_name == "HEAD": - # If we aren't exactly on a branch, pick a branch which represents - # the current commit. If all else fails, we are on a branchless - # commit. - branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) - # --contains was added in git-1.5.4 - if rc != 0 or branches is None: - raise NotThisMethod("'git branch --contains' returned error") - branches = branches.split("\n") - - # Remove the first line if we're running detached - if "(" in branches[0]: - branches.pop(0) - - # Strip off the leading "* " from the list of branches. - branches = [branch[2:] for branch in branches] - if "master" in branches: - branch_name = "master" - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - pieces["branch"] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparsable. 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 = runner(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 = runner(GITS, ["show", "-s", "--format=%%ci", "HEAD"], cwd=root)[0].strip() - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - 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_branch(pieces): - """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . - - The ".dev0" means not master branch. Note that .dev0 sorts backwards - (a feature branch will appear "older" than the master branch). - - Exceptions: - 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0" - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+untagged.%%d.g%%s" %% (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def pep440_split_post(ver): - """Split pep440 version string at the post-release segment. - - Returns the release segments before the post-release and the - post-release version number (or -1 if no post-release segment is present). - """ - vc = str.split(ver, ".post") - return vc[0], int(vc[1] or 0) if len(vc) == 2 else None - - -def render_pep440_pre(pieces): - """TAG[.postN.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post0.devDISTANCE - """ - if pieces["closest-tag"]: - if pieces["distance"]: - # update the post release segment - tag_version, post_version = pep440_split_post(pieces["closest-tag"]) - rendered = tag_version - if post_version is not None: - rendered += ".post%%d.dev%%d" %% (post_version+1, pieces["distance"]) - else: - rendered += ".post0.dev%%d" %% (pieces["distance"]) - else: - # no commits, use the tag as the version - rendered = pieces["closest-tag"] - else: - # exception #1 - rendered = "0.post0.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_post_branch(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . - - The ".dev0" means not master branch. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%%s" %% pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+g%%s" %% pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - 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" - 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-branch": - rendered = render_pep440_branch(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-post-branch": - rendered = render_pep440_post_branch(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 _ 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: - with open(versionfile_abs, "r") as fobj: - for line in fobj: - 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) - except OSError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if "refnames" not in keywords: - raise NotThisMethod("Short version file found") - date = keywords.get("date") - if date is not None: - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - - # 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 = {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 = {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 = {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):] - # Filter out refs that exactly match prefix or that don't start - # with a number once the prefix is stripped (mostly a concern - # when prefix is '') - if not re.match(r'\d', r): - continue - 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, runner=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"] - - # GIT_DIR can interfere with correct operation of Versioneer. - # It may be intended to be passed to the Versioneer-versioned project, - # but that should not change where we get our version from. - env = os.environ.copy() - env.pop("GIT_DIR", None) - runner = functools.partial(runner, env=env) - - _, rc = runner(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") - - MATCH_ARGS = ["--match", "%s*" % tag_prefix] if tag_prefix else [] - - # 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 = runner(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", *MATCH_ARGS], - 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 = runner(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 - - branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], - cwd=root) - # --abbrev-ref was added in git-1.6.3 - if rc != 0 or branch_name is None: - raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") - branch_name = branch_name.strip() - - if branch_name == "HEAD": - # If we aren't exactly on a branch, pick a branch which represents - # the current commit. If all else fails, we are on a branchless - # commit. - branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) - # --contains was added in git-1.5.4 - if rc != 0 or branches is None: - raise NotThisMethod("'git branch --contains' returned error") - branches = branches.split("\n") - - # Remove the first line if we're running detached - if "(" in branches[0]: - branches.pop(0) - - # Strip off the leading "* " from the list of branches. - branches = [branch[2:] for branch in branches] - if "master" in branches: - branch_name = "master" - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - pieces["branch"] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparsable. 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 = runner(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 = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - 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: - my_path = __file__ - if my_path.endswith(".pyc") or my_path.endswith(".pyo"): - my_path = os.path.splitext(my_path)[0] + ".py" - versioneer_file = os.path.relpath(my_path) - except NameError: - versioneer_file = "versioneer.py" - files.append(versioneer_file) - present = False - try: - with open(".gitattributes", "r") as fobj: - for line in fobj: - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - break - except OSError: - pass - if not present: - with open(".gitattributes", "a+") as fobj: - fobj.write(f"{versionfile_source} export-subst\n") - 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 _ 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} - 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.22) 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 OSError: - 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_branch(pieces): - """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . - - The ".dev0" means not master branch. Note that .dev0 sorts backwards - (a feature branch will appear "older" than the master branch). - - Exceptions: - 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0" - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def pep440_split_post(ver): - """Split pep440 version string at the post-release segment. - - Returns the release segments before the post-release and the - post-release version number (or -1 if no post-release segment is present). - """ - vc = str.split(ver, ".post") - return vc[0], int(vc[1] or 0) if len(vc) == 2 else None - - -def render_pep440_pre(pieces): - """TAG[.postN.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post0.devDISTANCE - """ - if pieces["closest-tag"]: - if pieces["distance"]: - # update the post release segment - tag_version, post_version = pep440_split_post(pieces["closest-tag"]) - rendered = tag_version - if post_version is not None: - rendered += ".post%d.dev%d" % (post_version+1, pieces["distance"]) - else: - rendered += ".post0.dev%d" % (pieces["distance"]) - else: - # no commits, use the tag as the version - rendered = pieces["closest-tag"] - else: - # exception #1 - rendered = "0.post0.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_post_branch(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . - - The ".dev0" means not master branch. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - 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" - 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-branch": - rendered = render_pep440_branch(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-post-branch": - rendered = render_pep440_post_branch(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(cmdclass=None): - """Get the custom setuptools/distutils subclasses used by Versioneer. - - If the package uses a different cmdclass (e.g. one from numpy), it - should be provide as an argument. - """ - 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/python-versioneer/python-versioneer/issues/52 - - cmds = {} if cmdclass is None else cmdclass.copy() - - # we add "version" to both distutils and setuptools - try: - from setuptools import Command - except ImportError: - 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 'build_py' in cmds: - _build_py = cmds['build_py'] - elif "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 'build_ext' in cmds: - _build_ext = cmds['build_ext'] - elif "setuptools" in sys.modules: - from setuptools.command.build_ext import build_ext as _build_ext - else: - from distutils.command.build_ext import build_ext as _build_ext - - class cmd_build_ext(_build_ext): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - _build_ext.run(self) - if self.inplace: - # build_ext --inplace will only build extensions in - # build/lib<..> dir with no _version.py to write to. - # As in place builds will already have a _version.py - # in the module dir, we do not need to write one. - return - # now locate _version.py in the new build/ directory and replace - # it with an updated value - 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_ext"] = cmd_build_ext - - 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? - from py2exe.distutils_buildexe import py2exe as _py2exe - - 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 'sdist' in cmds: - _sdist = cmds['sdist'] - elif "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 = - -""" - -OLD_SNIPPET = """ -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions -""" - -INIT_PY_SNIPPET = """ -from . import {0} -__version__ = {0}.get_versions()['version'] -""" - - -def do_setup(): - """Do main VCS-independent setup function for installing Versioneer.""" - root = get_root() - try: - cfg = get_config_from_root(root) - except (OSError, configparser.NoSectionError, - configparser.NoOptionError) as e: - if isinstance(e, (OSError, 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 OSError: - old = "" - module = os.path.splitext(os.path.basename(cfg.versionfile_source))[0] - snippet = INIT_PY_SNIPPET.format(module) - if OLD_SNIPPET in old: - print(" replacing boilerplate in %s" % ipy) - with open(ipy, "w") as f: - f.write(old.replace(OLD_SNIPPET, snippet)) - elif snippet not in old: - print(" appending to %s" % ipy) - with open(ipy, "a") as f: - f.write(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 OSError: - 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)