diff --git a/.coveragerc b/.coveragerc index c80246fe..0bddf5a2 100644 --- a/.coveragerc +++ b/.coveragerc @@ -3,11 +3,10 @@ source = pcdsdaq [report] omit = - #tests - */tests/* - *test* #versioning .*version.* *_version.py - #sim + #tests + *test* + pcdsdaq/tests/* pcdsdaq/sim/* diff --git a/.flake8 b/.flake8 new file mode 100644 index 00000000..78b23db7 --- /dev/null +++ b/.flake8 @@ -0,0 +1,23 @@ +[flake8] +exclude = .git,__pycache__,build,dist,pcdsdaq/_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 00000000..8fb235d7 --- /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 d3df9826..00a7b00c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -pcdsdaq/_version.py export-subst +.git_archival.txt export-subst diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fe4683ce..d60529e5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,8 +1,13 @@ # See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks +exclude: | + (?x)^( + pcdsdaq/_version.py| + )$ + repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.5.0 + rev: v4.4.0 hooks: - id: no-commit-to-branch - id: trailing-whitespace @@ -17,12 +22,12 @@ repos: exclude: '^(conda-recipe/meta.yaml)$' - id: debug-statements -- repo: https://gitlab.com/pycqa/flake8.git - rev: 3.8.3 +- repo: https://github.com/pycqa/flake8.git + rev: 6.0.0 hooks: - id: flake8 - repo: https://github.com/timothycrosley/isort - rev: 5.5.2 + rev: 5.12.0 hooks: - id: isort diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 916841ee..00000000 --- a/.travis.yml +++ /dev/null @@ -1,49 +0,0 @@ -version: ~> 1.0 - -env: - global: - - secure: "BrDoqAjZeFnW5vGe3AtVSHgXWb16DthqQwiefN+lNhcllQw6WXFx4PvpwNGM1PI3voLg6YJM/9mOrVOk5nSYjh65DQmlJ6jNX1ezJoI30hURhykoXJNrKr25JTF54GhgMgk/KiR3fhGQYJgpXUxPxYPBt3PvXd7uY0cMIYCFAW8gwrupVfHbPo1zGbxHzxysBlxpQQAclBj4pVMIX5chkVM/Yviv72mEkyoKPJpQgCCn7CstQSLhHtM+EK+bHpqjIk37cnGi/lTZYxlmrMjEeU/UXxL2/y2uA43W8sdsD2vCEiMcexjD2cqhjOr1Qn1zZgzHchSapkHsju1KHdCOeiWE/yV9Ni/fteb4doKnSQOIY/hqofqkyETFfNarOa9Zsm5i03QUyFNub2hr6k6lWRal5MaOErGiUAVlKCYj5KBe/AYHC758rmm1YIukYXKn2cBfApt+sCSc50WGEqjiT1iiUBD6dCP1p4Skd6RpLbwIL6f9THvzAqpQRJpZAtOmffIKpQ0+RUjEQF9UlwPKOgpdAOw2XrK0asrgfh9goiiB7QrzJ0GPa0Wy7BTfi3ksNXskdnatGAFAJiRPBkmcshRFrLx4UIlLx5pTW88G2T0yYXNGi+mEQHXY9rcozZJlVIESYSL1NgRV5aW/gfYC4hqmFfB+93MFG5g05HJ/dlA=" - - # enable the usage of versions menu which allow versioning of the docs - # pages and not only the master branch - - DOCTR_VERSIONS_MENU="1" - # Dependency files used to build the documentation (space separated) - - DOCS_REQUIREMENTS="docs-requirements.txt dev-requirements.txt requirements.txt" - # Options to be passed to flake8 for package linting. Usually this is just - # the package name but you can enable other flake8 options via this config - - PYTHON_LINT_OPTIONS="pcdsdaq" - - # The name of the conda package - - CONDA_PACKAGE="pcdsdaq" - # The folder containing the conda recipe (meta.yaml) - - CONDA_RECIPE_FOLDER="conda-recipe" - # Extra dependencies needed to run the tests which are not included - # at the recipe and dev-requirements.txt. E.g. PyQt - - CONDA_EXTRAS="pip" - # Requirements file with contents for tests dependencies - - CONDA_REQUIREMENTS="dev-requirements.txt" - - # Extra dependencies needed to run the test with Pip (similar to - # CONDA_EXTRAS) but for pip - - PIP_EXTRAS="" - -jobs: - allow_failures: - - name: "Pre-commit Checks" -# - name: "Python - PIP" - -import: - # This import enables a set of standard python jobs including: - # - Build - # - Anaconda Package Build - # - Tests - # - Python Linter - # - Package Linter - # - Documentation - # - Python 3.6 - PIP based - # - Python 3.6, 3.7 & 3.8 - Conda base - # - Deploy - # - Documentation using doctr - # - Conda Package - uploaded to pcds-dev and pcds-tag - # - PyPI - - pcdshub/pcds-ci-helpers:travis/shared_configs/standard-python-conda-latest.yml diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 00000000..a99ffb48 --- /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 00000000..280e3c3e --- /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/pcdsdaq/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 +~~~~~~~~~~~~~~~~~~~ + +pcdsdaq could always use more documentation, whether +as part of the official pcdsdaq 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/pcdsdaq/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 `pcdsdaq` for local development. + +1. Fork the `pcdsdaq` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/pcdsdaq.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 pcdsdaq python=3.9 pip + $ cd pcdsdaq/ + $ 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 336b168d..e14da2c1 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2018, 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 a6609066..00000000 --- a/conda-recipe/build.sh +++ /dev/null @@ -1 +0,0 @@ -$PYTHON setup.py install --single-version-externally-managed --record=record.txt diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml index 4d673215..c3c83372 100644 --- a/conda-recipe/meta.yaml +++ b/conda-recipe/meta.yaml @@ -1,8 +1,10 @@ -{% set data = load_setup_py_data() %} +{% set package_name = "pcdsdaq" %} +{% set import_name = "pcdsdaq" %} +{% set version = load_file_regex(load_file=os.path.join(import_name, "_version.py"), regex_pattern=".*version = '(\S+)'").group(1) %} package: - name: pcdsdaq - version : {{ data.get('version') }} + name: {{ package_name }} + version: {{ version }} source: path: .. @@ -10,22 +12,27 @@ source: build: number: 0 noarch: python + script: {{ PYTHON }} -m pip install . -vv requirements: build: - - python >=3.9 - - setuptools + - python >=3.9 + - setuptools_scm + - pip run: - - python >=3.6 - - bluesky >=1.6.0 - - ophyd >=1.5.0 - - pcdsdevices >=2.1.0 - - psdaq-control-minimal >=3.3.19 - - toolz + - python >=3.9 + - bluesky >=1.6.0 + - ophyd >=1.5.0 + - pcdsdevices >=2.1.0 + - psdaq-control-minimal >=3.3.19 + - toolz test: imports: - - pcdsdaq + - pcdsdaq + requires: + - pytest + - pytest-timeout about: home: https://github.com/pcdshub/pcdsdaq diff --git a/dev-requirements.txt b/dev-requirements.txt index c5a54092..a9f5ceea 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,3 +1,2 @@ pytest pytest-timeout -flake8 diff --git a/docs-requirements.txt b/docs-requirements.txt index f1e279d8..7df0a577 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,4 @@ -doctr +docs-versions-menu sphinx sphinx_rtd_theme +sphinxcontrib-jquery diff --git a/docs/source/conf.py b/docs/source/conf.py index 81b15c82..111302f0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # # pcdsdaq documentation build configuration file, created by # sphinx-quickstart. @@ -19,7 +18,7 @@ module_path = os.path.join( os.path.dirname(os.path.abspath(__file__)), - '../../', + "../../", ) sys.path.insert(0, module_path) @@ -37,26 +36,30 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'IPython.sphinxext.ipython_directive', - 'IPython.sphinxext.ipython_console_highlighting', - 'sphinx.ext.napoleon'] +extensions = [ + "IPython.sphinxext.ipython_console_highlighting", + "IPython.sphinxext.ipython_directive", + "docs_versions_menu", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.napoleon", + "sphinxcontrib.jquery", +] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'pcdsdaq' +project = "pcdsdaq" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -65,13 +68,13 @@ # The short X.Y version. import pcdsdaq # noqa: E402 -version = pcdsdaq.__version__ +version = str(pcdsdaq.__version__) # The full version, including alpha/beta/rc tags. -release = pcdsdaq.__version__ +release = str(pcdsdaq.__version__) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -# language = None +# language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -81,11 +84,11 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all # documents. -default_role = 'any' +default_role = "any" # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True @@ -99,7 +102,7 @@ # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -138,7 +141,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"] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -182,7 +185,7 @@ # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pcdsdaqdoc' +htmlhelp_basename = "pcdsdaqdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -190,10 +193,8 @@ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # 'preamble': '', } @@ -202,10 +203,13 @@ # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', - 'pcdsdaq.tex', - u'pcdsdaq Documentation', - u"SLAC National Accelerator Laboratories", 'manual'), + ( + "index", + "pcdsdaq.tex", + "pcdsdaq Documentation", + "SLAC National Accelerator Laboratories", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -234,8 +238,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pcdsdaq', u'pcdsdaq Documentation', - [u"SLAC National Accelerator Laboratories"], 1) + ( + "index", + "pcdsdaq", + "pcdsdaq Documentation", + ["SLAC National Accelerator Laboratories"], + 1, + ) ] # If true, show URL addresses after external links. @@ -249,15 +258,13 @@ # dir menu entry, description, category) texinfo_documents = [ ( - 'index', - 'pcdsdaq', + "index", + "pcdsdaq", "pcdsdaq Documentation", "SLAC National Accelerator Laboratory", - 'pcdsdaq', - ( - "LCLS DAQ Control Interface" - ), - 'Miscellaneous', + "pcdsdaq", + ("LCLS DAQ Control Interface"), + "Miscellaneous", ), ] diff --git a/github_deploy_key_pcdshub_pcdsdaq.enc b/github_deploy_key_pcdshub_pcdsdaq.enc deleted file mode 100644 index 4b364536..00000000 --- a/github_deploy_key_pcdshub_pcdsdaq.enc +++ /dev/null @@ -1 +0,0 @@ -gAAAAABamf1yw3ATnVet1x2aNMo20TQJeoTT-3eH1NWKMgJV0qZYGwlXP5BAk6ieCjf36DIw38tY9gAZfgwvRjT4SrOaPbu4y6Up_ItZMih-Nd-ZzYpPMwyhhAsCpEyFwosLj1i-rJyDWHWNtYiVYmZSXpfkmtTbu8rLqSDqiyScIsRXf72td639_b316_KTo6tPkTxmqFVqZi8-jzGCUrj4DVzbJbJAlm1LiGWnfj6yKs1_UOydjqNLzBBhprXsO880Qrr3fsbcSYnkF4slCtweEcFSBCphTSJCW352SLlhnnEFO6te_sYbGt7jWENyF9niNXltt3ByH33SDF2qjr6Pi-NDTVEc0i1fsHb9CLR4f-3s3Q0Zqa7_LvIlc43Bf_Y9mcKLlhSRoT_kGoOqE6cmAN8okHAOJp2ZhxEkSY_bCWGYtBAd1mPPJIM2sxKu2bzcjYyPTodY-veaUBQHyJJXO-M4aN8JFUawR32Ebt43lySBti14r8thd90v2rpEQv8GvJ4VVHervbwvtxn7asEBegHAKQOkOPZAtMo8dHtVVIqgGuE5PdEYLE6DEgBAvHnUhBzvy17IBy8yLZFtKSc_kCkmbPyfiK9BF3c2gELx2UZCZlS6Dw1sjtFPV_5FiCecH4QJNB2rMITVdOMMN7eclD0Fbenb1i6cNNSpsri3hjh8KQC73Cf0utimnv8q0qpCnkYFucdqv_Ztb9q5gqWamDQtivUWaG_KDTpGmbRF9nIf52jNk1poyK5mH7jrju2BZ4gYKKJuzOfVBOkSriOJvk6u486ffKwlopkuUrzFIjGG685w9MdOgRfTbLCP__lOd1mNXFrBebnQ3er2y5jl8Kk3J-gTZmQ2Q5uyuTDZ0dSXKqKA9_2J-gxnOdJ3rVieQxJNAWYgaRYh7p2CpLdZ8zZFnH0Om1beFXVExdNtZcP7rP9niaWDru6yN3SaOwGWAJk8R-2xkK8nU5wRXWrZs-1HmjWjrZHv77thypwb-s0bV6MgS7jJCMPqdQlx2gEUpOJ7rjT6xqPB7pqN0fI69Efk7aJFS9EFQpnN1zDUc3h-UbaEyVS8gp_PW-xsl8746SvUTF0vT_32ECUDpI51KdGNiVmM4-0KA1PV4mTpdnpma6w22y8eF5TYJKD9ZamZJft4tYfqKsTCmZUfbQZ2e_xrWgPwqDM5VGw8MWpWzh8SZho8oF7Qf3uvwRv3E3fG0DCO-WtSZAxbMLV7R4aNEk8MrWWq5ecC3FYrY6sKWUKAQbHfWPA52K8C6mRKbQXbY2sE_SGNs6dLTupm7_q9y5xoqY9AsQNcOLYJcsQe2IWuH1ztTZsNt0FFmZ020rBHj25eDTn2fw9GXE_hTL9iOMaPQZeNNtijlFCb0pEUHhi_SQQZVzwh_RxnWX9rJGb2TYZ5JsO7bBb6JX3CP0OozOeymmHrHc59fRHoMhbtnbff1xK9Lpfq--0Qxjog4PJinzD03apHhMm1oEk_H24xRGolbRBanuza5_-2WXjyCC0s77oVubYP00CrxJZMwZio2G3S4RQlNrrIRGvQw3IRZpDtDQIuOeVTaBrOBTaUyVp7U9-cvMZCZ13i29wnAhQNS_TOY6F0vXz6sCsDUcp8HV4cCX-2i1yivSAq4u78thcgsZ8idw3-O2TRArlZ4C0eqZbOzjwxBI7NkLtJvqw8TPlV5jQD11RkIPWtjNFZqmQq4qSLgHEERSHYnoFGExrHAoX4v3luXeSeJM4obHUmRo-I8Iuf6Fo3wwYgIxxMz9x51AvP_2F-2Jvyk2BHgf8Y1JAYtRgfroGGJ0N8TN9olF3_g6QIJb9y6H5WdJubRoCcvMz44L5jWRXRIKE3vAHOJi6Hy5EONGmZN_jImgouiwfDUlfuF5PmiKuMjymYs1AWor2BzyZgbhemvGUe7MGpjKnZNhpn7qpV18CYyrMDVhiE0L7vvpZC_HXxDPTxFkxxnmFp8eK9Fs5kojdGDLs_njhv0CTWc-Jf3u5DDgd7CW4Jv2YqBgv7gwnKh5W7IjErMkQnrTNM3bFiEvE2MK3MYQLWAhgqSiwmNeOrRrq7BAytyXv3K3gEGIsynsWt_03gaf9YouQ_AtXByfnlHKIEr1T42IwKDMaSWuJ2Hl_XJOTDOWuwsOHIdXnp7RFX7FQFlnwqZr7QVWqVzcoN6b6dJ7h8VDKgxxpSQ1yYDisCIZHJtBcpDjV8VW17uih1GexvpzlK1H6n1U_FhOEbFWULjNSeKnPYxL8os8Hr8FlejDPj60iM4C40b2CuX4brWQL564ssoHAjCuuZ_qv2ysd6YfUjUXNFi4D7X_2iFx6xBCW5Z8GQ4axjLjuYrn35oXPOOK4Bm_mKJfRtoaBqyPPwk5f4lX_Ig8ErPl-Zo1_gdqox7OqxNU6LofdwfRG4MxvdT_lhjZG-6BUXl0hFYh1Uw_r12jY1d8vRzXu-KZW8lc69i5eJoAvZrN9mDDo-2jSrCwV-jbhdzLz0-CfDWdGYVvy8aNxGB66-p24O3x6ZGOsKOIgTEYyMgxLGC0yK_8rZ-gRwthNIGH2GdU49L-tw_oUcCXO4rWSSuS6jqLj59yoeR6EuyTnJvCpJTxf0Yq3Z0T7LjO0dRJc2w9bBOPp6DF0CRYfFcqbivTmeE25i4JSGKe6fwDyG9NTk-Drpejrb8OscXPzMr-RypVq5xeiTMWzD-km5i1C5I0aZ-b-hfhHDfcaB-tHMTyouNJzW18qKcTtorc5AjLv2wtYFWKw_zrarao2VzxbUrPLFUjZejfDO1UZWzbPA_3imEujmN45Mjseu0l4k8ohhBZaszHc5q5__Oyx6jjWOdZ9ueGImNoG5mo-6eMt9gBbzTlL2py1hZRwY6Cvp4UcJLxRUrVo1r1GuontCm5cJNu3bpDMjQVzg-Dk8zTLhk32AIjqavTb2znGF-QrEfm5oO4U8jndgKGLJ8WcEAvAimFvuAOaRWmbN8YljphRYmboCH2_WHDPvAAW36odwujOam6P3vnYP4gcARfemshe-Vrz493Y9h8v8qlSX0SClTcl5dl6SCMuumkbop3ApfPWst0DcGo-vo-Qo-vK5FhM6Nl9A0VIdBAdwzHkzTPtq5tiVfRCUxV9kS1HiCsKHO8hU5InmL8LCIqdgLxSiVxFyDcL7vW0GNjI8FZnL5Iv2W9Hv4QNLNv_M-PREq3ExULdXwOWrMSZGqSabdpcArVGb4v_4tUpowSzoCs6vIchFDycgqaY7t7tngv15wey8kjCApbei9SQmSWUvnQrFLo7OYwtsj9hbUM3J5bDZ1AVEkxJCjaOnAi2in8Sd4-7y7NRd6FdvumWI3jPNgi5-Q7ekyka66loWMI1N769KJpBWymPgvAIx9AcQKbk_nGSJ2d2qrWyEXTrOUab0ouGJ5BWL7HJBpzTNYhwk_IMjeHiB13rRJPGZwp3AvhOpcI-7emkHenX7x2wEqfjuftRIWUFJ_djO4MdR-UFluKNuqcz3q04kRhj4LmOuN2sCEgVj5V31T7O8befrrJWuQcJUCkQsyKq7ybmJLwoYj8EF6wGOV6-w84dMn-cwhOwyHsnVIopDWkxfaBwrSW0rEkm9V3HnrcGAB2SaSVt3lXLm4YlPUZuhFB57GHt6Sl3OGsuclfEWcPGU2Y7GvDBkosKbnb1AHlKphwPI1rL3vfWWrDfioT6vUCU6JdStwWQ-JooRxFXESMsPqXxLwp_fIw1iyGVUUq0eZAGC9eNjkj4SXI6yFwILhjf-O1UoTaktEnujw07izZMx1jgmW7DSJa5hst1t0-nOVwkeJ-VeLJ81guJ19JPQzlnidc6PsUodFz4lUkSuofhDMV4ghWuFqPi0A5xDMH9KFC9YapI4998LolK33-wFlwP1ZU6S4uo3miL0FEM1S5yfhTDLe3tvFn8SyQlLWqIM3RCwpXBj_tD1w8H20sL4WZaeUo1JuinxbQwO1NFZ1cQtlGffH-mWsNAibfkDoLQiMosp31gMDp6JsmmN3tgHxB5MLsTHXPB1hirLjLnj1K3yTTzVesY0iv-C6vHM5SciMy11LZkafUjnwbgExbGwqFUU_IW04zzbKqHnT2XDGvrHBsFV4BrXHuKLbyoByE9AOW0vKiARS4f0kis0swm4e-doaO6vmEGDOJ3Kq59v1VADqpmmQ3F7zgz57oxc9i01jRo2_yxMEv8jP7aPAH0TMClPWKiktF_joStea8Eq63L8z3Js2DLJ9YU-zA1Ill1Q7FCMdQFbJjnmZVRCFpqBIHVDCBEPynTCSK_D74KDptq7be5k0Ebl5NvYm-ITVTV5EWvh84m9da5A1S4ASFnMVE5c5G5KmJN51Pa1yGmCS_zbA0N7kZlr3-l9HmH3xtJlaMfz-WawY0tfv8YZaMdM3dy22afj3oxlzZE= \ No newline at end of file diff --git a/pcdsdaq/__init__.py b/pcdsdaq/__init__.py index 25b27fb8..5c0cf285 100644 --- a/pcdsdaq/__init__.py +++ b/pcdsdaq/__init__.py @@ -1,4 +1 @@ -from ._version import get_versions - -__version__ = get_versions()['version'] -del get_versions +from .version import __version__ # noqa: F401 diff --git a/pcdsdaq/_version.py b/pcdsdaq/_version.py deleted file mode 100644 index fdfe9ecd..00000000 --- a/pcdsdaq/_version.py +++ /dev/null @@ -1,519 +0,0 @@ -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "$Format:%d$" - git_full = "$Format:%H$" - git_date = "$Format:%ci$" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - return keywords - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "pep440" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "None" - cfg.versionfile_source = "pcdsdaq/_version.py" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(refs - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree", - "date": None} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version", "date": None} diff --git a/pcdsdaq/ami.py b/pcdsdaq/ami.py index dd06e54a..9fd0c1b0 100644 --- a/pcdsdaq/ami.py +++ b/pcdsdaq/ami.py @@ -289,7 +289,7 @@ def basic_filter(ami_name, lower, upper): ------- filter_string: ``str`` """ - return '{}<{}<{}'.format(lower, ami_name, upper) + return f'{lower}<{ami_name}<{upper}' def evr_filter(event_code): diff --git a/pcdsdaq/daq/interface.py b/pcdsdaq/daq/interface.py index 7aeccdf9..4fedd144 100644 --- a/pcdsdaq/daq/interface.py +++ b/pcdsdaq/daq/interface.py @@ -15,8 +15,9 @@ import logging import threading import time +from collections.abc import Generator from enum import Enum, IntEnum -from typing import Any, ClassVar, Generator, Optional, Union +from typing import Any, ClassVar, Union from bluesky import RunEngine from ophyd.device import Component as Cpt @@ -74,7 +75,7 @@ class TernaryBool(IntEnum): @classmethod def from_primitive( cls, - value: Union[bool, TernaryBool, None], + value: bool | TernaryBool | None, ) -> TernaryBool: if value in (None, TernaryBool.NONE): return cls.NONE @@ -82,7 +83,7 @@ def from_primitive( return cls.TRUE return cls.FALSE - def to_primitive(self) -> Optional[bool]: + def to_primitive(self) -> bool | None: if self == TernaryBool.NONE: return None else: @@ -121,7 +122,7 @@ class DaqStateTransitionError(DaqError): # Helper functions -def get_daq() -> Optional[DaqBase]: +def get_daq() -> DaqBase | None: """ Called by other modules to get the registered `DaqBase` instance. @@ -345,13 +346,13 @@ class DaqBase(BaseInterface, Device): requires_configure_transition: ClassVar[set[str]] # Variables from init - _RE: Optional[RunEngine] - hutch_name: Optional[str] - platform: Optional[int] + _RE: RunEngine | None + hutch_name: str | None + platform: int | None _last_config: dict[str, Any] _queue_configure_transition: bool _default_config_overrides: dict[str, Any] - _re_cbid: Optional[int] + _re_cbid: int | None # Tab configuration for hutch-python tab filtering tab_whitelist = ( @@ -373,9 +374,9 @@ class DaqBase(BaseInterface, Device): def __init__( self, - RE: Optional[RunEngine] = None, - hutch_name: Optional[str] = None, - platform: Optional[int] = None, + RE: RunEngine | None = None, + hutch_name: str | None = None, + platform: int | None = None, *, name: str = 'daq', ): @@ -458,7 +459,7 @@ def state(self) -> str: def wait( self, - timeout: Optional[float] = None, + timeout: float | None = None, end_run: bool = False, ) -> None: """ @@ -733,7 +734,7 @@ def configure(self, **kwargs) -> tuple[dict, dict]: def config_info( self, - config: Optional[dict[str, Any]] = None, + config: dict[str, Any] | None = None, header: str = 'Config:', ) -> None: """ @@ -761,13 +762,13 @@ def config_info( txt = [] for key, value in config.items(): if value is not None: - txt.append('{}={}'.format(key, value)) + txt.append(f'{key}={value}') if header: header += ' ' logger.info(header + ', '.join(txt)) @property - def record(self) -> Optional[bool]: + def record(self) -> bool | None: """ Whether or not to record data. @@ -782,7 +783,7 @@ def record(self) -> Optional[bool]: return self.record_cfg.get().to_primitive() @record.setter - def record(self, record: Union[bool, TernaryBool, None]): + def record(self, record: bool | TernaryBool | None): self.preconfig(record=record, show_queued_cfg=False) def stage(self) -> list[DaqBase]: diff --git a/pcdsdaq/daq/lcls1.py b/pcdsdaq/daq/lcls1.py index 890a17b3..044da865 100644 --- a/pcdsdaq/daq/lcls1.py +++ b/pcdsdaq/daq/lcls1.py @@ -15,7 +15,7 @@ import threading import time from importlib import import_module -from typing import Any, Optional, Union +from typing import Any from bluesky import RunEngine from ophyd.device import Component as Cpt @@ -91,8 +91,8 @@ class DaqLCLS1(DaqBase): def __init__( self, - RE: Optional[RunEngine] = None, - hutch_name: Optional[str] = None, + RE: RunEngine | None = None, + hutch_name: str | None = None, ): if pydaq is None: globals()['pydaq'] = import_module('pydaq') @@ -155,12 +155,13 @@ def connect(self) -> None: except Exception as exc: if 'query' in str(exc): err = True - logger.error(('Failed to connect: DAQ is not ' - 'allocated!')) + logger.error("Failed to connect: DAQ is not allocated!") if not (err or conn): err = True - logger.error(('Failed to connect: DAQ is not running on this ' - 'machine, and is not allocated!')) + logger.error( + "Failed to connect: DAQ is not running on this " + "machine, and is not allocated!" + ) if err: logger.debug('del Daq.control') del self._control @@ -187,7 +188,7 @@ def disconnect(self) -> None: @check_connect def wait( self, - timeout: Optional[float] = None, + timeout: float | None = None, end_run: bool = False, ) -> None: """ @@ -218,11 +219,11 @@ def wait( def begin( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[int, None, Sentinel] = CONFIG_VAL, - record: Union[bool, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: int | None | Sentinel = CONFIG_VAL, + record: bool | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, wait: bool = False, end_run: bool = False, ): @@ -297,9 +298,9 @@ def _begin_timeout(self) -> int: def begin_infinite( self, - record: Union[bool, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, + record: bool | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, ) -> None: """ Start the daq to run forever in the background. @@ -372,10 +373,10 @@ def trigger(self) -> Status: @check_connect def kickoff( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[int, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: int | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, ) -> Status: """ Begin acquisition. This method is non-blocking. @@ -529,12 +530,12 @@ def finish_thread(control, status): def preconfig( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[int, None, Sentinel] = CONFIG_VAL, - record: Union[bool, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - begin_sleep: Union[int, None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: int | None | Sentinel = CONFIG_VAL, + record: bool | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, + begin_sleep: int | None | Sentinel = CONFIG_VAL, show_queued_cfg: bool = True, ) -> None: """ @@ -566,12 +567,12 @@ def preconfig( @check_connect def configure( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[int, None, Sentinel] = CONFIG_VAL, - record: Union[bool, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - begin_sleep: Union[int, None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: int | None | Sentinel = CONFIG_VAL, + record: bool | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, + begin_sleep: int | None | Sentinel = CONFIG_VAL, ) -> tuple[dict, dict]: """ Changes the daq's configuration for the next run. @@ -637,7 +638,7 @@ def configure( events, duration, record, use_l3t, controls, begin_sleep) state = self.state if state not in ('Connected', 'Configured'): - err = 'Cannot configure from state {}!'.format(state) + err = f'Cannot configure from state {state}!' raise DaqStateTransitionError(err) self._check_duration(duration) @@ -734,10 +735,10 @@ def _ctrl_arg(self, controls: ControlsArg) -> list[tuple[str, Any]]: def _begin_args( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[int, None, Sentinel] = CONFIG_VAL, - use_l3t: Union[bool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: int | None | Sentinel = CONFIG_VAL, + use_l3t: bool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, ) -> dict[str, Any]: """ For a given set of arguments to `begin`, return the arguments that @@ -777,7 +778,7 @@ def _begin_args( begin_args['controls'] = self._ctrl_arg(controls) return begin_args - def _check_duration(self, duration: Union[int, None, Sentinel]): + def _check_duration(self, duration: int | None | Sentinel): if duration not in (None, CONFIG_VAL) and duration < 1: msg = ('Duration argument less than 1 is unreliable. Please ' 'use the events argument to specify the length of ' @@ -785,7 +786,7 @@ def _check_duration(self, duration: Union[int, None, Sentinel]): raise RuntimeError(msg) @property - def _events(self) -> Optional[int]: + def _events(self) -> int | None: """ For the current `begin` cycle, how many ``events`` we told the daq to run for. @@ -796,7 +797,7 @@ def _events(self) -> Optional[int]: return events @property - def _duration(self) -> Optional[int]: + def _duration(self) -> int | None: """ For the current `begin` cycle, how long we told the daq to run for in seconds. @@ -822,7 +823,7 @@ def _reset_begin(self) -> None: self._begin = dict(events=None, duration=None, use_l3t=None, controls=None) - def run_number(self, hutch_name: Optional[str] = None): + def run_number(self, hutch_name: str | None = None): """ Determine the run number of the last run, or current run if running. @@ -862,8 +863,9 @@ def run_number(self, hutch_name: Optional[str] = None): hutch_name = hutch_name.lower() if hutch_name not in ('amo', 'sxr', 'xpp', 'xcs', 'mfx', 'cxi', 'mec', 'tst'): - raise ValueError(('{} is not a valid hutch, cannot determine ' - 'run number'.format(hutch_name))) + raise ValueError( + f"{hutch_name} is not a valid hutch, cannot determine run number" + ) if self.state in ('Open', 'Running') and self.config['record']: return ext_scripts.get_run_number(hutch=hutch_name, live=True) else: @@ -880,7 +882,7 @@ def __del__(self): def set_filter( self, *args, - event_codes: Optional[list[int]] = None, + event_codes: list[int] | None = None, operator: str = '&', or_bykik: bool = False, ) -> None: diff --git a/pcdsdaq/daq/lcls2.py b/pcdsdaq/daq/lcls2.py index fbb184fb..d6306b0d 100644 --- a/pcdsdaq/daq/lcls2.py +++ b/pcdsdaq/daq/lcls2.py @@ -45,9 +45,10 @@ import logging import threading import time +from collections.abc import Iterator from functools import cache from numbers import Real -from typing import Any, Iterator, Optional, Union, get_type_hints +from typing import Any, Union, get_type_hints from bluesky import RunEngine from ophyd.device import Component as Cpt @@ -236,8 +237,8 @@ def __init__( platform: int, host: str, timeout: int, - RE: Optional[RunEngine] = None, - hutch_name: Optional[str] = None, + RE: RunEngine | None = None, + hutch_name: str | None = None, sim: bool = False, ): logger.debug( @@ -391,7 +392,7 @@ def _monitor_thread(self) -> None: @state_sig.sub_value def _configured_cb( self, - value: Optional[HelpfulIntEnum], + value: HelpfulIntEnum | None, **kwargs, ) -> None: """ @@ -425,7 +426,7 @@ def state(self) -> str: def wait( self, - timeout: Optional[float] = None, + timeout: float | None = None, end_run: bool = False, ) -> None: """ @@ -457,9 +458,9 @@ def wait( def _get_status_for( self, - state: Optional[Iterator[EnumId]] = None, - transition: Optional[Iterator[EnumId]] = None, - timeout: Optional[float] = None, + state: Iterator[EnumId] | None = None, + transition: Iterator[EnumId] | None = None, + timeout: float | None = None, check_now: bool = True, ) -> Status: """ @@ -589,7 +590,7 @@ def clean_up(status: Status) -> None: def _get_done_status( self, - timeout: Optional[float] = None, + timeout: float | None = None, check_now: bool = True, ) -> Status: """ @@ -630,7 +631,7 @@ def _get_done_status( def _state_transition( self, state: EnumId, - timeout: Optional[float] = None, + timeout: float | None = None, wait: bool = True, ) -> Status: """ @@ -941,19 +942,19 @@ def begin( self, wait: bool = False, end_run: bool = False, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[Real, None, Sentinel] = CONFIG_VAL, - record: Union[bool, TernaryBool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - motors: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - begin_timeout: Union[Real, None, Sentinel] = CONFIG_VAL, - begin_sleep: Union[Real, None, Sentinel] = CONFIG_VAL, - group_mask: Union[int, None, Sentinel] = CONFIG_VAL, - detname: Union[str, None, Sentinel] = CONFIG_VAL, - scantype: Union[str, None, Sentinel] = CONFIG_VAL, - serial_number: Union[str, None, Sentinel] = CONFIG_VAL, - alg_name: Union[str, None, Sentinel] = CONFIG_VAL, - alg_version: Union[list[int], None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: Real | None | Sentinel = CONFIG_VAL, + record: bool | TernaryBool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, + motors: ControlsArg | None | Sentinel = CONFIG_VAL, + begin_timeout: Real | None | Sentinel = CONFIG_VAL, + begin_sleep: Real | None | Sentinel = CONFIG_VAL, + group_mask: int | None | Sentinel = CONFIG_VAL, + detname: str | None | Sentinel = CONFIG_VAL, + scantype: str | None | Sentinel = CONFIG_VAL, + serial_number: str | None | Sentinel = CONFIG_VAL, + alg_name: str | None | Sentinel = CONFIG_VAL, + alg_version: list[int] | None | Sentinel = CONFIG_VAL, ) -> None: """ Interactive starting of the DAQ. @@ -1479,19 +1480,19 @@ def preconfig( def configure( self, - events: Union[int, None, Sentinel] = CONFIG_VAL, - duration: Union[Real, None, Sentinel] = CONFIG_VAL, - record: Union[bool, TernaryBool, None, Sentinel] = CONFIG_VAL, - controls: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - motors: Union[ControlsArg, None, Sentinel] = CONFIG_VAL, - begin_timeout: Union[Real, None, Sentinel] = CONFIG_VAL, - begin_sleep: Union[Real, None, Sentinel] = CONFIG_VAL, - group_mask: Union[int, None, Sentinel] = CONFIG_VAL, - detname: Union[str, None, Sentinel] = CONFIG_VAL, - scantype: Union[str, None, Sentinel] = CONFIG_VAL, - serial_number: Union[str, None, Sentinel] = CONFIG_VAL, - alg_name: Union[str, None, Sentinel] = CONFIG_VAL, - alg_version: Union[list[int], None, Sentinel] = CONFIG_VAL, + events: int | None | Sentinel = CONFIG_VAL, + duration: Real | None | Sentinel = CONFIG_VAL, + record: bool | TernaryBool | None | Sentinel = CONFIG_VAL, + controls: ControlsArg | None | Sentinel = CONFIG_VAL, + motors: ControlsArg | None | Sentinel = CONFIG_VAL, + begin_timeout: Real | None | Sentinel = CONFIG_VAL, + begin_sleep: Real | None | Sentinel = CONFIG_VAL, + group_mask: int | None | Sentinel = CONFIG_VAL, + detname: str | None | Sentinel = CONFIG_VAL, + scantype: str | None | Sentinel = CONFIG_VAL, + serial_number: str | None | Sentinel = CONFIG_VAL, + alg_name: str | None | Sentinel = CONFIG_VAL, + alg_version: list[int] | None | Sentinel = CONFIG_VAL, ): """ Adjusts the configuration, causing a "configure" transition if needed. @@ -1663,10 +1664,9 @@ def record(self) -> bool: return cfg_record.to_primitive() @record.setter - def record(self, record: Optional[bool]) -> None: + def record(self, record: bool | None) -> None: self.preconfig(record=record, show_queued_cfg=False) - def _set_record_state(self, record: bool) -> None: """ Explicitly modify the DAQ's recording state and increment the counter. @@ -1891,7 +1891,7 @@ def setState( self, state: EnumId, phase1_info: dict[str, Any], - ) -> Optional[str]: + ) -> str | None: """ Request the needed transitions to get to state. @@ -1962,7 +1962,7 @@ def sim_set_states( self, transition: EnumId, state: EnumId, - ) -> Optional[str]: + ) -> str | None: """Change the currently set state and emit update.""" logger.debug("SimDaqControl.sim_set_state(%s, %s)", transition, state) with self._lock: @@ -1979,7 +1979,7 @@ def sim_set_states( self._last_run_number += 1 self.sim_new_status(self._headers.status) - def sim_transition(self, state: EnumId) -> Optional[str]: + def sim_transition(self, state: EnumId) -> str | None: """Internal transition, checks if valid.""" logger.debug("SimDaqControl.sim_transition(%s)", state) with self._lock: diff --git a/pcdsdaq/daq/original.py b/pcdsdaq/daq/original.py index fd89e569..620ad50f 100644 --- a/pcdsdaq/daq/original.py +++ b/pcdsdaq/daq/original.py @@ -193,12 +193,13 @@ def connect(self): except Exception as exc: if 'query' in str(exc): err = True - logger.error(('Failed to connect: DAQ is not ' - 'allocated!')) + logger.error("Failed to connect: DAQ is not allocated!") if not (err or conn): err = True - logger.error(('Failed to connect: DAQ is not running on this ' - 'machine, and is not allocated!')) + logger.error( + "Failed to connect: DAQ is not running on this " + "machine, and is not allocated!" + ) if err: logger.debug('del Daq.control') del self._control @@ -681,7 +682,7 @@ def configure(self, events=_CONFIG_VAL, duration=_CONFIG_VAL, events, duration, record, use_l3t, controls, begin_sleep) state = self.state if state not in ('Connected', 'Configured'): - err = 'Cannot configure from state {}!'.format(state) + err = f'Cannot configure from state {state}!' raise StateTransitionError(err) self._check_duration(duration) @@ -746,7 +747,7 @@ def config_info(self, config=None, header='Config:'): txt = [] for key, value in config.items(): if value is not None: - txt.append('{}={}'.format(key, value)) + txt.append(f'{key}={value}') if header: header += ' ' logger.info(header + ', '.join(txt)) @@ -1066,8 +1067,9 @@ def run_number(self, hutch_name=None): hutch_name = hutch_name.lower() if hutch_name not in ('amo', 'sxr', 'xpp', 'xcs', 'mfx', 'cxi', 'mec', 'tst'): - raise ValueError(('{} is not a valid hutch, cannot determine ' - 'run number'.format(hutch_name))) + raise ValueError( + f"{hutch_name} is not a valid hutch, cannot determine run number" + ) if self.state in ('Open', 'Running') and self.config['record']: return ext_scripts.get_run_number(hutch=hutch_name, live=True) else: diff --git a/pcdsdaq/ext_scripts.py b/pcdsdaq/ext_scripts.py index 156b4248..8874c449 100644 --- a/pcdsdaq/ext_scripts.py +++ b/pcdsdaq/ext_scripts.py @@ -13,7 +13,7 @@ def call_script(args, timeout=None, ignore_return_code=False): logger.debug('Calling external script %s with timeout=%s,' ' ignore_fail=%s', args, timeout, ignore_return_code) try: - return subprocess.check_output(args, universal_newlines=True, + return subprocess.check_output(args, text=True, timeout=timeout) except subprocess.CalledProcessError as exc: if ignore_return_code: diff --git a/pcdsdaq/scan_vars.py b/pcdsdaq/scan_vars.py index c0ee6a14..07b011d9 100644 --- a/pcdsdaq/scan_vars.py +++ b/pcdsdaq/scan_vars.py @@ -1,5 +1,5 @@ import logging -from typing import Any, Dict +from typing import Any from bluesky.callbacks.core import CallbackBase from ophyd.device import Component as Cpt @@ -76,7 +76,7 @@ def disable(self): self._RE.unsubscribe(self._cbid) self._cbid = None - def start(self, doc: Dict[str, Any]): + def start(self, doc: dict[str, Any]): """ Initialize the scan variables at the start of a run. @@ -94,7 +94,7 @@ def start(self, doc: Dict[str, Any]): try: motors = doc['motors'] for i, name in enumerate(motors[:3]): - sig = getattr(self, 'var{}'.format(i)) + sig = getattr(self, f'var{i}') sig.put(name) except KeyError: logger.debug('Skip var names, no "motors" in start doc') @@ -105,7 +105,6 @@ def start(self, doc: Dict[str, Any]): except KeyError: logger.debug('No num_points, skip num from top-level key.') has_top_level_num = False - pass else: self.n_steps.put(num_points) has_top_level_num = True @@ -187,7 +186,7 @@ def update_min_max(self, start: float, stop: float, index: int) -> None: sig_max.put(max(start, stop)) sig_min.put(min(start, stop)) - def setup_inner_product(self, plan_pattern_args: Dict[str, Any]) -> None: + def setup_inner_product(self, plan_pattern_args: dict[str, Any]) -> None: """ Handle max, min, number of steps for inner_product scans. @@ -203,7 +202,7 @@ def setup_inner_product(self, plan_pattern_args: Dict[str, Any]) -> None: num = plan_pattern_args['num'] self.n_steps.put(num) - def setup_outer_product(self, plan_pattern_args: Dict[str, Any]) -> None: + def setup_outer_product(self, plan_pattern_args: dict[str, Any]) -> None: """ Handle max, min, number of steps for outer_product scans. @@ -237,7 +236,7 @@ def setup_outer_product(self, plan_pattern_args: Dict[str, Any]) -> None: def setup_inner_list_product( self, - plan_pattern_args: Dict[str, Any], + plan_pattern_args: dict[str, Any], ) -> None: """ Handle max, min, number of steps for inner_list_product scans. @@ -256,7 +255,7 @@ def setup_inner_list_product( def setup_outer_list_product( self, - plan_pattern_args: Dict[str, Any], + plan_pattern_args: dict[str, Any], ) -> None: """ Handle max, min, number of steps for outer_list_product scans. diff --git a/pcdsdaq/version.py b/pcdsdaq/version.py new file mode 100644 index 00000000..da8a5d52 --- /dev/null +++ b/pcdsdaq/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/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..b3a438b3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,43 @@ +[build-system] +build-backend = "setuptools.build_meta" +requires = [ "setuptools>=45", "setuptools_scm[toml]>=6.2",] + +[project] +classifiers = [ "Development Status :: 2 - Pre-Alpha", "Natural Language :: English", "Programming Language :: Python :: 3",] +description = "DAQ Control Interface" +dynamic = [ "version", "readme", "dependencies", "optional-dependencies", "optional-dependencies",] +keywords = [] +name = "pcdsdaq" +requires-python = ">=3.9" +[[project.authors]] +name = "SLAC National Accelerator Laboratory" + +[options] +zip_safe = false +include_package_data = true + +[project.license] +file = "LICENSE.md" + +[tool.setuptools_scm] +write_to = "pcdsdaq/_version.py" + +[tool."tool:pytest"] +timeout = "60" + +[tool.setuptools.packages.find] +where = [ ".",] +include = [ "pcdsdaq*",] +namespaces = false + +[tool.setuptools.dynamic.readme] +file = "README.rst" + +[tool.setuptools.dynamic.dependencies] +file = [ "requirements.txt",] + +[tool.setuptools.dynamic.optional-dependencies.test] +file = "dev-requirements.txt" + +[tool.setuptools.dynamic.optional-dependencies.doc] +file = "docs-requirements.txt" diff --git a/run_tests.py b/run_tests.py deleted file mode 100644 index d872ec89..00000000 --- a/run_tests.py +++ /dev/null @@ -1,51 +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 - args = ['-v', '-vrxs'] - - # Add extra arguments - if len(sys.argv) > 1: - args.extend(sys.argv[1:]) - - txt = 'pytest arguments: {}'.format(args) - print(txt) - - # Setup logger and log everything to a file - root_logger = logging.getLogger() - root_logger.setLevel(logging.DEBUG) - 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 ' - '%(module)-15s ' - '%(levelname)-8s ' - '%(threadName)-10s ' - '%(message)s'), - datefmt='%H:%M:%S') - handler.setFormatter(formatter) - root_logger.addHandler(handler) - - logger = logging.getLogger(__name__) - logger.info(txt) - - sys.exit(pytest.main(args)) diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 5e7809c4..00000000 --- a/setup.cfg +++ /dev/null @@ -1,8 +0,0 @@ -[versioneer] -VCS = git -style = pep440 -versionfile_source = pcdsdaq/_version.py -versionfile_build = pcdsdaq/_version.py -tag_prefix = v -[tool:pytest] -timeout = 60 diff --git a/setup.py b/setup.py deleted file mode 100644 index a4c22b13..00000000 --- a/setup.py +++ /dev/null @@ -1,14 +0,0 @@ -from setuptools import find_packages, setup - -import versioneer - -setup(name='pcdsdaq', - version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), - license='BSD', - author='SLAC National Accelerator Laboratory', - packages=find_packages(), - scripts=['bin/pcdsdaq_lib_setup'], - include_package_data=True, - description='DAQ Control Interface', - ) diff --git a/tests/test_scan_vars.py b/tests/test_scan_vars.py index 57fc7c64..f04da03a 100644 --- a/tests/test_scan_vars.py +++ b/tests/test_scan_vars.py @@ -1,8 +1,9 @@ import logging +import pytest from bluesky.callbacks.core import CallbackBase from bluesky.plan_stubs import create, read, save -from bluesky.plans import count, scan, grid_scan, list_scan, list_grid_scan +from bluesky.plans import count, grid_scan, list_grid_scan, list_scan, scan from bluesky.preprocessors import run_wrapper, stage_wrapper from ophyd.signal import Signal from ophyd.sim import det1, det2, motor, motor1, motor2, motor3 @@ -10,8 +11,6 @@ import pcdsdaq.daq from pcdsdaq.scan_vars import ScanVars -import pytest - logger = logging.getLogger(__name__) diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index 055fcaf0..00000000 --- a/versioneer.py +++ /dev/null @@ -1,1824 +0,0 @@ - -# Version: 0.18 - -"""The Versioneer - like a rocketeer, but for versions. - -The Versioneer -============== - -* like a rocketeer, but for versions! -* https://github.com/warner/python-versioneer -* Brian Warner -* License: Public Domain -* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy -* [![Latest Version] -(https://pypip.in/version/versioneer/badge.svg?style=flat) -](https://pypi.python.org/pypi/versioneer/) -* [![Build Status] -(https://travis-ci.org/warner/python-versioneer.png?branch=master) -](https://travis-ci.org/warner/python-versioneer) - -This is a tool for managing a recorded version number in distutils-based -python projects. The goal is to remove the tedious and error-prone "update -the embedded version string" step from your release process. Making a new -release should be as easy as recording a new tag in your version-control -system, and maybe making new tarballs. - - -## Quick Install - -* `pip install versioneer` to somewhere to your $PATH -* add a `[versioneer]` section to your setup.cfg (see below) -* run `versioneer install` in your source tree, commit the results - -## Version Identifiers - -Source trees come from a variety of places: - -* a version-control system checkout (mostly used by developers) -* a nightly tarball, produced by build automation -* a snapshot tarball, produced by a web-based VCS browser, like github's - "tarball from tag" feature -* a release tarball, produced by "setup.py sdist", distributed through PyPI - -Within each source tree, the version identifier (either a string or a number, -this tool is format-agnostic) can come from a variety of places: - -* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows - about recent "tags" and an absolute revision-id -* the name of the directory into which the tarball was unpacked -* an expanded VCS keyword ($Id$, etc) -* a `_version.py` created by some earlier build step - -For released software, the version identifier is closely related to a VCS -tag. Some projects use tag names that include more than just the version -string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool -needs to strip the tag prefix to extract the version identifier. For -unreleased software (between tags), the version identifier should provide -enough information to help developers recreate the same tree, while also -giving them an idea of roughly how old the tree is (after version 1.2, before -version 1.3). Many VCS systems can report a description that captures this, -for example `git describe --tags --dirty --always` reports things like -"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the -0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has -uncommitted changes. - -The version identifier is used for multiple purposes: - -* to allow the module to self-identify its version: `myproject.__version__` -* to choose a name and prefix for a 'setup.py sdist' tarball - -## Theory of Operation - -Versioneer works by adding a special `_version.py` file into your source -tree, where your `__init__.py` can import it. This `_version.py` knows how to -dynamically ask the VCS tool for version information at import time. - -`_version.py` also contains `$Revision$` markers, and the installation -process marks `_version.py` to have this marker rewritten with a tag name -during the `git archive` command. As a result, generated tarballs will -contain enough information to get the proper version. - -To allow `setup.py` to compute a version too, a `versioneer.py` is added to -the top level of your source tree, next to `setup.py` and the `setup.cfg` -that configures it. This overrides several distutils/setuptools commands to -compute the version when invoked, and changes `setup.py build` and `setup.py -sdist` to replace `_version.py` with a small static file that contains just -the generated version data. - -## Installation - -See [INSTALL.md](./INSTALL.md) for detailed installation instructions. - -## Version-String Flavors - -Code which uses Versioneer can learn about its version string at runtime by -importing `_version` from your main `__init__.py` file and running the -`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can -import the top-level `versioneer.py` and run `get_versions()`. - -Both functions return a dictionary with different flavors of version -information: - -* `['version']`: A condensed version string, rendered using the selected - style. This is the most commonly used value for the project's version - string. The default "pep440" style yields strings like `0.11`, - `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section - below for alternative styles. - -* `['full-revisionid']`: detailed revision identifier. For Git, this is the - full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". - -* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the - commit date in ISO 8601 format. This will be None if the date is not - available. - -* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that - this is only accurate if run in a VCS checkout, otherwise it is likely to - be False or None - -* `['error']`: if the version string could not be computed, this will be set - to a string describing the problem, otherwise it will be None. It may be - useful to throw an exception in setup.py if this is set, to avoid e.g. - creating tarballs with a version string of "unknown". - -Some variants are more useful than others. Including `full-revisionid` in a -bug report should allow developers to reconstruct the exact code being tested -(or indicate the presence of local changes that should be shared with the -developers). `version` is suitable for display in an "about" box or a CLI -`--version` output: it can be easily compared against release notes and lists -of bugs fixed in various releases. - -The installer adds the following text to your `__init__.py` to place a basic -version in `YOURPROJECT.__version__`: - - from ._version import get_versions - __version__ = get_versions()['version'] - del get_versions - -## Styles - -The setup.cfg `style=` configuration controls how the VCS information is -rendered into a version string. - -The default style, "pep440", produces a PEP440-compliant string, equal to the -un-prefixed tag name for actual releases, and containing an additional "local -version" section with more detail for in-between builds. For Git, this is -TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags ---dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the -tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and -that this commit is two revisions ("+2") beyond the "0.11" tag. For released -software (exactly equal to a known tag), the identifier will only contain the -stripped tag, e.g. "0.11". - -Other styles are available. See [details.md](details.md) in the Versioneer -source tree for descriptions. - -## Debugging - -Versioneer tries to avoid fatal errors: if something goes wrong, it will tend -to return a version of "0+unknown". To investigate the problem, run `setup.py -version`, which will run the version-lookup code in a verbose mode, and will -display the full contents of `get_versions()` (including the `error` string, -which may help identify what went wrong). - -## Known Limitations - -Some situations are known to cause problems for Versioneer. This details the -most significant ones. More can be found on Github -[issues page](https://github.com/warner/python-versioneer/issues). - -### Subprojects - -Versioneer has limited support for source trees in which `setup.py` is not in -the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are -two common reasons why `setup.py` might not be in the root: - -* Source trees which contain multiple subprojects, such as - [Buildbot](https://github.com/buildbot/buildbot), which contains both - "master" and "slave" subprojects, each with their own `setup.py`, - `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI - distributions (and upload multiple independently-installable tarballs). -* Source trees whose main purpose is to contain a C library, but which also - provide bindings to Python (and perhaps other langauges) in subdirectories. - -Versioneer will look for `.git` in parent directories, and most operations -should get the right version string. However `pip` and `setuptools` have bugs -and implementation details which frequently cause `pip install .` from a -subproject directory to fail to find a correct version string (so it usually -defaults to `0+unknown`). - -`pip install --editable .` should work correctly. `setup.py install` might -work too. - -Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in -some later version. - -[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking -this issue. The discussion in -[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the -issue from the Versioneer side in more detail. -[pip PR#3176](https://github.com/pypa/pip/pull/3176) and -[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve -pip to let Versioneer work correctly. - -Versioneer-0.16 and earlier only looked for a `.git` directory next to the -`setup.cfg`, so subprojects were completely unsupported with those releases. - -### Editable installs with setuptools <= 18.5 - -`setup.py develop` and `pip install --editable .` allow you to install a -project into a virtualenv once, then continue editing the source code (and -test) without re-installing after every change. - -"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a -convenient way to specify executable scripts that should be installed along -with the python package. - -These both work as expected when using modern setuptools. When using -setuptools-18.5 or earlier, however, certain operations will cause -`pkg_resources.DistributionNotFound` errors when running the entrypoint -script, which must be resolved by re-installing the package. This happens -when the install happens with one version, then the egg_info data is -regenerated while a different version is checked out. Many setup.py commands -cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into -a different virtualenv), so this can be surprising. - -[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes -this one, but upgrading to a newer version of setuptools should probably -resolve it. - -### Unicode version strings - -While Versioneer works (and is continually tested) with both Python 2 and -Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. -Newer releases probably generate unicode version strings on py2. It's not -clear that this is wrong, but it may be surprising for applications when then -write these strings to a network connection or include them in bytes-oriented -APIs like cryptographic checksums. - -[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates -this question. - - -## Updating Versioneer - -To upgrade your project to a new release of Versioneer, do the following: - -* install the new Versioneer (`pip install -U versioneer` or equivalent) -* edit `setup.cfg`, if necessary, to include any new configuration settings - indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. -* re-run `versioneer install` in your source tree, to replace - `SRC/_version.py` -* commit any changed files - -## Future Directions - -This tool is designed to make it easily extended to other version-control -systems: all VCS-specific components are in separate directories like -src/git/ . The top-level `versioneer.py` script is assembled from these -components by running make-versioneer.py . In the future, make-versioneer.py -will take a VCS name as an argument, and will construct a version of -`versioneer.py` that is specific to the given VCS. It might also take the -configuration arguments that are currently provided manually during -installation by editing setup.py . Alternatively, it might go the other -direction and include code from all supported VCS systems, reducing the -number of intermediate scripts. - - -## License - -To make Versioneer easier to embed, all its code is dedicated to the public -domain. The `_version.py` that it creates is also in the public domain. -Specifically, both are released under the Creative Commons "Public Domain -Dedication" license (CC0-1.0), as described in -https://creativecommons.org/publicdomain/zero/1.0/ . - -""" - -from __future__ import print_function - -try: - import configparser -except ImportError: - import ConfigParser as configparser - -import errno -import json -import os -import re -import subprocess -import sys - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_root(): - """Get the project root directory. - - We require that all commands are run from the project root, i.e. the - directory that contains setup.py, setup.cfg, and versioneer.py . - """ - root = os.path.realpath(os.path.abspath(os.getcwd())) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - # allow 'python path/to/setup.py COMMAND' - root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - err = ("Versioneer was unable to run the project root directory. " - "Versioneer requires setup.py to be executed from " - "its immediate directory (like 'python setup.py COMMAND'), " - "or in a way that lets it use sys.argv[0] to find the root " - "(like 'python path/to/setup.py COMMAND').") - raise VersioneerBadRootError(err) - try: - # Certain runtime workflows (setup.py install/develop in a setuptools - # tree) execute all dependencies in a single python process, so - # "versioneer" may be imported multiple times, and python's shared - # module-import table will cache the first one. So we can't use - # os.path.dirname(__file__), as that will find whichever - # versioneer.py was first imported, even in later projects. - me = os.path.realpath(os.path.abspath(__file__)) - me_dir = os.path.normcase(os.path.splitext(me)[0]) - vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) - if me_dir != vsr_dir: - print("Warning: build in %s is using versioneer.py from %s" - % (os.path.dirname(me), versioneer_py)) - except NameError: - pass - return root - - -def get_config_from_root(root): - """Read the project setup.cfg file to determine Versioneer config.""" - # This might raise EnvironmentError (if setup.cfg is missing), or - # configparser.NoSectionError (if it lacks a [versioneer] section), or - # configparser.NoOptionError (if it lacks "VCS="). See the docstring at - # the top of versioneer.py for instructions on writing your setup.cfg . - setup_cfg = os.path.join(root, "setup.cfg") - parser = configparser.ConfigParser() - parser.read(setup_cfg) - VCS = parser.get("versioneer", "VCS") # mandatory - - def get(parser, name): - if parser.has_option("versioneer", name): - return parser.get("versioneer", name) - return None - cfg = VersioneerConfig() - cfg.VCS = VCS - cfg.style = get(parser, "style") or "" - cfg.versionfile_source = get(parser, "versionfile_source") - cfg.versionfile_build = get(parser, "versionfile_build") - cfg.tag_prefix = get(parser, "tag_prefix") - if cfg.tag_prefix in ("''", '""'): - cfg.tag_prefix = "" - cfg.parentdir_prefix = get(parser, "parentdir_prefix") - cfg.verbose = get(parser, "verbose") - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -# these dictionaries contain VCS-specific tools -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -LONG_VERSION_PY['git'] = 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.18 (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" - git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" - git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - return keywords - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "%(STYLE)s" - cfg.tag_prefix = "%(TAG_PREFIX)s" - cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" - cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %%s" %% dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %%s" %% (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %%s (error)" %% dispcmd) - print("stdout was %%s" %% stdout) - return None, p.returncode - return stdout, p.returncode - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %%s but none started with prefix %%s" %% - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %%d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%%s', no digits" %% ",".join(refs - tags)) - if verbose: - print("likely tags: %%s" %% ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %%s" %% r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %%s not under git control" %% root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%%s*" %% tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%%s'" - %% describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%%s' doesn't start with prefix '%%s'" - print(fmt %% (full_tag, tag_prefix)) - pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" - %% (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%%d" %% pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%%d" %% pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%%s" %% pieces["short"] - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%%s" %% pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%%s'" %% style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree", - "date": None} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version", "date": None} -''' - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(refs - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def do_vcs_install(manifest_in, versionfile_source, ipy): - """Git-specific installation logic for Versioneer. - - For Git, this means creating/changing .gitattributes to mark _version.py - for export-subst keyword substitution. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - files = [manifest_in, versionfile_source] - if ipy: - files.append(ipy) - try: - me = __file__ - if me.endswith(".pyc") or me.endswith(".pyo"): - me = os.path.splitext(me)[0] + ".py" - versioneer_file = os.path.relpath(me) - except NameError: - versioneer_file = "versioneer.py" - files.append(versioneer_file) - present = False - try: - f = open(".gitattributes", "r") - for line in f.readlines(): - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - f.close() - except EnvironmentError: - pass - if not present: - f = open(".gitattributes", "a+") - f.write("%s export-subst\n" % versionfile_source) - f.close() - files.append(".gitattributes") - run_command(GITS, ["add", "--"] + files) - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.18) from -# revision-control system data, or from the parent directory name of an -# unpacked source archive. Distribution tarballs contain a pre-generated copy -# of this file. - -import json - -version_json = ''' -%s -''' # END VERSION_JSON - - -def get_versions(): - return json.loads(version_json) -""" - - -def versions_from_file(filename): - """Try to determine the version from _version.py if present.""" - try: - with open(filename) as f: - contents = f.read() - except EnvironmentError: - raise NotThisMethod("unable to read _version.py") - mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", - contents, re.M | re.S) - if not mo: - mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", - contents, re.M | re.S) - if not mo: - raise NotThisMethod("no version_json in _version.py") - return json.loads(mo.group(1)) - - -def write_to_version_file(filename, versions): - """Write the given version number to the given _version.py file.""" - os.unlink(filename) - contents = json.dumps(versions, sort_keys=True, - indent=1, separators=(",", ": ")) - with open(filename, "w") as f: - f.write(SHORT_VERSION_PY % contents) - - print("set %s to '%s'" % (filename, versions["version"])) - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -class VersioneerBadRootError(Exception): - """The project root directory is unknown or missing key files.""" - - -def get_versions(verbose=False): - """Get the project version from whatever source is available. - - Returns dict with two keys: 'version' and 'full'. - """ - if "versioneer" in sys.modules: - # see the discussion in cmdclass.py:get_cmdclass() - del sys.modules["versioneer"] - - root = get_root() - cfg = get_config_from_root(root) - - assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" - handlers = HANDLERS.get(cfg.VCS) - assert handlers, "unrecognized VCS '%s'" % cfg.VCS - verbose = verbose or cfg.verbose - assert cfg.versionfile_source is not None, \ - "please set versioneer.versionfile_source" - assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" - - versionfile_abs = os.path.join(root, cfg.versionfile_source) - - # extract version from first of: _version.py, VCS command (e.g. 'git - # describe'), parentdir. This is meant to work for developers using a - # source checkout, for users of a tarball created by 'setup.py sdist', - # and for users of a tarball/zipball created by 'git archive' or github's - # download-from-tag feature or the equivalent in other VCSes. - - get_keywords_f = handlers.get("get_keywords") - from_keywords_f = handlers.get("keywords") - if get_keywords_f and from_keywords_f: - try: - keywords = get_keywords_f(versionfile_abs) - ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) - if verbose: - print("got version from expanded keyword %s" % ver) - return ver - except NotThisMethod: - pass - - try: - ver = versions_from_file(versionfile_abs) - if verbose: - print("got version from file %s %s" % (versionfile_abs, ver)) - return ver - except NotThisMethod: - pass - - from_vcs_f = handlers.get("pieces_from_vcs") - if from_vcs_f: - try: - pieces = from_vcs_f(cfg.tag_prefix, root, verbose) - ver = render(pieces, cfg.style) - if verbose: - print("got version from VCS %s" % ver) - return ver - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - if verbose: - print("got version from parentdir %s" % ver) - return ver - except NotThisMethod: - pass - - if verbose: - print("unable to compute version") - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, "error": "unable to compute version", - "date": None} - - -def get_version(): - """Get the short version string for this project.""" - return get_versions()["version"] - - -def get_cmdclass(): - """Get the custom setuptools/distutils subclasses used by Versioneer.""" - if "versioneer" in sys.modules: - del sys.modules["versioneer"] - # this fixes the "python setup.py develop" case (also 'install' and - # 'easy_install .'), in which subdependencies of the main project are - # built (using setup.py bdist_egg) in the same python process. Assume - # a main project A and a dependency B, which use different versions - # of Versioneer. A's setup.py imports A's Versioneer, leaving it in - # sys.modules by the time B's setup.py is executed, causing B to run - # with the wrong versioneer. Setuptools wraps the sub-dep builds in a - # sandbox that restores sys.modules to it's pre-build state, so the - # parent is protected against the child's "import versioneer". By - # removing ourselves from sys.modules here, before the child build - # happens, we protect the child from the parent's versioneer too. - # Also see https://github.com/warner/python-versioneer/issues/52 - - cmds = {} - - # we add "version" to both distutils and setuptools - from distutils.core import Command - - class cmd_version(Command): - description = "report generated version string" - user_options = [] - boolean_options = [] - - def initialize_options(self): - pass - - def finalize_options(self): - pass - - def run(self): - vers = get_versions(verbose=True) - print("Version: %s" % vers["version"]) - print(" full-revisionid: %s" % vers.get("full-revisionid")) - print(" dirty: %s" % vers.get("dirty")) - print(" date: %s" % vers.get("date")) - if vers["error"]: - print(" error: %s" % vers["error"]) - cmds["version"] = cmd_version - - # we override "build_py" in both distutils and setuptools - # - # most invocation pathways end up running build_py: - # distutils/build -> build_py - # distutils/install -> distutils/build ->.. - # setuptools/bdist_wheel -> distutils/install ->.. - # setuptools/bdist_egg -> distutils/install_lib -> build_py - # setuptools/install -> bdist_egg ->.. - # setuptools/develop -> ? - # pip install: - # copies source tree to a tempdir before running egg_info/etc - # if .git isn't copied too, 'git describe' will fail - # then does setup.py bdist_wheel, or sometimes setup.py install - # setup.py egg_info -> ? - - # we override different "build_py" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.build_py import build_py as _build_py - else: - from distutils.command.build_py import build_py as _build_py - - class cmd_build_py(_build_py): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - _build_py.run(self) - # now locate _version.py in the new build/ directory and replace - # it with an updated value - if cfg.versionfile_build: - target_versionfile = os.path.join(self.build_lib, - cfg.versionfile_build) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - cmds["build_py"] = cmd_build_py - - if "cx_Freeze" in sys.modules: # cx_freeze enabled? - from cx_Freeze.dist import build_exe as _build_exe - - # nczeczulin reports that py2exe won't like the pep440-style string - # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. - # setup(console=[{ - # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION - # "product_version": versioneer.get_version(), - # ... - - class cmd_build_exe(_build_exe): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - target_versionfile = cfg.versionfile_source - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - - _build_exe.run(self) - os.unlink(target_versionfile) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % - {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - cmds["build_exe"] = cmd_build_exe - del cmds["build_py"] - - if 'py2exe' in sys.modules: # py2exe enabled? - try: - from py2exe.distutils_buildexe import py2exe as _py2exe # py3 - except ImportError: - from py2exe.build_exe import py2exe as _py2exe # py2 - - class cmd_py2exe(_py2exe): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - target_versionfile = cfg.versionfile_source - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - - _py2exe.run(self) - os.unlink(target_versionfile) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % - {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - cmds["py2exe"] = cmd_py2exe - - # we override different "sdist" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.sdist import sdist as _sdist - else: - from distutils.command.sdist import sdist as _sdist - - class cmd_sdist(_sdist): - def run(self): - versions = get_versions() - self._versioneer_generated_versions = versions - # unless we update this, the command will keep using the old - # version - self.distribution.metadata.version = versions["version"] - return _sdist.run(self) - - def make_release_tree(self, base_dir, files): - root = get_root() - cfg = get_config_from_root(root) - _sdist.make_release_tree(self, base_dir, files) - # now locate _version.py in the new base_dir directory - # (remembering that it may be a hardlink) and replace it with an - # updated value - target_versionfile = os.path.join(base_dir, cfg.versionfile_source) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, - self._versioneer_generated_versions) - cmds["sdist"] = cmd_sdist - - return cmds - - -CONFIG_ERROR = """ -setup.cfg is missing the necessary Versioneer configuration. You need -a section like: - - [versioneer] - VCS = git - style = pep440 - versionfile_source = src/myproject/_version.py - versionfile_build = myproject/_version.py - tag_prefix = - parentdir_prefix = myproject- - -You will also need to edit your setup.py to use the results: - - import versioneer - setup(version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), ...) - -Please read the docstring in ./versioneer.py for configuration instructions, -edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. -""" - -SAMPLE_CONFIG = """ -# See the docstring in versioneer.py for instructions. Note that you must -# re-run 'versioneer.py setup' after changing this section, and commit the -# resulting files. - -[versioneer] -#VCS = git -#style = pep440 -#versionfile_source = -#versionfile_build = -#tag_prefix = -#parentdir_prefix = - -""" - -INIT_PY_SNIPPET = """ -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions -""" - - -def do_setup(): - """Main VCS-independent setup function for installing Versioneer.""" - root = get_root() - try: - cfg = get_config_from_root(root) - except (EnvironmentError, configparser.NoSectionError, - configparser.NoOptionError) as e: - if isinstance(e, (EnvironmentError, configparser.NoSectionError)): - print("Adding sample versioneer config to setup.cfg", - file=sys.stderr) - with open(os.path.join(root, "setup.cfg"), "a") as f: - f.write(SAMPLE_CONFIG) - print(CONFIG_ERROR, file=sys.stderr) - return 1 - - print(" creating %s" % cfg.versionfile_source) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - - ipy = os.path.join(os.path.dirname(cfg.versionfile_source), - "__init__.py") - if os.path.exists(ipy): - try: - with open(ipy, "r") as f: - old = f.read() - except EnvironmentError: - old = "" - if INIT_PY_SNIPPET not in old: - print(" appending to %s" % ipy) - with open(ipy, "a") as f: - f.write(INIT_PY_SNIPPET) - else: - print(" %s unmodified" % ipy) - else: - print(" %s doesn't exist, ok" % ipy) - ipy = None - - # Make sure both the top-level "versioneer.py" and versionfile_source - # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so - # they'll be copied into source distributions. Pip won't be able to - # install the package without this. - manifest_in = os.path.join(root, "MANIFEST.in") - simple_includes = set() - try: - with open(manifest_in, "r") as f: - for line in f: - if line.startswith("include "): - for include in line.split()[1:]: - simple_includes.add(include) - except EnvironmentError: - pass - # That doesn't cover everything MANIFEST.in can do - # (http://docs.python.org/2/distutils/sourcedist.html#commands), so - # it might give some false negatives. Appending redundant 'include' - # lines is safe, though. - if "versioneer.py" not in simple_includes: - print(" appending 'versioneer.py' to MANIFEST.in") - with open(manifest_in, "a") as f: - f.write("include versioneer.py\n") - else: - print(" 'versioneer.py' already in MANIFEST.in") - if cfg.versionfile_source not in simple_includes: - print(" appending versionfile_source ('%s') to MANIFEST.in" % - cfg.versionfile_source) - with open(manifest_in, "a") as f: - f.write("include %s\n" % cfg.versionfile_source) - else: - print(" versionfile_source already in MANIFEST.in") - - # Make VCS-specific changes. For git, this means creating/changing - # .gitattributes to mark _version.py for export-subst keyword - # substitution. - do_vcs_install(manifest_in, cfg.versionfile_source, ipy) - return 0 - - -def scan_setup_py(): - """Validate the contents of setup.py against Versioneer's expectations.""" - found = set() - setters = False - errors = 0 - with open("setup.py", "r") as f: - for line in f.readlines(): - if "import versioneer" in line: - found.add("import") - if "versioneer.get_cmdclass()" in line: - found.add("cmdclass") - if "versioneer.get_version()" in line: - found.add("get_version") - if "versioneer.VCS" in line: - setters = True - if "versioneer.versionfile_source" in line: - setters = True - if len(found) != 3: - print("") - print("Your setup.py appears to be missing some important items") - print("(but I might be wrong). Please make sure it has something") - print("roughly like the following:") - print("") - print(" import versioneer") - print(" setup( version=versioneer.get_version(),") - print(" cmdclass=versioneer.get_cmdclass(), ...)") - print("") - errors += 1 - if setters: - print("You should remove lines like 'versioneer.VCS = ' and") - print("'versioneer.versionfile_source = ' . This configuration") - print("now lives in setup.cfg, and should be removed from setup.py") - print("") - errors += 1 - return errors - - -if __name__ == "__main__": - cmd = sys.argv[1] - if cmd == "setup": - errors = do_setup() - errors += scan_setup_py() - if errors: - sys.exit(1)